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": "velit culpa dolore", "options": { "description": "Example job description", "type": "automation", "groups": [ "4321abcdef694aa79dae47ad", "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": 43568911, "type": "automation", "created": "2019-04-16T00:43:22.038Z", "created_by": "4321abcdef694aa79dae47ad", "last_updated": "2019-04-16T00:43:22.038Z", "last_updated_by": "Pronghorn", "lastUpdatedVersion": "27007.25.6514493", "canvasVersion": 2, "name": "dolore ut occaecat", "description": null, "preAutomationTime": 61343854.21490443, "sla": 30428303.72566749, "decorators": [ { "type": "encryption", "pointer": "/~0/q2,DBIug/~1/hXF9Y./v68jsd/~0/~0/vbscA/d/~0" }, { "type": "encryption", "pointer": "/yBg/I/~1" }, { "type": "encryption", "pointer": "/T/nq/~0/~0/~0/~0" } ], "transitions": { "workflow_start": { "workflow_start": { "state": "success", "type": "standard" }, "workflow_end": { "state": "failure", "type": "loop" }, "error_handler": { "state": "error", "type": "standard" } }, "workflow_end": { "workflow_start": { "state": "success", "type": "revert" }, "workflow_end": { "state": "failure", "type": "revert" }, "error_handler": { "state": "failure", "type": "revert" } }, "error_handler": { "workflow_start": { "state": "failure", "type": "revert" }, "workflow_end": { "state": "success", "type": "standard" }, "error_handler": { "state": "failure", "type": "standard" } } }, "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": "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 }, { "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 } ], "ancestors": [ "5cb7b531d06cceb89fd21b1c" ], "tasks": { "workflow_start": { "x": 17486062.764279127, "y": -35714655.197140925, "gridCoordinate": { "x": 32875795.063263074, "y": 58844277.556524634 }, "name": "pending", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 89639655.93861443, "finish_state": "failure", "user": "5cb7b531d06cceb89fd21b1c" }, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "actor": "Pronghorn", "description": "in ipsum voluptate eiusmod Excepteur" }, "workflow_end": { "x": 15171189.694600075, "y": 35235388.746479034, "gridCoordinate": { "x": -33351146.11992824, "y": 96377526.66169065 }, "name": "pending", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_end", "error_handler", "3a1f" ], "complete": [ "error_handler" ], "error": [ "workflow_end", "error_handler" ] }, "metrics": { "end_time": -2484628.596942827, "run_time": 10464531.446821153 }, "groups": [ "4321abcdef694aa79dae47ad" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "actor": "Pronghorn", "description": "deserunt do" }, "error_handler": { "x": 25135745.115226984, "y": 6201286.315657303, "gridCoordinate": { "x": -4868235.143192738, "y": -28651471.187941 }, "name": "childJob", "location": "Application", "locationType": null, "app": "est amet cupidatat quis adipisicing", "canvasName": "cillum elit ea ad", "displayName": "commodo Excepteur", "summary": "ut ex ipsum", "description": "ea velit est", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Y20zuGdi/b/~1/lfd8H/~0/KSH" }, { "type": "encryption", "pointer": "/evk/~1/Q+mh3c15" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "veniam", "highlightString": "voluptate id" }, { "key": "reprehenderit do fugiat nisi nulla", "highlightString": "fugiat culpa dolor veniam anim" }, { "key": "et id", "highlightString": "non elit labore Lorem voluptate" }, { "key": "aliquip", "highlightString": "labore magna anim ex voluptate" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "e28f", "error_handler", "e28f" ], "complete": [ "workflow_start", "workflow_end", "3a1f", "3a1f", "e28f" ], "error": [ "e28f" ] }, "taskId": "3a1f", "transitions": { "success": { "task": "e28f", "type": "loop" }, "failure": { "task": "workflow_end", "type": "revert" }, "error": { "task": "3a1f", "type": "loop" } }, "serverId": "tempor velit", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 74181235.01394728, "finish_state": "failure", "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 67243391, "delay": 36547847, "count": 60873006 }, "type": "operation" }, "e5": { "actor": "Pronghorn", "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79" ], "x": -95261220.50582369, "y": -56857217.02589519, "gridCoordinate": { "x": 94558750.08475113, "y": 92476335.78063223 }, "name": "pending", "summary": "dolore nostrud amet", "description": "laborum aliqua Duis" } }, "errorHandler": { "actor": "4321abcdef694aa79dae47ad", "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79" ], "x": 68683701.47948343, "y": 6482271.698220596, "gridCoordinate": { "x": 32397763.475170255, "y": 40296851.29819161 }, "name": "pending", "summary": "id dolor", "description": "esse Duis non fugiat" }, "groups": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "watchers": [ "Pronghorn" ], "metrics": { "start_time": -34047980.075341046, "progress": 0.31834236635191604, "end_time": -68198568.01815303, "user": "Pronghorn", "owner": "Pronghorn" } }
{ "$ref": "job-db" }