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": "non aute", "options": { "description": "Example job description", "type": "automation", "groups": [ "4321abcdef694aa79dae47ad", "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": "5cb7b531d06cceb89fd21b1c", "font_size": 13797487, "type": "automation", "created": "2019-04-16T00:43:22.038Z", "created_by": "Pronghorn", "last_updated": "2019-04-16T00:43:22.038Z", "last_updated_by": "5cb7b531d06cceb89fd21b1c", "lastUpdatedVersion": "409967.99594.3", "canvasVersion": 2, "name": "esse magna incididunt", "description": "incididunt sed dolore", "preAutomationTime": -64402039.49645782, "sla": -2714274.9237502664, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/hOPgIe,zxu/DXP/~0" }, { "type": "encryption", "pointer": "/SMD,bOZJecG/~0/xV.e/~1/I7,mYobV4z/UiER/~0" }, { "type": "encryption", "pointer": "/sFXlqrsOP/W5j93gTiJ/XFkV/et,/~1/~0" }, { "type": "encryption", "pointer": "/~0/XM2xjGB" } ], "transitions": { "workflow_start": { "workflow_start": { "state": "failure", "type": "loop" }, "workflow_end": { "state": "failure", "type": "loop" }, "error_handler": { "state": "success", "type": "loop" } }, "workflow_end": { "workflow_start": { "state": "success", "type": "loop" }, "workflow_end": { "state": "error", "type": "standard" }, "error_handler": { "state": "success", "type": "standard" } }, "error_handler": { "workflow_start": { "state": "success", "type": "revert" }, "workflow_end": { "state": "success", "type": "revert" }, "error_handler": { "state": "failure", "type": "standard" } } }, "status": "canceled", "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 } ], "ancestors": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "tasks": { "358": { "actor": "$var.job.VeaueN", "groups": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79" ], "x": 93576359.20635244, "y": -29060119.09308876, "gridCoordinate": { "x": -57581026.570978455, "y": 96871774.74092197 }, "name": "ad eu Lorem sit aute", "location": "Broker", "locationType": null, "app": "voluptate mollit eiusmod ex Lorem", "canvasName": "minim pariatur veniam Ut id", "displayName": "velit", "summary": "qui", "description": "pariatur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/pNHf8Zb4w/~0/~0/KRX/DbCBGH/W/~0" }, { "type": "encryption", "pointer": "/~0/~1/w92IgQ/~0/Go8h3b/MDB,y/~1/~0" }, { "type": "encryption", "pointer": "/~1/IojbQEaymu/Ptbr6/~0/z/sGjb/~1/c.zIdT/n/e" }, { "type": "encryption", "pointer": "/~1/FK5Gxk7-t/QS+rFwLg/jQM5R/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "Excepteur nulla", "highlightString": "pariatur ea" }, { "key": "labore Excepteur exercitation pariatur in", "highlightString": "voluptate eu" }, { "key": "dolor irure", "highlightString": "et elit" }, { "key": "velit dolor do", "highlightString": "exercitation nulla consectetur dolore sint" } ], "status": "error", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_start", "e28f", "e28f", "workflow_end" ], "error": [ "workflow_start", "3a1f", "workflow_end" ] }, "taskId": "3a1f", "transitions": { "success": { "task": "e28f", "type": "standard" }, "failure": { "task": "3a1f", "type": "loop" }, "error": { "task": "3a1f", "type": "revert" } }, "serverId": "anim dolor in culpa", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 67235709.90785608, "finish_state": "failure", "retrySettings": { "state": [ "error", "failure", "error", "error", "failure" ], "autoRetry": true, "limit": 68364891, "delay": 47224619, "count": 25956722 }, "type": "automatic" }, "workflow_start": { "x": 5181728.695312768, "y": 30738287.62461482, "gridCoordinate": { "x": -57891582.37935963, "y": -56985611.71774674 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -1557479.2275494486, "finish_state": "success", "user": "5cb7b531d06cceb89fd21b1c" }, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5", "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "Pronghorn", "location": "Application", "locationType": null, "app": "qui dolor dolor", "canvasName": "aliquip commodo sed culpa", "displayName": "incididunt ut", "description": "veniam eu velit nisi", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/VvGbOQ5Xkv/eLpTzvJM/F75A9WJ1/~1/BEk9ewRMT" }, { "type": "encryption", "pointer": "/~0/q/w/~0/~0/iTDB/U74Z26Gmja/~0" }, { "type": "encryption", "pointer": "/ph/f4Z41Aj/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "deserunt Ut Lorem nostrud", "highlightString": "dolore eiusmod" } ], "status": "complete", "previous": { "incomplete": [ "error_handler", "workflow_start" ], "complete": [ "workflow_end", "3a1f", "error_handler", "workflow_end", "workflow_start" ], "error": [ "e28f", "e28f", "e28f", "3a1f", "e28f" ] }, "transitions": { "success": { "task": "workflow_end", "type": "loop" }, "failure": { "task": "error_handler", "type": "loop" }, "error": { "task": "workflow_start", "type": "revert" } }, "serverId": "aliqua eu", "start_time": "2019-04-16T00:43:22.038Z", "end_time": 53224411.2468501, "finish_state": "success", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 91390126, "delay": 75251490, "count": 57325563 }, "type": "automatic" }, "workflow_end": { "x": 66545111.993198335, "y": 58539877.62833205, "gridCoordinate": { "x": -6160272.714202225, "y": 18775821.74387014 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "3a1f", "e28f", "workflow_end", "workflow_end" ], "error": [ "error_handler", "3a1f", "error_handler", "error_handler", "workflow_end" ] }, "metrics": { "end_time": -41902981.9217569, "run_time": 94340601.59822416 }, "groups": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "iterations": [ "6ffce28f-37f8-48a0-a026-5567120def79", "6ffce28f-37f8-48a0-a026-5567120def79" ], "actor": "$var.job.S", "location": "Application", "locationType": null, "app": "aliquip fugiat consequat dolor ipsum", "canvasName": "do", "displayName": "veniam", "description": "culpa exercitation", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/O9YkPbbrZ/d/TXvZ/G+kk/~1/TX9Cn4wOl4" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "deserunt esse qui ipsum laborum", "highlightString": "in ut et" }, { "key": "ea veniam exercitation cillum eu", "highlightString": "magna do tempor" }, { "key": "irure", "highlightString": "culpa elit ut" } ], "status": "incomplete", "previous": { "incomplete": [ "3a1f", "error_handler", "e28f", "error_handler" ], "complete": [ "error_handler", "error_handler", "error_handler" ], "error": [ "error_handler", "3a1f", "workflow_end", "error_handler", "workflow_start" ] }, "transitions": { "success": { "task": "workflow_end", "type": "standard" }, "failure": { "task": "3a1f", "type": "standard" }, "error": { "task": "e28f", "type": "standard" } }, "serverId": "irure nulla deserunt laborum", "start_time": "2019-04-16T00:43:22.038Z", "end_time": -27085498.584252894, "finish_state": "success", "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 10412439, "delay": 40900183, "count": 56865136 }, "type": "automatic" }, "error_handler": null }, "errorHandler": null, "groups": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "watchers": [ "4321abcdef694aa79dae47ad" ], "metrics": { "start_time": 14144995.44502838, "progress": 0.25357374375575037, "end_time": 60460022.050599754, "user": "4321abcdef694aa79dae47ad", "owner": "Pronghorn" } }
{ "$ref": "job-db" }