{ "$schema": "http://json-schema.org/draft-07/schema", "$id": "job-api", "title": "Job Document", "description": "A Job document in API response format.", "$comment": "No required fields, because projection operators can result in any combination of fields", "required": [], "propertyNames": { "anyOf": [ { "$ref": "job-common#/definitions/commonFieldNames" }, { "enum": [ "created_by", "last_updated_by", "tasks", "parent", "errorHandler", "groups", "watchers", "metrics", "output", "outputData", "errors", "warnings" ] } ] }, "allOf": [ { "$ref": "job-common#/definitions/commonFields" }, { "type": "object", "properties": { "created_by": { "$ref": "#/definitions/accountApi" }, "last_updated_by": { "$ref": "#/definitions/accountApi" }, "tasks": { "type": "object", "properties": { "workflow_start": { "$ref": "#/definitions/startTaskApi" }, "workflow_end": { "$ref": "#/definitions/endTaskApi" }, "error_handler": { "$ref": "#/definitions/errorHandlerTaskApi" } }, "patternProperties": { "^[0-9a-f]{1,4}$": { "$ref": "#/definitions/anyTaskApi" } } }, "parent": { "type": "object", "properties": { "job": { "oneOf": [ { "type": "string" }, { "type": "object", "description": "A single job-api object without a parent.job of type object" } ] }, "task": { "type": "string" }, "iteration": { "type": "number" }, "element": { "type": "number" } } }, "errorHandler": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/anyTaskApi" } ] }, "groups": { "type": "array", "items": { "$ref": "#/definitions/groupApi" } }, "watchers": { "type": "array", "items": { "$ref": "#/definitions/accountApi" } }, "metrics": { "allOf": [ { "$ref": "job-common#/definitions/metricsCommon" }, { "type": "object", "properties": { "user": { "$ref": "#/definitions/accountApi" }, "owner": { "$ref": "#/definitions/accountApi" } } } ] }, "output": { "type": "object" }, "outputData": { "type": "object" } } } ], "definitions": { "groupApi": { "oneOf": [ { "$ref": "common#/definitions/ObjectIdLikeString" }, { "$ref": "common#/definitions/groupDocument" }, { "const": "default" } ] }, "accountApi": { "oneOf": [ { "const": "Pronghorn" }, { "$ref": "common#/definitions/ObjectIdLikeString" }, { "$ref": "common#/definitions/accountObject" }, { "type": "null" } ] }, "startTaskApi": { "allOf": [ { "$ref": "job-common#/definitions/startTaskCommon" }, { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/definitions/groupApi" } }, "metrics": { "type": "object", "properties": { "user": { "$ref": "#/definitions/accountApi" } } }, "iterations": { "type": "array", "items": { "oneOf": [ { "$ref": "common#/definitions/uuid-v4" }, { "$ref": "#/definitions/task-api" } ] } } } } ] }, "endTaskApi": { "allOf": [ { "$ref": "job-common#/definitions/endTaskCommon" }, { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/definitions/groupApi" } }, "iterations": { "type": "array", "items": { "oneOf": [ { "$ref": "common#/definitions/uuid-v4" }, { "$ref": "#/definitions/task-api" } ] } } } } ] }, "errorHandlerTaskApi": { "allOf": [ { "$ref": "job-common#/definitions/errorHandlerTaskCommon" }, { "type": "object", "properties": { "actor": { "oneOf": [ { "$ref": "#/definitions/accountApi" }, { "const": "job" } ] }, "groups": { "type": "array", "items": { "$ref": "#/definitions/groupApi" } }, "iterations": { "type": "array", "items": { "oneOf": [ { "$ref": "common#/definitions/uuid-v4" }, { "$ref": "#/definitions/task-api" } ] } } } } ] }, "anyTaskApi": { "allOf": [ { "$ref": "job-common#/definitions/anyTaskCommon" }, { "type": "object", "properties": { "actor": { "oneOf": [ { "$ref": "#/definitions/accountApi" }, { "const": "job" } ] }, "groups": { "type": "array", "items": { "$ref": "#/definitions/groupApi" } }, "iterations": { "type": "array", "items": { "oneOf": [ { "$ref": "common#/definitions/uuid-v4" }, { "$ref": "#/definitions/task-api" } ] } } } } ] }, "task-api": { "type": "object" } } }
2023.2 (latest)