app-workflow_engine Schemas

On this page:

taskDocument

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "taskDocument", "type": "object", "title": "The Root Schema", "required": [ "_id", "name", "summary", "displayName", "type", "x", "y", "status", "job", "iterations" ], "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": { "_id": { "$ref": "wfEngineCommon#/definitions/mongoObjectId" }, "job": { "type": "object", "title": "The Job associated with this task", "required": [ "_id", "name", "description", "task", "index" ], "properties": { "_id": { "$ref": "wfEngineCommon#/definitions/mongoObjectId" }, "task": { "$ref": "wfEngineCommon#/definitions/workflowTaskId" }, "ancestors": { "type": "array", "items": { "$ref": "wfEngineCommon#/definitions/mongoObjectId" } } } }, "variables": { "$ref": "#/definitions/variables" }, "metrics": { "type": "object", "title": "Task runtime metrics", "properties": { "retrying": { "type": "boolean", "description": "Whether a task is ready to be retried manually" } } } } }