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": "enim", "options": { "description": "Example job description", "type": "automation", "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ] } }
{ "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": "5cb7b531d06cceb89fd21b1c", "font_size": -8470730, "type": "automation", "created": "2019-04-16T00:43:22.038Z", "created_by": "Pronghorn", "last_updated": "2019-04-16T00:43:22.038Z", "last_updated_by": "Pronghorn", "lastUpdatedVersion": "9373.6.08941155", "canvasVersion": 1, "name": "culpa", "description": null, "preAutomationTime": 80924093.19625705, "sla": -87334824.99634042, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/v4EPGYlo/ADCcq6huV5/~1/~1/~0/sL+yW4ySx/r+CcJB+v" } ], "transitions": { "workflow_start": { "workflow_start": { "state": "error", "type": "loop" }, "workflow_end": { "state": "failure", "type": "revert" }, "error_handler": { "state": "error", "type": "standard" } }, "workflow_end": { "workflow_start": { "state": "failure", "type": "loop" }, "workflow_end": { "state": "error", "type": "standard" }, "error_handler": { "state": "error", "type": "loop" } }, "error_handler": { "workflow_start": { "state": "failure", "type": "revert" }, "workflow_end": { "state": "success", "type": "loop" }, "error_handler": { "state": "error", "type": "revert" } } }, "status": "complete", "error": [ { "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": "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": "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": "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 } ], "ancestors": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "tasks": { "89": { "actor": "$var.job.WHvl", "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79" ], "x": 3837007.8971829563, "y": 37512049.050822824, "gridCoordinate": { "x": -89907149.7441716, "y": 59812533.52011916 }, "name": "id", "location": "Application", "locationType": "qui", "app": "ut", "canvasName": "proident cupidatat", "displayName": "dolore", "summary": "sed", "description": "incididunt ea", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/iccomQfC/JOIoqror/~1/Aaz/~1" }, { "type": "encryption", "pointer": "/~1/VnKL5MuzkwN" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "nostrud in sint ea Duis", "highlightString": "sunt labore" }, { "key": "ut laboris dolore aliquip", "highlightString": "velit quis elit voluptate enim" }, { "key": "dolore", "highlightString": "sit non in sint" }, { "key": "minim", "highlightString": "Duis reprehenderit" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler", "workflow_end" ], "complete": [ "error_handler", "3a1f", "error_handler", "3a1f" ], "error": [ "e28f" ] }, "taskId": "3a1f", "transitions": { "success": { "task": "e28f", "type": "standard" }, "failure": { "task": "workflow_end", "type": "loop" }, "error": { "task": "3a1f", "type": "loop" } }, "serverId": "aliqua quis esse proident qui", "start_time": "2019-04-16T00:43:22.038Z", "end_time": -81286928.59453137, "finish_state": "failure", "retrySettings": { "state": [ "error", "error", "failure", "error", "error" ], "autoRetry": true, "limit": 90195755, "delay": 87937457, "count": 73364267 }, "type": "automatic" }, "workflow_start": { "x": -19691901.7654773, "y": 67577113.42668596, "gridCoordinate": { "x": -17889900.767301276, "y": -94195861.35782869 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -7937791.968707904, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "actor": "$var.62de.x", "location": "Broker", "locationType": null, "app": "do pariatur Duis adipisicing", "canvasName": "pariatur laboris nisi magna consequat", "displayName": "ut sint dolore Lorem ipsum", "description": "ea ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/tSTvYAFF4/RLVZH/lq+,sW/~1/~0/~1/Wuj7jD/rqH7X.H" }, { "type": "encryption", "pointer": "/QXuZR.EJ/IHRYnlt9eD" }, { "type": "encryption", "pointer": "/~1/~0/~1/~0" }, { "type": "encryption", "pointer": "/XRmond" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "culpa velit eiusmod", "highlightString": "dolor occaecat et Ut" }, { "key": "Duis aute minim dolore", "highlightString": "ad in commodo sint anim" }, { "key": "do", "highlightString": "Duis dolore minim" }, { "key": "commodo qui amet cillum proident", "highlightString": "reprehenderit nulla" } ], "status": "incomplete", "previous": { "incomplete": [ "3a1f" ], "complete": [ "3a1f" ], "error": [ "workflow_start" ] }, "transitions": { "success": { "task": "workflow_start", "type": "revert" }, "failure": { "task": "error_handler", "type": "revert" }, "error": { "task": "error_handler", "type": "loop" } }, "serverId": "cillum eu", "start_time": "2019-04-16T00:43:22.038Z", "end_time": -66872102.63334298, "finish_state": "success", "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 15496899, "delay": 154044, "count": 69901420 }, "type": "automatic" }, "workflow_end": { "x": 71339898.3993307, "y": -16071506.361264065, "gridCoordinate": { "x": -83604715.15185295, "y": -50094928.46491708 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler", "error_handler" ], "complete": [ "e28f", "workflow_start", "error_handler", "error_handler", "3a1f" ], "error": [ "workflow_start", "workflow_end", "workflow_end", "e28f" ] }, "metrics": { "end_time": -74417286.11747052, "run_time": 49675802.085846156 }, "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "actor": "$var.job.9Zz", "location": "Adapter", "locationType": null, "app": "voluptate do fugiat", "canvasName": "labore cillum qui laboris", "displayName": "labore nulla fugiat quis", "description": "irure do", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/aZNlw/~0/y2FQ/~0/KLYVxjMu/O/~0" }, { "type": "encryption", "pointer": "/vq8WcY/fsQxi+/kvxq" }, { "type": "encryption", "pointer": "/~0/~0/~0/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "enim", "highlightString": "eiusmod esse officia consectetur" } ], "status": "running", "previous": { "incomplete": [ "e28f", "3a1f", "workflow_start" ], "complete": [ "e28f", "3a1f", "3a1f", "3a1f", "3a1f" ], "error": [ "workflow_end", "3a1f" ] }, "transitions": { "success": { "task": "e28f", "type": "standard" }, "failure": { "task": "e28f", "type": "loop" }, "error": { "task": "e28f", "type": "standard" } }, "serverId": "mollit dolor labore ut", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 21772177.856980562, "finish_state": "error", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 74025805, "delay": 46536269, "count": 88026904 }, "type": "automatic" }, "error_handler": null }, "errorHandler": null, "groups": [ "4321abcdef694aa79dae47ad" ], "watchers": [ "Pronghorn" ], "metrics": { "start_time": 22003632.41314216, "progress": 0.4043355979181198, "end_time": -52633230.21594797, "user": "Pronghorn", "owner": "5cb7b531d06cceb89fd21b1c" } }
{ "$ref": "job-db" }