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": "do ipsum elit", "options": { "description": "Example job description", "type": "automation", "groups": [ "a8e7635a3ee28abff6693b54", "3d7b85a3174eb8726a006059", "fd584db814ffecac54990ad0" ] } }
{ "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": "6ca297ecef2e3c4e6f3debac", "font_size": -18244600, "type": "automation", "created": "1966-10-22T03:45:39.205Z", "last_updated": "1970-07-23T05:20:59.431Z", "createdVersion": "582.7.79", "lastUpdatedVersion": "10.865.90067132635", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -21558163, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 72722605.98836437, "sla": -23927098.07836461, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1" }, { "type": "encryption", "pointer": "/a5NFtWpug83/~1/DYH49t/~1/zDM1oZScv/L/iH/~0/BH/~0/~0" }, { "type": "encryption", "pointer": "/~0/kS8k1/b8ukz/MPu/XotePsn/f6,7UEUW/~0/krqp26Gw9iK/eBJ2eP/AN" }, { "type": "encryption", "pointer": "/~0/~1/~1/~1/FVl1UV/~0/~0/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0/~1/r5d8cHDcM" } ], "status": "paused", "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": "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": "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": "eu dolor veniam anim proident" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "sit Excepteur ut nostrud" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": [ "7817a80627a735c504770679", "a2b8ad1ebad87a2a4f48335d", "d5d0e209ae46942d654ffb16" ], "validationErrors": [ { "keyword": "laboris", "dataPath": "aute cupidatat est in", "schemaPath": "cillum", "message": "ullamco incididunt" }, { "keyword": "aliqua nostrud", "dataPath": "ut commodo", "schemaPath": "sit sed velit", "message": "ipsum do" }, { "keyword": "aute eu mollit", "dataPath": "magna laborum nisi consequat", "schemaPath": "do nisi Duis dolore occaecat", "message": "reprehenderit dolor mollit" }, { "keyword": "nostrud Lorem aute sit", "dataPath": "veniam", "schemaPath": "mollit", "message": "fugiat" } ], "created_by": null, "last_updated_by": null, "tasks": { "workflow_start": { "x": 91068734.69071099, "y": -65898871.30854413, "gridCoordinate": { "x": -72690502.41980213, "y": 84174207.17932561 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -54357479.235133745, "finish_state": "failure", "user": "6893f8841b72a1690911a23e" }, "groups": [ "5d721eb5a49b4c23b8c2152f", "6edc13f82503b031137975ed", { "_id": "cee129ddf8b1db743f5947eb", "provenance": "dolor in est voluptate", "name": "Duis laborum in adipisicing", "description": "commodo in velit", "memberOf": [ { "groupId": "dd19bd708474fcf0fa5b0cfd", "aaaManaged": false }, { "groupId": "054392d2bb120b980b725676", "aaaManaged": true }, { "groupId": "62fa21f72984eac5903c4810", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum in in" }, { "roleId": "Excepteur" }, { "roleId": "aute" }, { "roleId": "eu labore quis" } ], "inactive": true, "_meta": { "created": "1972-07-13T10:49:25.475Z", "updated": "1971-12-25T10:29:30.223Z", "migrationVersion": -46178478 } } ], "iterations": [ "B8a12519-e8aD-ece6-B0fd-C57c49aaCc2b" ] }, "workflow_end": { "x": -86921063.03578404, "y": -20603488.018534094, "gridCoordinate": { "x": 99913559.59859565, "y": 13099362.22706303 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "error_handler" ], "complete": [ "workflow_end", "workflow_end", "e28f", "workflow_start" ], "error": [ "workflow_start", "e28f", "workflow_end", "workflow_end", "workflow_start" ] }, "metrics": { "end_time": -16157121.24163942, "run_time": -63981113.28100957 }, "groups": [ "default", "c4cc60c3f3e2dd2ad23db44e", { "_id": "20ab781dd00e28e891e05cd4", "provenance": "Duis aliqua Lorem", "name": "ad officia anim non", "description": "laboris in dolor", "memberOf": [ { "groupId": "4c2a073fc4731ce116b702ca", "aaaManaged": true }, { "groupId": "6ec15bc3a3ef1e247bee3015", "aaaManaged": true }, { "groupId": "404ff14417581332f29f95d8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit deserunt" }, { "roleId": "dolor" }, { "roleId": "commodo" }, { "roleId": "adipisicing nulla eu pariatur esse" }, { "roleId": "quis Ut dolore ad" } ], "inactive": true, "_meta": { "created": "1947-03-13T06:32:43.309Z", "updated": "2010-07-20T04:56:39.152Z", "migrationVersion": 36263165 } } ], "iterations": [ "34FFebCB-bEBC-7F8E-6dd3-C04Da3e1Bf40" ] }, "error_handler": { "x": 63192791.119211346, "y": 19922383.979447395, "gridCoordinate": { "x": 43687568.22998336, "y": 42205316.786500424 }, "name": "childJob", "location": "Adapter", "locationType": "sunt", "app": "reprehenderit eu aute pariatur tempor", "canvasName": "voluptate sit labore incididunt", "displayName": "incididunt laborum voluptate", "summary": "minim", "description": "irure", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/y/~0/~0/i4JdJmV8D+,/XAgN2mf/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "nulla aliquip mollit dolore", "highlightString": "magna aute dolore sit" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_start", "error_handler", "error_handler" ], "error": [ "workflow_start", "3a1f", "workflow_end", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "laborum aute consectetur Excepteur", "start_time": "1977-12-31T23:23:10.692Z", "end_time": -90602959.86079799, "finish_state": "success", "retrySettings": { "state": [ "error", "success" ], "autoRetry": false, "limit": 20298771, "delay": 80105466, "count": 21340177, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ "default", "default" ], "iterations": [ "CC0E10FD-Ab6F-Fe70-76A8-Ee13185EE8f8", "EBd8f412-FDAc-dAEc-F4Df-F08E883B0d2C" ] }, "b0": { "actor": "job", "groups": [ "7bc7beef27ba3580ca282efa", { "_id": "fc96870b9fb225bbe662384d", "provenance": "proident anim laboris elit", "name": "ut magna ea nostrud sunt", "description": "ipsum consequat in id incididunt", "memberOf": [ { "groupId": "d55b1a471e1beadd5c842f16", "aaaManaged": true }, { "groupId": "96a19be6011517fd441186ac", "aaaManaged": true }, { "groupId": "e237913f390f2b21cedd141c", "aaaManaged": false }, { "groupId": "56b5506153a179aba1fa3c25", "aaaManaged": true }, { "groupId": "04e0f9465d40aae4bc3c22c3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat ipsum non dolore" }, { "roleId": "deserunt est in" }, { "roleId": "Ut dolore Lorem culpa consectetur" }, { "roleId": "adipisicing occaecat sint aute" }, { "roleId": "commodo ut in nostrud dolore" } ], "inactive": false, "_meta": { "created": "1963-11-03T19:29:14.869Z", "updated": "1992-03-30T20:09:36.17Z", "migrationVersion": 52415191 } }, "default", "48e90f1a451f4ac4dfb0203d" ], "iterations": [ "735cbe38-FBa8-1B40-1CDc-5e69dDA4b7fe", "a56fbF02-8c92-b2Ab-6f0b-bCDa94aEE54E", "Fd4dD102-aACA-DFd8-9ddE-48a2a2cAD3EA" ], "x": -59729010.73095809, "y": 58055631.0972209, "gridCoordinate": { "x": -78646087.09184489, "y": 90374919.99477983 }, "name": "Ut sit pariatur do", "location": "Adapter", "locationType": null, "app": "in sit minim nisi", "canvasName": "in enim irure veniam consectetur", "displayName": "eu exercitation", "summary": "magna labore consequat aliquip irure", "description": "nostrud magna", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/s/x8Hb3+T6/j/~1/~0/~1/wVt/E3x.O5S57" }, { "type": "encryption", "pointer": "/~0/~0/~1/~1/~1/~1" }, { "type": "encryption", "pointer": "/ABp-qQ268H/FRIG2G4" }, { "type": "encryption", "pointer": "/~0/QAmORSM/PE7g-kR/VncdfHR/YU79eC/zbjh/kz//~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "Excepteur ut eu", "highlightString": "adipisicing quis officia" }, { "key": "voluptate ea aliqua tempor", "highlightString": "quis irure" }, { "key": "ullamco", "highlightString": "pariatur ut" } ], "status": "error", "previous": { "incomplete": [ "e28f", "3a1f" ], "complete": [ "error_handler", "workflow_start" ], "error": [ "3a1f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "standard" } ] }, "serverId": "exercitation adipisicing est fugiat", "start_time": "1992-06-15T17:30:55.694Z", "end_time": 16712064.011980444, "finish_state": "failure", "retrySettings": { "state": [ "success", "error", "failure", "failure", "success" ], "autoRetry": false, "limit": 47850635, "delay": 23911046, "count": 91868811, "finishedRetrying": false }, "type": "manual", "view": "Ut exercitation veniam" } }, "parent": { "task": "voluptate", "iteration": 69652023.6342952, "element": 48096137.25813064 }, "errorHandler": { "actor": "job", "groups": [ "06a39cacdde0b90ffeca1ab4", "2d5866eebdafcdfe3334f114", "default", "default", "2363bfb3660488f17f05d103" ], "iterations": [ "d6BFb4BF-95f0-3e7B-7C5F-e03EFB87dd8C", "5d5fdC88-26FE-bE5B-CAec-2cdCC4CBD973" ], "x": 81431685.92960528, "y": -50401117.912566476, "gridCoordinate": { "x": -53804898.90663571, "y": -72292037.17559871 }, "name": "do", "location": "Application", "locationType": "reprehenderit do dolore ad proident", "app": "laborum", "canvasName": "sunt", "displayName": "occaecat cillum reprehenderit ipsum incididunt", "summary": "deserunt et", "description": "do anim sed laboris non", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/oh8.-Yxpxg0/s+bL3Jak/GKNv/~1/~1/J5FQgm3d/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "irure minim tempor", "highlightString": "amet dolor reprehenderit incididunt" }, { "key": "et", "highlightString": "Duis aute dolore" }, { "key": "Duis dolor nostrud", "highlightString": "sit nulla esse irure laborum" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler", "workflow_end" ], "complete": [ "workflow_end", "e28f", "workflow_end", "workflow_end" ], "error": [ "error_handler", "workflow_end", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "tempor proident cillum cupidatat", "start_time": "2014-01-03T12:20:19.433Z", "end_time": 68671954.55606553, "finish_state": "failure", "retrySettings": null, "type": "manual", "view": "deserunt et elit dolor occaecat" }, "groups": [ { "_id": "b5747c2bfd0bd413d3d90bd5", "provenance": "non aliqua ex ut", "name": "pariatur voluptate eu culpa", "description": "ut", "memberOf": [ { "groupId": "5358965943d858b6eb984e14", "aaaManaged": false }, { "groupId": "2b1da0a08847e5aeab0869b6", "aaaManaged": true }, { "groupId": "46ae904dba8a474230f7e319", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco dolore Duis" }, { "roleId": "Excepteur consequat ex ut deserunt" }, { "roleId": "in minim sunt" }, { "roleId": "deserunt dolore nostrud ut voluptate" } ], "inactive": false, "_meta": { "created": "2018-09-27T11:46:16.862Z", "updated": "2009-05-16T11:27:16.051Z", "migrationVersion": -59127735 } } ], "watchers": [ null, "9d333651f884a0fa31cea85e" ], "metrics": { "start_time": -72143615.38781127, "progress": 0.21435262999407434, "end_time": -99088404.67011522, "user": "e788b4c91ab457dfd39992f3", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }