Summary
Initiates a job from a workflow.
Description
Initiates a job from a workflow.
Route
POST /operations-manager/jobs/start
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
workflow | string | yes | Name of the workflow from which to start the job. |
options | object | yes | Options for the job. |
{ "workflow": "ea", "options": { "description": "Example job description", "type": "automation", "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ] } }
{ "type": "object", "properties": { "workflow": { "type": "string", "title": "workflow" }, "options": { "type": "object", "description": "Options for the job.", "properties": { "description": { "type": "string", "description": "The description for the job to be started.", "examples": [ "Example job description" ] }, "type": { "type": "string", "examples": [ "automation" ] }, "variables": { "type": "object", "description": "Variables provided to the new job", "additionalProperties": true }, "groups": { "type": "array", "description": "Groups available for job.", "items": { "$ref": "common-ops-schema#/definitions/ObjectId" } } } } }, "required": [ "workflow", "options" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
job | object | Resulting job document |
{ "_id": "4321abcdef694aa79dae47ad", "font_size": -46206772, "type": "automation", "created": "2019-04-16T00:43:22.038Z", "created_by": "5cb7b531d06cceb89fd21b1c", "last_updated": "2019-04-16T00:43:22.038Z", "last_updated_by": "Pronghorn", "lastUpdatedVersion": "46.3239441.75548181", "canvasVersion": 1, "name": "ipsum velit minim", "description": "mollit ullamco magna deserunt", "preAutomationTime": -15134542.357779115, "sla": -71498458.63730073, "decorators": [ { "type": "encryption", "pointer": "/~1/oj" }, { "type": "encryption", "pointer": "/~0/~1/~1/JG0/x/sAh0/wU5,8/~1/~1/~1/hO03d+UHw+/" } ], "transitions": { "workflow_start": { "workflow_start": { "state": "failure", "type": "standard" }, "workflow_end": { "state": "failure", "type": "revert" }, "error_handler": { "state": "success", "type": "standard" } }, "workflow_end": { "workflow_start": { "state": "failure", "type": "standard" }, "workflow_end": { "state": "error", "type": "loop" }, "error_handler": { "state": "success", "type": "revert" } }, "error_handler": { "workflow_start": { "state": "error", "type": "loop" }, "workflow_end": { "state": "failure", "type": "standard" }, "error_handler": { "state": "success", "type": "loop" } } }, "status": "error", "error": [ { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 }, { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [] } } }, "timestamp": 1627323002561 }, { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 }, { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 } ], "ancestors": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "tasks": { "workflow_start": { "x": -5900479.934185162, "y": 89909967.87028095, "gridCoordinate": { "x": 16171188.901038572, "y": 20460203.53913875 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -80355738.79782976, "finish_state": "error", "user": "Pronghorn" }, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "Pronghorn", "location": "Application", "locationType": null, "app": "et quis", "canvasName": "in qui", "displayName": "reprehenderit Ut", "description": "velit laboris", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/lXW8DsiJ/xlAR.DZe/hvVJk/,iSm/m8/EKCvLT,S/~1" }, { "type": "encryption", "pointer": "/~1/LCmWiKa3XR/p/~1/EE/~0/~1/~1/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "consectetur eiusmod veniam ut quis", "highlightString": "cupidatat adipisicing aute" }, { "key": "quis reprehenderit ea labore laborum", "highlightString": "fugiat" } ], "status": "error", "previous": { "incomplete": [ "workflow_end" ], "complete": [ "e28f", "workflow_start", "workflow_start" ], "error": [ "workflow_start", "error_handler" ] }, "transitions": { "success": { "task": "e28f", "type": "standard" }, "failure": { "task": "workflow_end", "type": "revert" }, "error": { "task": "e28f", "type": "standard" } }, "serverId": "Ut", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 1349212.2348171026, "finish_state": "error", "retrySettings": { "state": [ "error", "failure", "failure", "success", "failure" ], "autoRetry": false, "limit": 84952730, "delay": 57655997, "count": 16062133 }, "type": "automatic" }, "workflow_end": { "x": 48908327.58546275, "y": -76393946.26079258, "gridCoordinate": { "x": 67711262.94155288, "y": 23438982.196767494 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "3a1f", "3a1f", "3a1f", "3a1f" ], "complete": [ "e28f", "e28f" ], "error": [ "workflow_start", "workflow_start", "error_handler", "error_handler", "e28f" ] }, "metrics": { "end_time": -23673820.237948373, "run_time": -71605950.82405758 }, "groups": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "$var.job.HVCCE", "location": "Broker", "locationType": "in in dolor dolore", "app": "in cupidatat pariatur", "canvasName": "sed aliqua do", "displayName": "ea veniam Excepteur sunt dolore", "description": "ut dolor do", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/wl,J/n/QKJ/~0/~1" }, { "type": "encryption", "pointer": "/~0/Nof+2/bqsQ6f1,L/zHQjcF16/aQpdqr" }, { "type": "encryption", "pointer": "/~0/~0/unAxEQ/~1/pShgx/~0" }, { "type": "encryption", "pointer": "/~0/~0/~0/~1/e8HeM/UlkRxgc80/bW0B.1Yc/hbsVD1/~0" }, { "type": "encryption", "pointer": "/gk,cyB" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "anim laboris", "highlightString": "Ut sint veniam deserunt" } ], "status": "failure", "previous": { "incomplete": [ "e28f", "3a1f", "workflow_start" ], "complete": [ "workflow_start", "e28f", "e28f", "workflow_end", "error_handler" ], "error": [ "workflow_start", "error_handler" ] }, "transitions": { "success": { "task": "workflow_start", "type": "standard" }, "failure": { "task": "error_handler", "type": "loop" }, "error": { "task": "e28f", "type": "standard" } }, "serverId": "commodo", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 34004485.48658632, "finish_state": "failure", "retrySettings": { "state": [ "error", "error", "failure", "error" ], "autoRetry": false, "limit": 8045347, "delay": 3503578, "count": 33988832 }, "type": "automatic" }, "error_handler": null, "0b3": { "actor": "$var.job.7A", "groups": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79" ], "x": -45727409.85631101, "y": -87433952.26271056, "gridCoordinate": { "x": -56288351.99018374, "y": 69832985.48655602 }, "name": "dolor minim dolor", "location": "Application", "locationType": null, "app": "dolore reprehenderit ullamco", "canvasName": "minim fugiat occaecat dolore ullamco", "displayName": "aliqua consequat consectetur eiusmod", "summary": "ad dolor do", "description": "ex non", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/UQkA/rMV" }, { "type": "encryption", "pointer": "/~1/FcdGbIms0/l5Auq4/~1/~0/k/hlndftZ" }, { "type": "encryption", "pointer": "/~1/c0LX/rB4wTRD/sxENa3G4Rd/~1/~1/~1/su,6R/~1" }, { "type": "encryption", "pointer": "/LL0b/n3kf,YS./~1/dNSjZqPuXb/zrIaskVA/Q7U/NSUG" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "commodo officia Ut", "highlightString": "incididunt dolore esse" } ], "status": "error", "previous": { "incomplete": [ "workflow_end", "e28f", "e28f", "e28f" ], "complete": [ "e28f", "workflow_start", "e28f", "workflow_end" ], "error": [ "e28f", "3a1f", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": { "task": "workflow_end", "type": "revert" }, "failure": { "task": "workflow_end", "type": "standard" }, "error": { "task": "workflow_start", "type": "loop" } }, "serverId": "laboris officia Ut sint et", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 76186334.67052156, "finish_state": "error", "retrySettings": { "state": [ "failure", "success", "failure", "failure" ], "autoRetry": false, "limit": 90764865, "delay": 4734755, "count": 19522178 }, "type": "automatic" } }, "errorHandler": null, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "watchers": [ "Pronghorn", "Pronghorn", "Pronghorn", "5cb7b531d06cceb89fd21b1c", "Pronghorn" ], "metrics": { "start_time": -88339308.77964811, "progress": 0.273466677189532, "end_time": 3620605.454272628, "user": "4321abcdef694aa79dae47ad", "owner": "Pronghorn" } }
{ "$ref": "job-db" }