Summary
Start a Job
Description
Spawns a Job from a Workflow.
Route
POST /operations-manager/jobs/start
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
workflow | string | yes | The name of the workflow from which to start the Job. |
options | object | yes | Options for the Job. |
{ "workflow": "commodo", "options": { "description": "Example job description", "type": "automation", "groups": [ "10df71f390ef22e6c1d9f8e8", "709255ff016f5259cffb03b8" ] } }
{ "type": "object", "properties": { "workflow": { "title": "workflow", "type": "string" }, "options": { "title": "options", "type": "object", "properties": { "description": { "type": "string", "description": "The description for the new Job.", "examples": [ "Example job description" ] }, "type": { "type": "string", "examples": [ "automation" ] }, "variables": { "type": "object", "description": "Variables for the new Job.", "additionalProperties": true }, "groups": { "type": "array", "description": "GBAC for the new Job.", "items": { "$ref": "common#/definitions/ObjectIdLikeString" } } } } }, "required": [ "workflow", "options" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
job | object | The spawned Job. |
{ "message": "Successfully retrieved search results", "data": { "_id": "bba82faa3c3a53aa3051239a", "font_size": -10034088, "type": "resource:compliance", "created": "2015-06-15T17:20:13.14Z", "last_updated": "1987-12-19T14:07:52.908Z", "createdVersion": "65245.63.72145924351-6383.3572.20248", "lastUpdatedVersion": "37162231549.743856.87545825-0014.805587509.04437.80979560753", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 69770427, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 64077486.30143431, "sla": 43581377.18973786, "decorators": [ { "type": "encryption", "pointer": "/hmTthHfd/~1/fDfu./vwoI/z9OE/~0/~1/~0" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/HO-/~0" }, { "type": "encryption", "pointer": "/~0/iGh1gm/~0/~1/~1/~1" }, { "type": "encryption", "pointer": "/~1/~1" } ], "status": "error", "tags": [], "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 } ], "warnings": [ { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "anim laborum" } ], "ancestors": null, "validationErrors": [ { "keyword": "ea velit esse et", "instancePath": "ex in magna", "schemaPath": "fugiat elit dolore laborum", "message": "et ad dolor" } ], "created_by": "f03847f430e285414ad15ff4", "last_updated_by": { "_id": "01635c107bdd22376a4625eb", "provenance": "irure dolor nulla ipsum", "username": "magna sint tempor", "firstname": "id aliqua anim magna", "memberOf": [ { "groupId": "520b43b665b5bb517092de58", "aaaManaged": true }, { "groupId": "b583b01f29a9ae73fde5f286", "aaaManaged": false }, { "groupId": "b3749c2a7b79f73a8b8d1573", "aaaManaged": false }, { "groupId": "76abf8379b4b92ee01727291", "aaaManaged": true }, { "groupId": "7a99a0a0d8c94063d39cd13c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum incididunt ea Lorem do" }, { "roleId": "tempor" }, { "roleId": "id ea" }, { "roleId": "minim Ut" } ], "inactive": false, "lastLogin": "1984-09-05T14:15:06.678Z", "_meta": { "created": "1993-11-06T15:10:55.47Z", "updated": "1982-01-10T16:19:48.883Z", "migrationVersion": -72038150 }, "email": "officia ut adipisicing" }, "tasks": { "8": { "actor": "Pronghorn", "groups": [ "default", "04ae63455a52223ba03e990e" ], "iterations": [ "82De26Be-d594-4Cee-FC90-749feb1b3Ecc", "f495F4Bd-fABE-15Fa-D0fC-EA80D22dB0fa" ], "x": -27910007.408618703, "y": 99609950.43367401, "gridCoordinate": { "x": 45511228.8139773, "y": -27630953.26501718 }, "name": "eu Ut quis", "location": "Application", "locationType": "adipisicing irure elit", "app": "Duis id Excepteur velit", "canvasName": "amet commodo dolore dolor", "displayName": "dolore Lorem occaecat ut deserunt", "summary": "dolore exercitation aute Excepteur Lorem", "description": "elit velit Duis in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/T4Uf0ecKVD/~1" }, { "type": "encryption", "pointer": "/h" }, { "type": "encryption", "pointer": "/qTm7HxWCrI/~0/C15kK0/~0/oVkpcM9E/k" }, { "type": "encryption", "pointer": "/Bt/~0/sMu/Zndtm/f/~1/mh./~0/~1/~1/sGTO" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/~0/~1/CEcABAXZ1Cn/dbNTdn-GGW/eOZa/Md" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "voluptate", "highlightString": "sit nostrud do proident" }, { "key": "mollit tempor id eiusmod", "highlightString": "non esse enim deserunt voluptate" }, { "key": "dolore", "highlightString": "occaecat" }, { "key": "id nisi do", "highlightString": "aute laboris adipisicing" } ], "status": "complete", "previous": { "incomplete": [ "error_handler", "workflow_start", "error_handler", "workflow_start", "3a1f" ], "complete": [ "error_handler", "e28f", "error_handler", "error_handler", "workflow_start" ], "error": [ "e28f", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "standard" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "anim voluptate incididunt", "start_time": "1963-12-26T11:02:03.094Z", "end_time": 70994818.33905238, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "workflow_start": { "x": 63810680.373612046, "y": -71241222.6435021, "gridCoordinate": { "x": 13742204.949699268, "y": 51215923.579820246 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 49530669.43194142, "finish_state": "success", "user": { "_id": "c0e7cd96c03605da479095b8", "provenance": "elit est aliqua", "username": "voluptate ut dolor consectetur occaecat", "firstname": "consectetur voluptate", "memberOf": [ { "groupId": "8a25eb5f9073907b6c554a81", "aaaManaged": false }, { "groupId": "dceee4f8aaa3578b959f5c35", "aaaManaged": false }, { "groupId": "2e6655b8b35e2718762e0b1d", "aaaManaged": false }, { "groupId": "0a60751cfda5d1bf9d3537db", "aaaManaged": true }, { "groupId": "31286f845c7fc92ccec93f6a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in in eu do reprehenderit" }, { "roleId": "id proident occaecat" } ], "inactive": true, "lastLogin": "1957-01-10T02:13:06.94Z", "_meta": { "created": "1949-07-29T19:48:17.584Z", "updated": "1990-04-02T11:51:22.059Z", "migrationVersion": -91154499 }, "email": "dolor irure esse culpa aliquip" } }, "groups": [ "default", "247dc90c02a9bab49ea61fce", "8bece1f1084170b828315c4b", "default" ], "iterations": [ "707eCB7b-d0Ef-D7Fa-7adc-75aD8b13D170" ] }, "workflow_end": { "x": 70713748.34126726, "y": 94201531.82000273, "gridCoordinate": { "x": -92524862.33435161, "y": -90573056.54373318 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "3a1f", "e28f" ], "complete": [ "e28f", "workflow_start", "workflow_end", "workflow_start" ], "error": [ "workflow_end", "e28f" ] }, "metrics": { "end_time": 11633284.560258865, "run_time": 14255123.196006283 }, "groups": [ "default", { "_id": "d86320d437e311cb9e061311", "provenance": "magna", "name": "et esse dolore", "description": "occaecat dolor", "memberOf": [ { "groupId": "b1a0ad832eaae50c6f4662c0", "aaaManaged": true }, { "groupId": "098e35d84d7a4decfa29e571", "aaaManaged": true }, { "groupId": "b2a43c4910c2f2b29a59d619", "aaaManaged": true }, { "groupId": "88b433e6cb19b97b7b98ea0d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor Duis ex officia" }, { "roleId": "in ullamco mollit quis" }, { "roleId": "sunt consequat in" }, { "roleId": "dolor" }, { "roleId": "dolore labore tempor" } ], "inactive": false, "_meta": { "created": "1953-11-25T15:58:14.641Z", "updated": "2023-02-26T21:33:14.69Z", "migrationVersion": 77040488 } } ], "iterations": [ "baAd9FFe-8db8-d3eE-2e6D-428b3131dbb9", "FB2A95c4-06BA-cd21-9E0B-8afD5AAE31E4", "aF571522-EDcF-dC56-bbE2-2f9e2AEC993f", "5EC6af7F-e0A1-ebf5-d0a4-08713eAACBCd" ] }, "error_handler": { "x": -68984162.81367226, "y": 96763808.427329, "gridCoordinate": { "x": 26710485.015776306, "y": 2504348.594792381 }, "name": "childJob", "location": "Application", "locationType": null, "app": "sed nisi aute veniam", "canvasName": "Lorem", "displayName": "culpa commodo", "summary": "sunt et ea", "description": "ea dolore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/UOwFmfn1/o/G,/~1/p/MF7/tykgZO3/DXbdV-9ATo" }, { "type": "encryption", "pointer": "/YOC9cMz/~1/l1iNC21Gxhz/VkX3/f7AZ/~1/~1/~1/~0/UD5R" }, { "type": "encryption", "pointer": "/x-1x/~0/vyj7dgsDs/~1/~1/~0/J4tw/jNgcgVCFwTP/g-YW2fC/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "quis", "highlightString": "incididunt irure anim consequat tempor" }, { "key": "eiusmod amet esse", "highlightString": "ex in reprehenderit in" }, { "key": "sit ut in", "highlightString": "aute adipisicing" }, { "key": "ad sit adipisicing ut", "highlightString": "aliquip commodo laborum sint" }, { "key": "aute do aliqua eiusmod mollit", "highlightString": "nisi fugiat culpa minim" } ], "status": "paused", "previous": { "incomplete": [ "error_handler", "workflow_start", "workflow_start", "error_handler", "e28f" ], "complete": [ "e28f", "e28f", "error_handler" ], "error": [ "error_handler", "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "tempor do in", "start_time": "2019-01-11T03:51:40.596Z", "end_time": -8382963.96814546, "finish_state": "failure", "retrySettings": { "state": [ "error", "failure", "error" ], "autoRetry": true, "limit": 57497399, "delay": 70116202, "count": 22299887, "finishedRetrying": false }, "type": "operation", "actor": "Pronghorn", "groups": [ "default", { "_id": "ef54031c1aa2983e56cf0132", "provenance": "nostrud deserunt Duis aliqua Lorem", "name": "deserunt mollit ea", "description": "mollit elit ea dolor", "memberOf": [ { "groupId": "ab39e92e6c92603d491ff24b", "aaaManaged": false }, { "groupId": "4fc4bc72c15c692a38b00f36", "aaaManaged": true }, { "groupId": "790f6ca81a310b85cb5d4c83", "aaaManaged": false }, { "groupId": "b288a3eade7ff051387f2549", "aaaManaged": true }, { "groupId": "d69ef4ed0ab443f6db6eebfc", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt culpa" }, { "roleId": "incididunt dolor" }, { "roleId": "adipisicing sunt" } ], "inactive": true, "_meta": { "created": "1977-12-23T10:36:00.471Z", "updated": "1983-02-06T03:01:50.026Z", "migrationVersion": -96493293 } }, "f039aa6f0e949f8e8816fdea", "34ab9680c66ba41e52eaf89a" ], "iterations": [ "3ed21313-c83c-4366-6c2d-ee5566caaFa9", "a8c8FDe8-cECc-1f5C-B6Af-4E70838Cd7Bc", "cad62635-aee0-34bB-1721-e3BFdf0D1fE6", "Fc58fa15-705D-B06d-BFB9-B4F0F5015A92" ] } }, "parent": { "task": "ea fugiat nulla nostrud", "iteration": -19999754.908807248, "element": -72811754.43028012 }, "errorHandler": null, "groups": [ { "_id": "30ae05cf1b938c9bd49b5600", "provenance": "elit ex Excepteur", "name": "commodo in elit velit", "description": "exercitation dolore amet", "memberOf": [ { "groupId": "00ccf54afbf49c5e4bfe62dd", "aaaManaged": false }, { "groupId": "14af319bb7f884f43bdcee11", "aaaManaged": false }, { "groupId": "79a94cdce7b0a662f3ed7511", "aaaManaged": false }, { "groupId": "327573aa4f06bab3d2288f49", "aaaManaged": true }, { "groupId": "a10cb340a6a4c4d557ce5a10", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse consectetur" }, { "roleId": "sit Excepteur" }, { "roleId": "cillum cupidatat nostrud ipsum" }, { "roleId": "id velit fugiat" }, { "roleId": "enim" } ], "inactive": false, "_meta": { "created": "2017-06-06T20:33:35.744Z", "updated": "1978-06-24T16:32:45.495Z", "migrationVersion": 85398181 } }, "fb408ca6b1d197f631242948", "d4fe742846285652ff63b83b", "7c1386bf6c18974f6eabdd56" ], "watchers": [ { "_id": "ec21d7d1b9a9f2deb33615fe", "provenance": "labore culpa eu", "username": "labore dolore occaecat est cillum", "firstname": "aute ipsum dolor", "memberOf": [ { "groupId": "e169c9e84f70c1bf30776992", "aaaManaged": true }, { "groupId": "8d1960675f5c2d22a1ff8c27", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit et consequat" }, { "roleId": "elit cupidatat occaecat quis deserunt" }, { "roleId": "consectetur ea" } ], "inactive": false, "lastLogin": "1948-01-21T08:21:58.881Z", "_meta": { "created": "1988-09-13T18:57:49.539Z", "updated": "2001-01-26T06:13:11.474Z", "migrationVersion": 45857373 }, "email": "eiusmod" }, null ], "metrics": { "start_time": -24896228.68587014, "progress": 0.573273040309068, "end_time": 78886668.44754434, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }