taskDocument

Copied to Clipboard

{ "$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": { "taskId": { "type": "string", "title": "The _id of the task document", "examples": [ "8085260c-d951-4e5f-9d52-06d911a4eb38" ], "pattern": "^(.*)$" }, "variables": { "type": "object", "properties": { "incoming": { "type": "object", "examples": [ { "inputVariable": "inputValue" } ] }, "outgoing": { "type": "object", "examples": [ { "outputVariable": "outputValue" } ] }, "translations": { "type": "object", "examples": [ { "translationVariable": "translationValue" } ] }, "error": { "type": "string", "pattern": "" } } } }, "properties": { "_id": { "$id": "#/properties/_id", "type": "string", "title": "The _id of the task document", "examples": [ "8085260c-d951-4e5f-9d52-06d911a4eb38" ], "pattern": "^(.*)$" }, "name": { "$id": "#/properties/name", "type": "string", "title": "The Name of the task", "examples": [ "TestTask" ], "pattern": "^(.*)$" }, "summary": { "$id": "#/properties/summary", "type": "string", "title": "The Summary for the task", "examples": [ "Test Task" ], "pattern": "^(.*)$" }, "description": { "$id": "#/properties/description", "type": "string", "title": "The Description of the task", "examples": [ "Test Task" ], "pattern": "^(.*)$" }, "app": { "$id": "#/properties/app", "type": "string", "title": "The associated app for this task", "description": "The app this task is a part of", "examples": [ "WorkflowBuilder" ], "pattern": "^(.*)$" }, "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" ], "pattern": "^(.*)$" }, "type": { "$id": "#/properties/type", "type": "string", "title": "The task type", "description": "The task type, usually 'automated' or 'manual'", "examples": [ "automated" ], "pattern": "^(.*)$" }, "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" ], "pattern": "^(.*)$" }, "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": { "$id": "#/properties/x", "type": "number", "title": "The X position on the workflow", "description": "The x coordinate position of this task on the workflow", "examples": [ 0.36142061281337046 ] }, "y": { "$id": "#/properties/y", "type": "number", "title": "The Y position on the workflow", "description": "The x coordinate position of this task on the workflow", "examples": [ 0.502092050209205 ] }, "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", "error", "canceled", "active", "incomplete", "running", "primed", "paused" ], "pattern": "^(.*)$" }, "metrics": { "$id": "#/properties/metrics", "type": "object", "title": "The task metrics ", "description": "Metrics on the state of the task", "required": [], "properties": { "owner": { "$id": "#/properties/metrics/properties/owner", "type": [ "object", "string" ], "title": "The owner of the task" }, "start_time": { "$id": "#/properties/metrics/properties/start_time", "type": "number", "title": "Task start time", "description": "When the task started, in milliseconds since the UNIX epoh", "examples": [ 1555430149763 ], "pattern": "^(.*)$" }, "end_time": { "$id": "#/properties/metrics/properties/end_time", "type": "number", "title": "Task end time", "description": "When the task ended, in milliseconds since the UNIX epoh", "examples": [ 1555430169683 ], "pattern": "^(.*)$" }, "run_time": { "$id": "#/properties/metrics/properties/run_time", "type": "number", "title": "Task run time", "description": "How long, in milliseconds, the task took to run", "examples": [ 75069184 ], "pattern": "^(.*)$" }, "finish_state": { "$id": "#/properties/metrics/properties/finish_state", "type": "string", "title": "The end state for the task", "description": "What the status of the task was when it finished (error, completed, etc)", "examples": [ "complete", "error", "canceled", "incomplete" ], "pattern": "^(.*)$" }, "server_id": { "$id": "#/properties/metrics/properties/server_id", "type": "string", "title": "The id of the server the task ran on ", "description": "Identified the specific server the task ran/is running on", "examples": [ "ac:de:48:00:11:22:3000" ], "pattern": "^(.*)$" }, "app": { "$id": "#/properties/metrics/properties/app", "type": "object", "title": "The application tied to the task", "description": "Details on the application that's tied to the task", "required": [ "id" ], "properties": { "id": { "$id": "#/properties/metrics/properties/app/properties/id", "type": "string", "title": "Id of the app", "examples": [ "WorkFlowEngine" ] }, "version": { "$id": "#/properties/metrics/properties/app/properties/version", "type": "string", "title": "Version of the app", "examples": [ "1.2.3" ] } } } } }, "job": { "$id": "#/properties/job", "type": "object", "title": "The Job associated with this task", "required": [ "_id", "name", "description", "task", "index" ], "properties": { "_id": { "$id": "#/properties/job/properties/_id", "type": "string", "title": "Job Identifier", "description": "Unique ID of the job that kicked off this task", "examples": [ "f80f8dc8b5a04a72bd8dad6c" ], "pattern": "^(.*)$" }, "name": { "$id": "#/properties/job/properties/name", "type": "string", "title": "The Job Name", "description": "The Name of the Job that kicked off this task", "examples": [ "SomeJobName" ], "pattern": "^(.*)$" }, "description": { "$id": "#/properties/job/properties/description", "type": "string", "title": "Job Description", "description": "Description of the Job", "examples": [ "This Job is for doing XYZ when ABC occurs" ], "pattern": "^(.*)$" }, "task": { "$id": "#/properties/job/properties/task", "type": "string", "title": "The Task name", "description": "The task identifier as it appears in the Job", "examples": [ "4a89" ], "pattern": "^(.*)$" }, "index": { "$id": "#/properties/job/properties/index", "type": "integer", "title": "The Task Index ", "description": "Refers to which task index this particular task is at in the Job. Eg. If there are 3 tasks in Job X and this is the 3rd, this index would be 2 ", "examples": [ 0, 1, 2 ] } } }, "iterations": { "$id": "#/properties/iterations", "type": "array", "title": "The Task Iterations ", "description": "", "items": { "$id": "#/properties/iterations/items", "type": "string", "title": "List of task iterations", "examples": [ "8085260c-d951-4e5f-9d52-06d911a4eb38" ], "pattern": "^(.*)$" } }, "locked": { "$id": "#/properties/locked", "type": "boolean", "title": "Task Lock indicator", "description": "Indicator on whether this task is locked or not", "examples": [ false ] }, "variables": { "$ref": "#/definitions/variables" } } }