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": "tempor", "options": { "description": "Example job description", "type": "automation", "groups": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "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": 49388913, "type": "automation", "created": "2019-04-16T00:43:22.038Z", "created_by": "5cb7b531d06cceb89fd21b1c", "last_updated": "2019-04-16T00:43:22.038Z", "last_updated_by": "4321abcdef694aa79dae47ad", "lastUpdatedVersion": "851271646.30062.417704517", "canvasVersion": 2, "name": "sed est ut enim qui", "description": "nisi", "preAutomationTime": 55837329.64439356, "sla": -49553611.72642787, "decorators": [ { "type": "encryption", "pointer": "/lbGlV/Mj1b/MA/~0/v/~0/n./~0/~1/p/SR/~1" }, { "type": "encryption", "pointer": "/~1/~0/vis3UEKO" }, { "type": "encryption", "pointer": "/AqtlJ0K" }, { "type": "encryption", "pointer": "/~0/PI1s,oHdMb" }, { "type": "encryption", "pointer": "/aa+b19DUt/OWGinto2e/~1/~1/~1/j/OvETa/~1" } ], "transitions": { "workflow_start": { "workflow_start": { "state": "success", "type": "loop" }, "workflow_end": { "state": "success", "type": "standard" }, "error_handler": { "state": "failure", "type": "standard" } }, "workflow_end": { "workflow_start": { "state": "failure", "type": "loop" }, "workflow_end": { "state": "success", "type": "loop" }, "error_handler": { "state": "error", "type": "revert" } }, "error_handler": { "workflow_start": { "state": "success", "type": "loop" }, "workflow_end": { "state": "error", "type": "loop" }, "error_handler": { "state": "failure", "type": "revert" } } }, "status": "error", "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 } ], "ancestors": [ "5cb7b531d06cceb89fd21b1c" ], "tasks": { "workflow_start": { "x": -52392257.77359047, "y": 71769338.02653375, "gridCoordinate": { "x": -35837781.57364277, "y": -56014082.12294041 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -18631572.83574322, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "4321abcdef694aa79dae47ad", "location": "Application", "locationType": null, "app": "labore", "canvasName": "minim", "displayName": "ut exercitation in sunt proident", "description": "nulla reprehenderit dolore Ut proident", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/k3O5uU/~0/AY/~0/~0/TF/m/~0/l" }, { "type": "encryption", "pointer": "/~1/~1/~1/EFK979iTn4j/~1/~1" }, { "type": "encryption", "pointer": "/~0/~0/l8EoyIIm/MBJwfdaz0/~1/~1" }, { "type": "encryption", "pointer": "/~1/~1/FoBoVlmMzo/toY8-e8/~0/~0/F8z" }, { "type": "encryption", "pointer": "/b3,lmRgGv4/gdmSDG7X+6/~0/hMU5wrYB9,x/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ad", "highlightString": "ea exercitation in ut do" }, { "key": "labore fugiat", "highlightString": "anim in" }, { "key": "do nostrud dolor officia", "highlightString": "eu deserunt" } ], "status": "error", "previous": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "e28f" ], "error": [ "workflow_start", "e28f", "3a1f" ] }, "transitions": { "success": { "task": "3a1f", "type": "loop" }, "failure": { "task": "workflow_start", "type": "revert" }, "error": { "task": "e28f", "type": "loop" } }, "serverId": "incididunt ut eiusmod culpa", "start_time": "2019-04-16T00:43:22.038Z", "end_time": -87869747.96900515, "finish_state": "success", "retrySettings": { "state": [ "error", "success", "error", "success" ], "autoRetry": true, "limit": 12415869, "delay": 64283541, "count": 20643124 }, "loop": { "atLeastOneComplete": false, "finishedCount": 29418545.03325239, "outgoing": [ null, "est aute amet velit ipsum" ] }, "childJobs": { "_id": "non occaecat", "name": "ullamco nisi dolore ut", "iteration": 8916445.143144712 } }, "workflow_end": { "x": 86365009.79856217, "y": 96872201.57833037, "gridCoordinate": { "x": -28331971.62151815, "y": -29353326.363467857 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f" ], "complete": [ "e28f", "e28f", "3a1f", "workflow_start", "workflow_start" ], "error": [ "error_handler", "workflow_start", "e28f" ] }, "metrics": { "end_time": 23664735.20882298, "run_time": 4806399.959851235 }, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "5cb7b531d06cceb89fd21b1c", "location": "Application", "locationType": "eu in officia commodo consequat", "app": "sed Lorem aute irure deserunt", "canvasName": "Ut", "displayName": "deserunt quis sunt dolor laborum", "description": "in quis aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/HneNyx/~1" }, { "type": "encryption", "pointer": "/~1/~1/b+/ElbIHBe6hO/Y1" }, { "type": "encryption", "pointer": "/~1/~1/tQA-NLd6v/~1/Bou/~1/~1" }, { "type": "encryption", "pointer": "/~0/zDcW,BRU+ut" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/row/~1/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "deserunt commodo", "highlightString": "pariatur nulla" }, { "key": "enim reprehenderit anim officia cillum", "highlightString": "qui magna" }, { "key": "voluptate aliqua in", "highlightString": "tempor Lorem voluptate" }, { "key": "nulla in in", "highlightString": "in dolore et" }, { "key": "tempor", "highlightString": "reprehenderit" } ], "status": "running", "previous": { "incomplete": [ "error_handler", "workflow_end", "3a1f" ], "complete": [ "e28f", "workflow_start" ], "error": [ "e28f", "3a1f" ] }, "transitions": { "success": { "task": "e28f", "type": "loop" }, "failure": { "task": "workflow_start", "type": "standard" }, "error": { "task": "3a1f", "type": "revert" } }, "serverId": "enim elit proident sunt ut", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 46879459.197910935, "finish_state": "success", "retrySettings": { "state": [ "error", "error", "success" ], "autoRetry": true, "limit": 10185864, "delay": 36611960, "count": 29333495 }, "loop": { "atLeastOneComplete": true, "finishedCount": -45292953.29978247, "outgoing": [ "Excepteur sint", null, null, "culpa id officia sunt exercitation" ] }, "childJobs": { "_id": "incididunt dolor proident est ut", "name": "commodo", "iteration": -32469099.030758247 } }, "error_handler": null, "b9": { "actor": "Pronghorn", "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "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" ], "x": 39090214.60631749, "y": 25535026.127051637, "gridCoordinate": { "x": -3013383.0050415695, "y": 41323906.55139178 }, "name": "quis", "location": "Application", "locationType": "aliquip reprehenderit proident qui exercitation", "app": "fugiat incididunt in do ad", "canvasName": "fugiat anim aliqua", "displayName": "in commodo ut", "summary": "reprehenderit", "description": "aliquip sint occaecat minim amet", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/xs7DPFnfeL/~1/c8y./~0/~0/KK/fGNiiUwB/~1/~1/~1/BnUo6cc8iR/bfxL0ibOp" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/MTDkg-/Sh/~1/~1/~1/~1/d-To/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0/qODCLvl/lnUN/~1/S7oCB7Q0c/A4ZM,D/~1/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "est non cillum", "highlightString": "esse culpa dolor non" }, { "key": "dolor", "highlightString": "pariatur Ut exercitation" }, { "key": "est do exercitation non", "highlightString": "sunt ad" } ], "status": "incomplete", "previous": { "incomplete": [ "e28f", "3a1f", "3a1f", "workflow_end", "3a1f" ], "complete": [ "e28f", "e28f" ], "error": [ "e28f", "workflow_end", "3a1f", "e28f", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": { "task": "workflow_end", "type": "loop" }, "failure": { "task": "workflow_start", "type": "loop" }, "error": { "task": "error_handler", "type": "revert" } }, "serverId": "ullamco sed", "start_time": "2019-04-16T00:43:22.038Z", "end_time": -15206843.082939252, "finish_state": "success", "retrySettings": { "state": [ "success", "error", "success" ], "autoRetry": false, "limit": 184893, "delay": 20445864, "count": 89683109 }, "loop": { "atLeastOneComplete": false, "finishedCount": -66323896.02280853, "outgoing": [ null ] }, "childJobs": { "_id": "ad ut elit eu cillum", "name": "in sit incididunt", "iteration": 66142509.78125042 } } }, "errorHandler": null, "groups": [ "4321abcdef694aa79dae47ad" ], "watchers": [ "4321abcdef694aa79dae47ad", "Pronghorn" ], "metrics": { "start_time": -84074149.02455491, "progress": 0.03715061095231453, "end_time": -32917180.327025577, "user": "Pronghorn", "owner": "5cb7b531d06cceb89fd21b1c" } }
{ "$ref": "job-db" }