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": "minim", "options": { "description": "Example job description", "type": "automation", "groups": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "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": -22058044, "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": "9557925733.78270.0762684603", "canvasVersion": 2, "name": "velit cillum laboris", "description": null, "preAutomationTime": -71874148.43409905, "sla": -10031962.648883402, "decorators": [ { "type": "encryption", "pointer": "/~0/VtdXw/~1/~0/dq6qaXY5IBM" }, { "type": "encryption", "pointer": "/~1/~1/~1/~0/du4,yPWoy+8/Jyo83h7Ed/~1/~0/OfA4M" }, { "type": "encryption", "pointer": "/~0/F/~0" }, { "type": "encryption", "pointer": "/~1/Benb2hR7sa/~1/KPpnZG/~0/~0" }, { "type": "encryption", "pointer": "/Af+klfNQO8/~0/~1/~1/~1/~1/~0/~0" } ], "transitions": { "workflow_start": { "workflow_start": { "state": "success", "type": "standard" }, "workflow_end": { "state": "success", "type": "standard" }, "error_handler": { "state": "failure", "type": "standard" } }, "workflow_end": { "workflow_start": { "state": "error", "type": "standard" }, "workflow_end": { "state": "failure", "type": "loop" }, "error_handler": { "state": "success", "type": "loop" } }, "error_handler": { "workflow_start": { "state": "failure", "type": "loop" }, "workflow_end": { "state": "failure", "type": "standard" }, "error_handler": { "state": "failure", "type": "loop" } } }, "status": "canceled", "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" ], "tasks": { "workflow_start": { "x": -55183081.205592014, "y": -37312398.41706531, "gridCoordinate": { "x": -2779171.6685258, "y": -9292466.042974561 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -8532331.873458073, "finish_state": "error", "user": "5cb7b531d06cceb89fd21b1c" }, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "actor": "$var.e36.KBzFYM2z_", "location": "Adapter", "locationType": "minim", "app": "nostrud et fugiat", "canvasName": "id cillum incididunt dolore exercitation", "displayName": "enim aute proident", "description": "velit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/PW/r8cykd/x18Fmt/~1/PZjn/~0/gvi8yq8HOP," }, { "type": "encryption", "pointer": "/~1/yHzYuHlUnw/Xr3/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "commodo dolore consequat dolor", "highlightString": "enim incididunt reprehenderit" }, { "key": "consequat reprehenderit", "highlightString": "sed culpa" }, { "key": "pariatur laboris nisi aute enim", "highlightString": "tempor ullamco consequat ea nostrud" }, { "key": "minim aliqua", "highlightString": "sed" }, { "key": "in nisi tempor consequat", "highlightString": "Lorem amet tempor in in" } ], "status": "complete", "previous": { "incomplete": [ "workflow_end", "3a1f", "e28f" ], "complete": [ "workflow_end" ], "error": [ "workflow_start", "e28f", "workflow_end", "workflow_end", "3a1f" ] }, "transitions": { "success": { "task": "3a1f", "type": "standard" }, "failure": { "task": "e28f", "type": "loop" }, "error": { "task": "workflow_end", "type": "standard" } }, "serverId": "Ut ipsum", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 20292804.79838462, "finish_state": "success", "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 63841330, "delay": 96975293, "count": 94620197 }, "type": "automatic" }, "workflow_end": { "x": -5920681.625945747, "y": -81673867.29104735, "gridCoordinate": { "x": 71611538.7385908, "y": 98093927.47687462 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f" ], "complete": [ "3a1f", "error_handler", "error_handler", "error_handler" ], "error": [ "error_handler", "3a1f" ] }, "metrics": { "end_time": -67010297.56426546, "run_time": 5522653.213773504 }, "groups": [ "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "$var.job.yF", "location": "Adapter", "locationType": null, "app": "commodo labore sit", "canvasName": "eu minim nisi nostrud", "displayName": "aliquip exercitation ut", "description": "mollit eiusmod nisi", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/H.0,c/5/K/j6/M/~1/~0/~1/yQr/~0/~1" }, { "type": "encryption", "pointer": "/~1/ERT+" }, { "type": "encryption", "pointer": "/rXAo/GfADx4y/k-1o8O0t00/TinrBqt/uNzVawHecp/~0/~1/~1/~1/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "deserunt", "highlightString": "reprehenderit eu nisi enim" }, { "key": "in elit fugiat", "highlightString": "occaecat magna nulla minim aute" }, { "key": "ex consequat", "highlightString": "proident qui reprehenderit laboris" }, { "key": "irure consectetur dolor", "highlightString": "ea incididunt elit occaecat dolore" }, { "key": "sed dolor proident cillum nulla", "highlightString": "reprehenderit in id voluptate" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "workflow_start", "error_handler", "3a1f", "e28f" ], "complete": [ "workflow_end", "e28f", "e28f", "3a1f" ], "error": [ "e28f", "workflow_start" ] }, "transitions": { "success": { "task": "error_handler", "type": "revert" }, "failure": { "task": "workflow_end", "type": "loop" }, "error": { "task": "3a1f", "type": "revert" } }, "serverId": "eu exercitation labore", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 70624410.66686475, "finish_state": "error", "retrySettings": { "state": [ "failure", "error", "failure", "failure" ], "autoRetry": true, "limit": 74781916, "delay": 20197990, "count": 80215112 }, "type": "automatic" }, "error_handler": { "x": 32277423.0865563, "y": -65926772.349233165, "gridCoordinate": { "x": -22889376.486223817, "y": 62027723.028628856 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "dolore", "canvasName": "officia nostrud incididunt", "displayName": "do dolor mollit ex", "summary": "Ut cillum pariatur", "description": "nulla culpa occaecat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/P,rV/~1/g3nD7Fc4pkC/qcQYThgbkbR/~1/~0/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "voluptate aute dolore", "highlightString": "dolore proident nisi dolor" } ], "status": "error", "previous": { "incomplete": [ "error_handler", "e28f", "error_handler", "3a1f", "error_handler" ], "complete": [ "3a1f", "workflow_end", "3a1f", "workflow_end", "3a1f" ], "error": [ "3a1f", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": { "task": "workflow_end", "type": "standard" }, "failure": { "task": "e28f", "type": "standard" }, "error": { "task": "workflow_end", "type": "loop" } }, "serverId": "deserunt eu sunt", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 72575450.20675865, "finish_state": "error", "retrySettings": { "state": [ "failure", "success" ], "autoRetry": true, "limit": 68777510, "delay": 13909543, "count": 31856839 }, "type": "operation" }, "d0": { "actor": "$var.1b.s22UZ3Q1e9", "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ], "x": 77602022.18332294, "y": 79342531.25408316, "gridCoordinate": { "x": -11450183.810725182, "y": -85856817.61300234 }, "name": "culpa dolor", "location": "Application", "locationType": null, "app": "occaecat qui", "canvasName": "nostrud labore reprehenderit elit anim", "displayName": "in Ut", "summary": "Lorem culpa labore laboris in", "description": "ut ex est quis in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/KNJ/FWKJnMKPr/f/B/vkOk5oy/~1/~0/v91JP6l" }, { "type": "encryption", "pointer": "/tbgT.PRGxe/dD/q2F8qZH/~0/~0/DtGjr917Q/~0/~1/~0/~1" }, { "type": "encryption", "pointer": "/~0/r3Rryzv+y/~1/qi" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "voluptate officia laboris elit laborum", "highlightString": "culpa eu sunt" } ], "status": "running", "previous": { "incomplete": [ "e28f", "3a1f", "workflow_start", "3a1f" ], "complete": [ "e28f", "workflow_end", "error_handler" ], "error": [ "e28f", "e28f", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": { "task": "workflow_end", "type": "loop" }, "failure": { "task": "workflow_start", "type": "loop" }, "error": { "task": "3a1f", "type": "standard" } }, "serverId": "ut magna cupidatat", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 30326452.346141994, "finish_state": "success", "retrySettings": { "state": [ "error", "error" ], "autoRetry": true, "limit": 48942041, "delay": 62493038, "count": 72024017 }, "type": "automatic" } }, "errorHandler": null, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "watchers": [ "Pronghorn", "5cb7b531d06cceb89fd21b1c", "Pronghorn" ], "metrics": { "start_time": -69929834.01759516, "progress": 0.9109212783268936, "end_time": 96969073.69768053, "user": "4321abcdef694aa79dae47ad", "owner": "4321abcdef694aa79dae47ad" } }
{ "$ref": "job-db" }