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": "cillum eu", "options": { "description": "Example job description", "type": "automation", "groups": [ "5cb7b531d06cceb89fd21b1c", "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": -52193677, "type": "automation", "created": "2019-04-16T00:43:22.038Z", "created_by": "5cb7b531d06cceb89fd21b1c", "last_updated": "2019-04-16T00:43:22.038Z", "last_updated_by": "5cb7b531d06cceb89fd21b1c", "lastUpdatedVersion": "7000.665658951.77", "canvasVersion": 1, "name": "est", "description": "in Lorem velit sit", "preAutomationTime": -77317036.00771835, "sla": -22627725.61589262, "decorators": [ { "type": "encryption", "pointer": "/~1/Q6/Y/~1/~1/NNCnpiwZ/~1/~0/wfVMcxDWR38/l5r-uAF718e" } ], "transitions": { "workflow_start": { "workflow_start": { "state": "success", "type": "loop" }, "workflow_end": { "state": "error", "type": "loop" }, "error_handler": { "state": "failure", "type": "standard" } }, "workflow_end": { "workflow_start": { "state": "failure", "type": "standard" }, "workflow_end": { "state": "error", "type": "standard" }, "error_handler": { "state": "failure", "type": "revert" } }, "error_handler": { "workflow_start": { "state": "error", "type": "standard" }, "workflow_end": { "state": "failure", "type": "loop" }, "error_handler": { "state": "failure", "type": "standard" } } }, "status": "running", "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 } ], "ancestors": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "tasks": { "workflow_start": { "x": -12448116.30596079, "y": 32021686.11771117, "gridCoordinate": { "x": 76225092.5897547, "y": -60962355.51549842 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 41607753.28148869, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "Pronghorn", "location": "Application", "locationType": null, "app": "ea adipisicing dolor in veniam", "canvasName": "velit dolor", "displayName": "consequat sed do", "description": "ut qui cupidatat in magna", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/yw6SeH/T/~0/~0/~0/KsJSE7mp/~1/~0/LAN" }, { "type": "encryption", "pointer": "/ddwq/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "consequat qui enim eiusmod Lorem", "highlightString": "enim quis" } ], "status": "scheduled", "previous": { "incomplete": [ "e28f", "error_handler" ], "complete": [ "error_handler" ], "error": [ "workflow_start" ] }, "transitions": { "success": { "task": "workflow_start", "type": "loop" }, "failure": { "task": "e28f", "type": "revert" }, "error": { "task": "workflow_end", "type": "revert" } }, "serverId": "ut Ut eiusmod", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 36679126.98015171, "finish_state": "failure", "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 72182453, "delay": 42945350, "count": 53123118 }, "type": "manual", "view": "ullamco" }, "workflow_end": { "x": 38352662.39185211, "y": 65280872.65152952, "gridCoordinate": { "x": 49439623.751077026, "y": 54864704.044816524 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "error_handler", "3a1f" ], "complete": [ "e28f", "workflow_end" ], "error": [ "e28f", "error_handler", "workflow_start", "workflow_end" ] }, "metrics": { "end_time": -59833942.938098826, "run_time": -69551693.55260158 }, "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "actor": "Pronghorn", "location": "Broker", "locationType": "nisi in tempor", "app": "occaecat in", "canvasName": "culpa sunt eiusmod ut reprehenderit", "displayName": "velit non id dolore", "description": "nisi tempor dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~0/~0/LcKGL/vI91O,0h/rNkHUUnpk8E/BNg/ydwfuZlnSj-/~0/~1/~0" }, { "type": "encryption", "pointer": "/FxIOR/~0/~1/e/Fgepx3o/~0/SeKrKgE6Qm/~0/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "do", "highlightString": "ex tempor adipisicing ad" }, { "key": "elit", "highlightString": "commodo" }, { "key": "id nulla occaecat enim", "highlightString": "consectetur aliquip Lorem adipisicing" } ], "status": "running", "previous": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_start", "e28f", "3a1f" ], "error": [ "3a1f", "3a1f" ] }, "transitions": { "success": { "task": "e28f", "type": "revert" }, "failure": { "task": "3a1f", "type": "standard" }, "error": { "task": "e28f", "type": "standard" } }, "serverId": "qui", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 66061103.933336616, "finish_state": "error", "retrySettings": { "state": [ "failure", "failure", "error", "success", "failure" ], "autoRetry": true, "limit": 11869080, "delay": 31946229, "count": 49354520 }, "type": "manual", "view": "quis" }, "error_handler": null, "b0f5": { "actor": "5cb7b531d06cceb89fd21b1c", "groups": [ "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "x": 60931732.03249341, "y": 42963038.618311524, "gridCoordinate": { "x": 57446062.26051986, "y": 24651641.989264533 }, "name": "consequat nisi", "location": "Adapter", "locationType": null, "app": "elit aliquip", "canvasName": "deserunt ullamco Excepteur ex mollit", "displayName": "elit voluptate", "summary": "eu ea anim", "description": "pariatur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/DjcVj9nlvn/~1/Tvkkzm/~1/vl-0vG-" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "aute consequat tempor labore", "highlightString": "non qui do quis consectetur" }, { "key": "esse", "highlightString": "reprehenderit dolor culpa ut" }, { "key": "aliquip dolor veniam amet", "highlightString": "amet pariatur in" }, { "key": "labore", "highlightString": "Excepteur dolor Lorem dolore magna" } ], "status": "scheduled", "previous": { "incomplete": [ "3a1f", "e28f", "e28f", "workflow_start", "e28f" ], "complete": [ "workflow_start", "workflow_end" ], "error": [ "workflow_end", "error_handler", "3a1f", "e28f" ] }, "taskId": "e28f", "transitions": { "success": { "task": "e28f", "type": "revert" }, "failure": { "task": "e28f", "type": "standard" }, "error": { "task": "3a1f", "type": "standard" } }, "serverId": "Duis", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 16207971.653241456, "finish_state": "error", "retrySettings": { "state": [ "error", "error", "error", "success" ], "autoRetry": true, "limit": 19340250, "delay": 54855631, "count": 33340764 }, "type": "manual", "view": "aliqua adipisicing occaecat" } }, "errorHandler": null, "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "watchers": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "metrics": { "start_time": -56885364.12943641, "progress": 0.06029913798877695, "end_time": -3275241.918235719, "user": "4321abcdef694aa79dae47ad", "owner": "4321abcdef694aa79dae47ad" } }
{ "$ref": "job-db" }