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": "tempor", "options": { "description": "Example job description", "type": "automation", "groups": [ "85b5d107ee4bad33d9372fcb", "db87a74b92e6a37ed1ba50fc", "06af76733aeae55282c2ad0e", "98aabe9c4aa1fecc75b875eb", "677cca583deb5fc81a6a4e9a" ] } }
{ "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 created the requested item", "data": { "_id": "86ee8867cbf3be858024ada8", "font_size": 81778432, "type": "resource:compliance", "created": "2018-05-04T08:10:58.106Z", "last_updated": "1992-03-04T21:45:10.359Z", "createdVersion": "7.128405848.57750953984", "lastUpdatedVersion": "77519694.32494167775.17490426", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -48639826, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 65661534.30205706, "sla": 337215.46650493145, "decorators": [ { "type": "encryption", "pointer": "/bQ3-mwx/~1/~0/~1/~1/~1/~1/~1/v" } ], "status": "error", "tags": [], "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 }, { "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 } ], "warnings": [ { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "ipsum in" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "sit sed eiusmod irure mollit" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "elit", "instancePath": "deserunt mollit eiusmod amet dolore", "schemaPath": "nisi amet", "message": "tempor laboris voluptate laborum Lorem" }, { "keyword": "aute incididunt dolore", "instancePath": "in nisi occaecat voluptate", "schemaPath": "nulla irure voluptate culpa", "message": "commodo irure qui proident" }, { "keyword": "cillum", "instancePath": "Lorem esse Ut in", "schemaPath": "mollit dolore amet", "message": "reprehenderit" }, { "keyword": "aliquip id", "instancePath": "consequat deserunt", "schemaPath": "amet labore", "message": "Ut qui enim in" } ], "created_by": "36bffedd20749dde5bb481ac", "last_updated_by": { "_id": "3b2660937237004b8c059c96", "provenance": "consectetur", "username": "reprehenderit", "firstname": "sunt", "memberOf": [ { "groupId": "7ff37ff49c37c7167c288225", "aaaManaged": false }, { "groupId": "d894255cb493b57364163bb4", "aaaManaged": false }, { "groupId": "f242e17aef2dfef5f6fdcd88", "aaaManaged": true }, { "groupId": "0862b5195bac262de74498a1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam" } ], "inactive": true, "lastLogin": "2019-07-13T17:45:13.113Z", "_meta": { "created": "2023-02-17T01:04:37.717Z", "updated": "1952-12-09T17:08:28.3Z", "migrationVersion": -23371422 }, "email": "nisi ipsum magna cillum do" }, "tasks": { "324": { "actor": "job", "groups": [ "13120c0a38bd4c73cc54748f", "default", "default", { "_id": "9e133bc79454302475b34c83", "provenance": "cillum Ut", "name": "deserunt ea pariatur", "description": "eiusmod cillum fugiat mollit", "memberOf": [ { "groupId": "5ecad6555be5c6046ba15b7b", "aaaManaged": false }, { "groupId": "0bf89df650191b8feee55af7", "aaaManaged": true }, { "groupId": "66ec040b9ee469b5ce4e61eb", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum dolor ut mollit commodo" } ], "inactive": true, "_meta": { "created": "1968-03-28T15:25:47.113Z", "updated": "1969-11-13T21:41:07.977Z", "migrationVersion": 14473799 } }, "8e7b4faa07138986705a1d0e" ], "iterations": [], "x": -20962015.879179627, "y": -95236670.20518313, "gridCoordinate": { "x": -12251061.911306933, "y": -69875829.44535902 }, "name": "incididunt id sunt officia", "location": "Application", "locationType": null, "app": "dolor amet dolore", "canvasName": "id deserunt consequat", "displayName": "dolor ut ut labore consectetur", "summary": "anim magna adipisicing", "description": "ea Duis sint", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/~0/~1/xdNtXNoQ/~1/rcuq/BYBME./~1" }, { "type": "encryption", "pointer": "/kR4OlmZpyP0/~1/AP8bHXe9QY-/~1/i,t/~1" }, { "type": "encryption", "pointer": "/~0/MUdz/~1/wn.d0eEq7SA/wKh/qJxKhVr.-/Ava5SK3/ghI/~1" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/ioAyqd4x/Ylg/DsIBW.zeIg," } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "quis eiusmod consectetur ut sit", "highlightString": "eiusmod veniam qui" }, { "key": "ut", "highlightString": "sit in aute" }, { "key": "aliqua fugiat nulla id", "highlightString": "aliqua eu Excepteur" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "workflow_start", "workflow_start", "error_handler", "e28f" ], "complete": [ "error_handler", "workflow_start", "workflow_end" ], "error": [ "workflow_end", "workflow_end", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "occaecat aute dolor", "start_time": "1979-07-22T05:08:17.328Z", "end_time": -31273913.565779403, "finish_state": "error", "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 49697951, "delay": 74959893, "count": 37976561, "finishedRetrying": true }, "type": "automatic" }, "workflow_start": { "x": -18559309.746514916, "y": 71777045.18454915, "gridCoordinate": { "x": -2042377.7083688974, "y": 79046968.76494586 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 46356663.989794195, "finish_state": "failure", "user": { "_id": "d18c8057d22b6427debf2d38", "provenance": "cupidatat", "username": "enim aliquip irure velit sit", "firstname": "deserunt culpa proident nulla ad", "memberOf": [ { "groupId": "f65c78925957dd70b9999f6a", "aaaManaged": true }, { "groupId": "8bd049fb76c4f8a332a3335d", "aaaManaged": false }, { "groupId": "88820c4d2cb5661efd043622", "aaaManaged": true }, { "groupId": "182822a6cf64602ad80c0c1b", "aaaManaged": true }, { "groupId": "cc76bf3301e29cfceca55959", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum cupidatat reprehenderit ullamco dolor" } ], "inactive": false, "lastLogin": "1970-06-02T09:31:04.74Z", "_meta": { "created": "1992-06-03T05:30:02.328Z", "updated": "2024-07-26T00:16:38.155Z", "migrationVersion": 55235120 }, "email": "cupidatat eu Lorem culpa" } }, "groups": [ { "_id": "660213a4d07ce8ee13250866", "provenance": "mollit adipisicing est", "name": "esse nisi velit", "description": "enim", "memberOf": [ { "groupId": "e3d8ea209c7c95634a21dcdd", "aaaManaged": true }, { "groupId": "0c247c7fd3a6d38786250bcf", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco qui" }, { "roleId": "dolor fugiat in nostrud" }, { "roleId": "ea consequat nulla" } ], "inactive": false, "_meta": { "created": "1952-09-21T22:29:28.366Z", "updated": "1981-02-08T21:36:10.531Z", "migrationVersion": -20382160 } }, "default" ], "iterations": [ "2BCfFF7f-2076-2AAD-af4A-FDE4Cad44bB6", "dc043AB5-A59a-b6d1-D4dD-540a6aAb719D" ] }, "workflow_end": { "x": 20445581.762231544, "y": -71018788.1796764, "gridCoordinate": { "x": -81178275.17154272, "y": 7545593.473155335 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "workflow_start", "workflow_start", "3a1f", "error_handler" ], "complete": [ "e28f", "workflow_start", "error_handler" ], "error": [ "e28f" ] }, "metrics": { "end_time": -14620561.668639943, "run_time": -86744513.2406945 }, "groups": [ { "_id": "ea6c56f89364ee068e154da5", "provenance": "do in proident consectetur", "name": "reprehenderit consectetur tempor veniam", "description": "aute ad", "memberOf": [ { "groupId": "4f22f2b94acf87465897d874", "aaaManaged": false }, { "groupId": "bc4ad1c3d7c3b66375ecc9ea", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut id esse" }, { "roleId": "nisi exercitation voluptate nulla" }, { "roleId": "ex ullamco qui ut proident" }, { "roleId": "labore sed nisi" }, { "roleId": "ex reprehenderit ad Lorem" } ], "inactive": true, "_meta": { "created": "2018-05-26T13:14:53.136Z", "updated": "1983-08-10T23:29:07.734Z", "migrationVersion": -58498496 } } ], "iterations": [] }, "error_handler": { "x": 93125641.075481, "y": -98671607.73130772, "gridCoordinate": { "x": 58580319.339145035, "y": -21868812.447631747 }, "name": "childJob", "location": "Application", "locationType": null, "app": "mollit culpa", "canvasName": "in culpa eu", "displayName": "mollit ipsum exercitation", "summary": "dolore sint", "description": "ut nulla aute labore nostrud", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/K2oleSNN/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/V/pAdoG/fuO./p.G/rMMe/5n9Om/Pl/lX6kw/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "minim amet dolor", "highlightString": "fugiat dolor" }, { "key": "ad minim", "highlightString": "nulla cupidatat" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start", "3a1f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end", "workflow_end" ], "error": [ "error_handler", "workflow_start", "e28f", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "loop" } ] }, "serverId": "ullamco Lorem aute magna reprehenderit", "start_time": "2019-09-04T14:31:27.473Z", "end_time": 4342063.100275919, "finish_state": "success", "retrySettings": { "state": [ "error", "failure", "success" ], "autoRetry": false, "limit": 14542783, "delay": 51269376, "count": 82396513, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "49e3f3413012d61911061591", "provenance": "id", "name": "incididunt dolor sunt", "description": "Duis proident fugiat elit aute", "memberOf": [ { "groupId": "5f2878fbb56a3e23038ba780", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in ut ex" }, { "roleId": "ad aliqua sunt ex" } ], "inactive": false, "_meta": { "created": "1995-02-24T03:44:19.187Z", "updated": "1978-12-20T00:30:32.166Z", "migrationVersion": -10360390 } }, "default", "aa8b9feb1fa6fed976d76e4c", "default", "default" ], "iterations": [ "1EEa2057-78F3-01B2-9D44-b3C948aCe6ee" ] } }, "parent": { "job": "officia ad anim", "task": "ut fugiat anim ea Ut", "iteration": -16384872.621806592, "element": -70769197.76026997 }, "errorHandler": { "actor": "$var.45.gzmb86JNS", "groups": [ { "_id": "c325c66a151fd73bc369048b", "provenance": "eu reprehenderit aute", "name": "in ut non", "description": "irure Lorem laborum", "memberOf": [ { "groupId": "155c621f2d13e7e3cc2eca8d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum exercitation sunt" }, { "roleId": "enim amet nulla" }, { "roleId": "magna aliquip incididunt culpa qui" } ], "inactive": false, "_meta": { "created": "1959-11-07T22:48:39.111Z", "updated": "1958-12-10T10:52:14.841Z", "migrationVersion": -28498133 } } ], "iterations": [ "d8A9E5D6-af66-a622-2137-7d5Ca64bDF3b", "9a1bD9d9-F28d-eA26-7fF0-1F9e1De1e623", "46d5e70c-A1C0-19Fb-c8D8-F206DcD4ef2F" ], "x": 71171498.21422917, "y": -16541375.535486758, "gridCoordinate": { "x": 95174870.5884184, "y": -61187656.111602485 }, "name": "laborum et adipisicing ut dolore", "location": "Broker", "locationType": "Ut do ea eu", "app": "Excepteur laborum officia labore", "canvasName": "aute", "displayName": "et deserunt eu proident", "summary": "tempor officia enim anim magna", "description": "in nulla laboris tempor consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/r4ezW/~0/~0/SbH34ebm/E+/~0" }, { "type": "encryption", "pointer": "/KtcQ/UxaUoL/XYn/~0/~1/~0/l0gQIT/pbuqGIv/~0" }, { "type": "encryption", "pointer": "/kj6Z,LT9rX/~1/X5H/~0/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "id nulla", "highlightString": "Ut fugiat dolore" }, { "key": "velit", "highlightString": "ut officia" }, { "key": "culpa ea est", "highlightString": "sint eiusmod" }, { "key": "in ipsum id proident", "highlightString": "mollit Duis qui" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "workflow_start", "e28f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end" ], "error": [ "error_handler", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "Excepteur minim occaecat in", "start_time": "1949-01-17T15:34:31.516Z", "end_time": 94228470.03270799, "finish_state": "failure", "retrySettings": { "state": [ "error", "success" ], "autoRetry": true, "limit": 55080010, "delay": 96789992, "count": 84362716, "finishedRetrying": true }, "type": "automatic" }, "groups": [ "b1b79e435ee8baea33ffa9f5", { "_id": "a94dee6a970ccad9b095c282", "provenance": "tempor", "name": "occaecat", "description": "in enim", "memberOf": [ { "groupId": "21c75100905ad0613213e25f", "aaaManaged": false }, { "groupId": "4a0edb1dd77b23eae33a3c59", "aaaManaged": false }, { "groupId": "5090a040e376fbf1dc68e42f", "aaaManaged": false }, { "groupId": "d5021c1acbd8430195733cb7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore in Excepteur minim" }, { "roleId": "consectetur ipsum dolore cillum nisi" }, { "roleId": "in fugiat Ut Lorem" }, { "roleId": "labore" }, { "roleId": "occaecat" } ], "inactive": false, "_meta": { "created": "1955-07-16T15:59:22.889Z", "updated": "1963-07-03T21:43:18.038Z", "migrationVersion": 42509596 } }, "d967963b5a5fdbcbef31b8a3" ], "watchers": [ null, null ], "metrics": { "start_time": -76293703.42663985, "progress": 0.7343402801213419, "end_time": 4649045.170830533, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }