{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "jobTaskDocument", "type": "object", "title": "The Root Schema", "required": [ "name", "summary", "displayName", "type", "x", "y", "status" ], "definitions": { "variables": { "type": "object", "properties": { "incoming": { "type": "object", "examples": [ { "inputVariable": "inputValue" } ] }, "outgoing": { "type": "object", "examples": [ { "outputVariable": null } ] }, "error": { "type": "string", "pattern": "" }, "decorators": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "encryption" ] }, "pointer": { "type": "string", "examples": [ "/outgoing/output" ] } } } } } } }, "properties": { "name": { "$id": "#/properties/name", "type": "string", "title": "The Name of the task", "examples": [ "TestTask" ] }, "summary": { "$id": "#/properties/summary", "type": "string", "title": "The Summary for the task", "examples": [ "Test Task" ] }, "description": { "$id": "#/properties/description", "type": "string", "title": "The Description of the task", "examples": [ "Test Task" ] }, "app": { "$id": "#/properties/app", "type": "string", "title": "The associated app for this task", "description": "The app this task is a part of", "examples": [ "WorkflowBuilder" ] }, "displayName": { "$id": "#/properties/displayName", "type": "string", "title": "The display name of the app", "description": "The display name of the app associated with this task", "examples": [ "WorkflowBuilder" ] }, "canvasName": { "$id": "#/properties/canvasName", "type": "string", "title": "The canvas name of the app", "description": "The name that appears on the automation builder canvas for this task", "examples": [ "taskName1" ] }, "canvasTab": { "$id": "#/properties/canvasTab", "type": "string", "title": "The canvas tab of the task", "description": "The name of the tab that the task goes under", "examples": [ "taskName1" ] }, "type": { "$id": "#/properties/type", "type": "string", "title": "The task type", "description": "The task type, usually 'automated' or 'manual'", "examples": [ "automated" ] }, "sla": { "$id": "#/properties/sla", "type": "integer", "title": "Task SLA", "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", "examples": [ "3600000" ] }, "view": { "$id": "#/properties/view", "type": "string", "title": "URL to view the running task", "description": "If available, a relative URL to view this task", "examples": [ "/workflow_builder/task/TestTask" ] }, "deprecated": { "$id": "#/properties/deprecated", "type": "boolean", "title": "Deprecation indicator", "description": "If applicable, this will be an indicator on whether or not this is a deprecated task", "examples": [ false ] }, "x": { "$ref": "wfEngineCommon#/definitions/x" }, "y": { "$ref": "wfEngineCommon#/definitions/y" }, "scheduled": { "$id": "#/properties/scheduled", "type": "boolean", "title": "Schedule task indicator", "description": "Indicator on whether or not this is a scheduled task", "examples": [ false ] }, "status": { "$id": "#/properties/status", "type": "string", "enum": [ "complete", "error", "canceled", "active", "incomplete", "running", "primed", "paused" ], "title": "The status", "description": "The status of the task (running, error, incomplete, etc)", "examples": [ "complete" ] }, "metrics": { "$ref": "metricsDefault" }, "iterations": { "$id": "#/properties/iterations", "type": "array", "title": "The Task Iterations ", "description": "", "items": { "$ref": "wfEngineCommon#/definitions/mongoObjectId" } }, "variables": { "$ref": "#/definitions/variables" }, "childJobs": { "$id": "#/properties/childJobs", "type": "array", "title": "Task child job references", "description": "Child jobs that are started by the task", "items": { "type": "object", "properties": { "_id": { "$ref": "wfEngineCommon#/definitions/mongoObjectId" }, "name": { "$id": "#/properties/childJobs/properties/name", "type": "string", "title": "The name of the child job reference", "examples": [ "ChildJobRef" ] }, "iteration": { "$id": "#/properties/childJobs/properties/iteration", "type": "number", "title": "The iteration of the child job reference", "examples": [ 1 ] } } } }, "retrySettings": { "$ref": "wfEngineCommon#/definitions/retrySettings" } } }
2023.1