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": [ "530eee6897b6bbbf6adb9366", "545fc852b81206eb6390c1e0" ] } }
{ "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": "7e18e838bff5696c13ecd23d", "font_size": 12429234, "type": "automation", "created": "1953-12-01T16:34:47.942Z", "last_updated": "1948-11-22T06:30:21.399Z", "createdVersion": "2.57309.83133028322-2374.377421.3228560021", "lastUpdatedVersion": "12176.3579387.24-0390.85926551.56744742814", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -76192890, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 51078097.78391981, "sla": -52982404.0914725, "decorators": [ { "type": "encryption", "pointer": "/~0/Cv82OBo/~1/X5rm3/HIr" }, { "type": "encryption", "pointer": "/~0/FSneGy51DM" }, { "type": "encryption", "pointer": "/~0/Z3m9pmQ/~0/~1/d/dQwBNf9g/Tgo,Gb-EM" }, { "type": "encryption", "pointer": "/~1/~0/Vd-T/LW3-/~1/~0/CTA6Csxgr-/B1c+BJdekp/OUi/WcX.t" } ], "status": "incomplete", "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": "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "voluptate sint incididunt veniam" } ], "ancestors": null, "validationErrors": [ { "keyword": "sit", "instancePath": "minim do", "schemaPath": "culpa sint eu sed dolor", "message": "minim sunt Duis do" }, { "keyword": "Lorem laboris sint adipisicing", "instancePath": "esse dolore id fugiat", "schemaPath": "nostrud", "message": "ea officia" }, { "keyword": "aliquip ut", "instancePath": "proident incididunt anim in sint", "schemaPath": "dolore esse Excepteur magna", "message": "magna irure ex dolore" } ], "created_by": null, "last_updated_by": "79b9b0927d9fa6997d9c7e10", "tasks": { "6": { "actor": "job", "groups": [ "4fcf8e9f207e171b7ce7f806" ], "iterations": [ "4dfCCA63-Af83-B1e3-7b98-2a0FCe34cfCD", "Cc752dFa-AbAE-e9a8-6CE0-Cbd89Fce11A5", "5B863817-e3df-cfAF-8F6c-6E3ed075ED8C" ], "x": -61107289.174893565, "y": 11193099.965070903, "gridCoordinate": { "x": 40558355.85962421, "y": 20956979.770473883 }, "name": "Excepteur minim", "location": "Broker", "locationType": null, "app": "amet ut", "canvasName": "cillum mollit reprehenderit nostrud", "displayName": "in amet", "summary": "velit sit dolore sunt sed", "description": "velit magna", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ex sint", "highlightString": "magna" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "workflow_start", "error_handler", "workflow_start" ], "complete": [ "error_handler", "workflow_start", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" } ] }, "serverId": "laboris officia", "start_time": "1954-09-02T13:50:05.432Z", "end_time": 2677799.4384848326, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "workflow_start": { "x": 62398970.20128703, "y": 12599892.296452671, "gridCoordinate": { "x": -57847804.87182761, "y": -38141560.33295135 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 90377939.63978586, "finish_state": "failure", "user": "2d8a2d8a9496f882a2ada8bb" }, "groups": [ "6fc3ed7d7ac043ed8cc7c289", "97cebb64486f9e65cc426931", "default" ], "iterations": [ "BC37F527-3b87-f2f5-9D91-5b05EfCeE1d3" ] }, "workflow_end": { "x": -43823902.484189816, "y": -19349601.956198767, "gridCoordinate": { "x": 5492438.618172452, "y": -42471890.35089054 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "workflow_start", "workflow_end" ], "complete": [ "e28f", "workflow_start", "3a1f", "workflow_start", "workflow_start" ], "error": [ "error_handler" ] }, "metrics": { "end_time": -26452067.93810959, "run_time": 65324490.35603386 }, "groups": [ "9298f1567864f48c66a12cd9", { "_id": "b6e72322cf8f476d95303504", "provenance": "aute voluptate consequat in ex", "name": "ipsum tempor fugiat ea", "description": "irure veniam cupidatat cillum consectetur", "memberOf": [ { "groupId": "08a6bb24f7da40dcc1b211a9", "aaaManaged": true }, { "groupId": "a6f1fd7485415ad263319e51", "aaaManaged": true }, { "groupId": "664e16ef71eb0a90cfa72350", "aaaManaged": true }, { "groupId": "f5852d57f0d4930d7aaadd2b", "aaaManaged": true }, { "groupId": "202b9f4c838efc67c13a0822", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation" }, { "roleId": "incididunt" } ], "inactive": false, "_meta": { "created": "1993-11-29T16:05:33.484Z", "updated": "1956-05-23T02:22:42.989Z", "migrationVersion": -31385782 } }, "default", { "_id": "b9e7e5aeeee61f50c564630c", "provenance": "fugiat est commodo in", "name": "magna sit nostrud", "description": "sunt non", "memberOf": [ { "groupId": "16ef840d3b8ad4aff8370a1c", "aaaManaged": false }, { "groupId": "927ede8179604ea18d425277", "aaaManaged": true }, { "groupId": "b1c500492d74f7e3f44bf1b2", "aaaManaged": true }, { "groupId": "b0ad127db49562b3b44eb48e", "aaaManaged": true }, { "groupId": "7d91d38aae547e3c51815f2a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip quis ex ea" }, { "roleId": "occaecat irure veniam adipisicing" } ], "inactive": true, "_meta": { "created": "1962-04-29T10:03:36.169Z", "updated": "1998-11-24T01:06:45.746Z", "migrationVersion": -92979754 } }, "890c22eb0fedf43ec0a53f37" ], "iterations": [ "eF5CA3f5-3fDf-E9e3-3F3C-CafCcFdBBDa8", "66CE0Ed6-Ea41-5c17-Faf8-fAc53Baf58Fc" ] }, "error_handler": { "x": 33188507.114112347, "y": 46682802.53962526, "gridCoordinate": { "x": -11631581.50421162, "y": 59031488.0507952 }, "name": "childJob", "location": "Adapter", "locationType": "in irure Lorem tempor do", "app": "eu Duis ad do", "canvasName": "enim esse", "displayName": "in laboris sint ut", "summary": "incididunt", "description": "voluptate sit quis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/~0/h2be/uLjmfCVR/~1/nOCMU/~1/OiC/uOKQ7pGZL9" }, { "type": "encryption", "pointer": "/H3F,6MPJ/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ullamco ipsum voluptate sed", "highlightString": "ad ipsum culpa irure minim" }, { "key": "enim", "highlightString": "proident tempor quis" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "3a1f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end", "workflow_end", "workflow_end" ], "error": [ "workflow_start", "e28f", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "do Lorem", "start_time": "2023-11-15T19:02:26.696Z", "end_time": -55022558.43283441, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "06284e5b797e1518d467d9ce", "provenance": "adipisicing", "name": "nulla minim", "description": "ut anim laborum", "memberOf": [ { "groupId": "f7518f576c57d4ea3d384d40", "aaaManaged": true }, { "groupId": "4ce634a32d021dd21035e8f0", "aaaManaged": true }, { "groupId": "283c26a051a139afdda868f1", "aaaManaged": false }, { "groupId": "cd5c507821d8e306cbeb9b2d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa velit" }, { "roleId": "veniam mollit sit" }, { "roleId": "pariatur dolor" }, { "roleId": "anim nostrud" } ], "inactive": true, "_meta": { "created": "1968-07-12T14:14:47.063Z", "updated": "1951-01-01T18:19:21.617Z", "migrationVersion": 881190 } }, "default", "c7562c336f7a7d86108568a4" ], "iterations": [ "Ed0b409d-52c1-Af97-6AD6-16b58ecBAcb5" ] } }, "parent": { "task": "enim voluptate laborum reprehenderit anim", "iteration": -90634604.76505445, "element": -33489193.654581048 }, "errorHandler": { "actor": "job", "groups": [ "default", "db7972b5275d34793f10c85f", "default" ], "iterations": [ "B9bd86eA-04cD-A0b1-631B-f4f1B39AFcaA", "Eb7ed5D1-E8c1-49AC-A9A7-2d71c64b6Fea", "1B8d766C-171E-3AF8-c401-1Ba2df1AEEE8" ], "x": 81052629.6553005, "y": 12157910.648726046, "gridCoordinate": { "x": 51734148.85481766, "y": 6737031.535936341 }, "name": "culpa minim ipsum", "location": "Broker", "locationType": null, "app": "ullamco", "canvasName": "do ut dolor cillum officia", "displayName": "id Duis aliquip mollit", "summary": "esse reprehenderit elit tempor officia", "description": "deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/j2wLgXdBaDu/~1/~1/c9uqGK/~1/~1/yBqCUY/FlzmyI.ce9-/gwvlWnkPu" }, { "type": "encryption", "pointer": "/SEBIiTxSg.9/~1/~0/~0/~0/izHth/LX/~0/~0/a-w" }, { "type": "encryption", "pointer": "/~0/~0/U,cuNSTDax/r/A+S4645/JMohI/w/j" }, { "type": "encryption", "pointer": "/sBSl3J/~1/~0/z0KpD/x5I8J28CF7Q/YI734Gw/~1/P-FmaVn" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "labore pariatur", "highlightString": "anim ea nostrud cupidatat aute" }, { "key": "do occaecat reprehenderit magna nostrud", "highlightString": "esse id exercitation" }, { "key": "ex", "highlightString": "culpa aliqua" }, { "key": "ut", "highlightString": "magna" } ], "status": "complete", "previous": { "incomplete": [ "error_handler", "workflow_start", "e28f", "e28f", "workflow_end" ], "complete": [ "workflow_start" ], "error": [ "e28f", "e28f", "error_handler", "e28f", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "eu Lorem tempor", "start_time": "1955-03-17T13:22:34.426Z", "end_time": 46478592.2052359, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "groups": [ "2fc2984d10d2191a2a2b3c15", "default", "default" ], "watchers": [ null ], "metrics": { "start_time": 6265125.65763621, "progress": 0.6135688047360313, "end_time": 97545316.29048583, "user": null, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }