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": "voluptate quis elit", "options": { "description": "Example job description", "type": "automation", "groups": [ "2bbeb82b43a938de0c67c1c3" ] } }
{ "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 imported 3 of 4 documents", "data": { "_id": "a8f9b429f74c5610cbfc76d1", "uuid": "212ac580-f681-e55d-837f-e0f4b55e6c65", "font_size": -78999683, "type": "resource:compliance", "created": "1976-03-01T10:45:21.452Z", "last_updated": "2018-07-15T19:56:25.357Z", "createdVersion": "647.2.77978433480-0502.3595.451.64", "lastUpdatedVersion": "667058739.0316757.958553", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -77038966, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -44756065.2412192, "sla": -81388363.46587266, "decorators": [ { "type": "encryption", "pointer": "/WT7pC/~1/~1/f/~0/~1/~0/~1/~0/~1" }, { "type": "encryption", "pointer": "/~1/om/~0/~1/bgEmNb/XuB6sFg/oVlmCZR" }, { "type": "encryption", "pointer": "/~0/wbq/~0/~1/~0/E6XKSV/~1/eWckB/~0/~0" } ], "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": "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_end", "name": "myCoolDocumentName", "message": "ex eiusmod sint commodo voluptate" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "esse dolor aliqua ipsum tempor" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "fugiat ullamco id", "instancePath": "tempor", "schemaPath": "labore elit", "message": "dolor anim Lorem occaecat incididunt" }, { "keyword": "magna", "instancePath": "amet velit", "schemaPath": "cupidatat tempor exercitation", "message": "aliquip" }, { "keyword": "adipisicing aute non", "instancePath": "est qui", "schemaPath": "eu et nostrud", "message": "sint occaecat non exercitation dolor" }, { "keyword": "irure Lorem laborum", "instancePath": "proident laborum do Duis", "schemaPath": "est ut", "message": "aute consectetur" } ], "created_by": { "_id": "b26f067a2eceb38609977d4a", "provenance": "officia", "username": "adipisicing minim in dolore amet", "firstname": "Ut", "memberOf": [ { "groupId": "060d3875a8acc1b2027e2c11", "aaaManaged": false }, { "groupId": "e9d4701d17160f8b91bbc4fe", "aaaManaged": false }, { "groupId": "3e4424f88944142fc4482675", "aaaManaged": true }, { "groupId": "f491ef9a9ab8e4675af5e7ef", "aaaManaged": true }, { "groupId": "80f000731ca65c61370c6e8c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est" } ], "inactive": false, "lastLogin": "2011-05-14T12:45:03.859Z", "_meta": { "created": "2008-04-02T16:12:20.228Z", "updated": "1972-03-19T01:00:28.022Z", "migrationVersion": 86770761 }, "email": "aliquip laboris aliqua exercitation" }, "last_updated_by": { "_id": "fa631a40723e77ff25a81ee4", "provenance": "commodo dolore culpa aliquip", "username": "est ut sint ipsum", "firstname": "velit mollit commodo nostrud", "memberOf": [ { "groupId": "221300998e78297eb0747fc5", "aaaManaged": false }, { "groupId": "5f443651c6630f0de0f094bb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat et fugiat voluptate nulla" }, { "roleId": "sint sit" } ], "inactive": false, "lastLogin": "2008-04-27T16:24:01.004Z", "_meta": { "created": "1967-09-07T02:01:25.599Z", "updated": "1989-08-16T09:57:33.817Z", "migrationVersion": -49136483 }, "email": "ullamco tempor in cupidatat commodo" }, "tasks": { "1": { "actor": "4fa0404b59e6a6f85d548b08", "groups": [ { "_id": "5ed96a57d3b0b87adb356e60", "provenance": "tempor", "name": "sint", "description": "nulla ea", "memberOf": [ { "groupId": "6745833fd65e16d9901a1b12", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex est nulla" }, { "roleId": "Excepteur aute" }, { "roleId": "in ut ad esse" }, { "roleId": "in consequat anim" }, { "roleId": "est" } ], "inactive": false, "_meta": { "created": "1984-02-29T18:06:25.397Z", "updated": "2007-02-16T10:01:44.058Z", "migrationVersion": -62935458 } }, "default", "default", "d2503eaf7b6a8599abb7e1e3" ], "iterations": [ "A8FbE777-B7CC-6F74-bCfF-8D85821eDc7E", "DFe45a02-F2E6-E916-a021-2E4F81969EAb", "32e9E56E-Bebe-cba3-4FAa-C247B4a9767c" ], "x": -20374114.795907736, "y": 57853749.55017316, "gridCoordinate": { "x": -63223119.80537436, "y": -84171888.84264317 }, "name": "sint aliquip commodo nulla", "location": "Broker", "locationType": "laborum ullamco qui", "app": "sed", "canvasName": "childJob", "displayName": "qui esse", "summary": "proident", "description": "Ut veniam consequat fugiat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/O14NC3XP3Wa/Bepr1q/GBSrOljZ/~0/TPe3FPM0kg/m" }, { "type": "encryption", "pointer": "/R.C.gajkO/~1/~0/K/Fnv+/Z,lKnD5PKs/~1/YZIVd/kY0aGv" }, { "type": "encryption", "pointer": "/oeKxd3/~0/QsjUGTz/QDdmcn/~1" }, { "type": "encryption", "pointer": "/~0/EWJY/u1/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "Ut et velit", "highlightString": "aliquip nisi aute Excepteur" }, { "key": "minim dolore est elit esse", "highlightString": "Ut" }, { "key": "pariatur eiusmod do", "highlightString": "sit magna dolore Excepteur occaecat" }, { "key": "enim consectetur mollit", "highlightString": "aliqua labore ex id nisi" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "3a1f", "workflow_start", "error_handler" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "error_handler", "workflow_start", "workflow_end", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" } ] }, "serverId": "et commodo", "start_time": "1970-09-21T07:26:00.818Z", "end_time": -86375039.9270236, "finish_state": "success", "retrySettings": { "state": [ "error", "error", "failure", "success" ], "autoRetry": false, "limit": 81261916, "delay": 65849030, "count": 7945113, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": 58747767.325504094, "outgoing": [] }, "childJobs": [ { "_id": "ex pariatur ut eu", "name": "commodo consequat", "iteration": 59250432.361634105 }, { "_id": "aute fugiat eiusmod enim proident", "name": "cupidatat eu", "iteration": -93195666.67584924 } ] }, "workflow_start": { "x": -96851056.06302042, "y": 59855449.24270719, "gridCoordinate": { "x": -3013095.6226068735, "y": -31968659.391400546 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -5748997.012877226, "finish_state": "success", "user": null }, "groups": [ { "_id": "1bbb583156cb114be22c784c", "provenance": "exercitation sit irure cillum", "name": "irure amet voluptate ullamco Duis", "description": "voluptate laborum", "memberOf": [ { "groupId": "e70355be68787c437282469c", "aaaManaged": false }, { "groupId": "a376b698534fd2d463dc5635", "aaaManaged": false }, { "groupId": "a30eb28a866d2c6aa01f732e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum deserunt" }, { "roleId": "sed tempor" }, { "roleId": "proident voluptate quis Lorem deserunt" }, { "roleId": "laboris deserunt velit" } ], "inactive": false, "_meta": { "created": "2002-06-15T10:14:28.23Z", "updated": "1967-04-13T10:58:34.768Z", "migrationVersion": -46951277 } }, "125f8197e13bab729f8bb7af" ], "iterations": [ "30eE6Ff0-bB1B-DcB4-f23f-9eF0a07C527F", "0AAFA791-9dcB-3Fb4-cCeb-910EE0D4bD0D", "53205C94-46dF-Bc28-Ff4e-42Be7B23EC15" ] }, "workflow_end": { "x": -3306165.74032709, "y": -32862571.860593766, "gridCoordinate": { "x": -26319682.188422754, "y": -87398663.90648738 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_start", "e28f" ], "complete": [ "workflow_end", "workflow_start", "3a1f", "3a1f" ], "error": [ "3a1f", "error_handler", "workflow_start", "workflow_end" ] }, "metrics": { "end_time": 40524341.959397376, "run_time": 88645292.90466368 }, "groups": [ { "_id": "21e8f121452bafc38dbe2748", "provenance": "quis velit", "name": "laborum officia Excepteur ut id", "description": "Excepteur Ut enim", "memberOf": [ { "groupId": "dc63555a294b45bf2c376442", "aaaManaged": true }, { "groupId": "82e395ab05983c587dacf634", "aaaManaged": false }, { "groupId": "ab8de9809d1defb11932049e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim in" }, { "roleId": "adipisicing dolor" }, { "roleId": "ad eu nulla" } ], "inactive": false, "_meta": { "created": "2001-01-06T14:53:55.611Z", "updated": "1959-09-02T01:09:43.371Z", "migrationVersion": 37340288 } }, { "_id": "3c460b847a2467e15b672724", "provenance": "amet fugiat aute Ut", "name": "minim sint occaecat incididunt aliqua", "description": "consequat voluptate est in nulla", "memberOf": [ { "groupId": "e5d778526f52a10f3c477419", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod occaecat enim" }, { "roleId": "est aliqua dolore fugiat" }, { "roleId": "eiusmod" }, { "roleId": "ut reprehenderit commodo consectetur" } ], "inactive": true, "_meta": { "created": "2009-05-04T03:38:15.34Z", "updated": "1983-01-28T09:02:47.61Z", "migrationVersion": 92322762 } }, { "_id": "6a00f355544c1c37e3ef7202", "provenance": "mollit ut voluptate qui enim", "name": "tempor esse", "description": "qui aliqua", "memberOf": [ { "groupId": "e29ed71d6dba68b406b13107", "aaaManaged": true }, { "groupId": "151a4e51f669cb85b28dca0c", "aaaManaged": false }, { "groupId": "513f1ba5f807bdc7108740fb", "aaaManaged": true }, { "groupId": "d31555af7b61ed364cebdb81", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui Ut officia aliqua consectetur" }, { "roleId": "occaecat sit est mollit culpa" }, { "roleId": "magna reprehenderit sed laborum" }, { "roleId": "adipisicing Lorem" } ], "inactive": true, "_meta": { "created": "1974-09-17T07:53:07.22Z", "updated": "1983-12-06T02:04:44.275Z", "migrationVersion": -19617384 } }, "6d209e4a2e470db29645f211" ], "iterations": [ "b2BD92aE-625B-fC0a-3b2d-Eadebe104a9D", "092eF792-0Df3-CEB4-Ef89-FE4fb25a129C", "D11c8C4c-FCaA-B4Fa-6dbE-a2fcB9Ad9D6a", "ec0Bd70d-9e6F-C11a-5DFd-66e2a9C2f41A" ] }, "error_handler": { "x": 82238925.55841249, "y": 6633209.310551494, "gridCoordinate": { "x": 51140038.14786169, "y": -1197313.584351927 }, "name": "childJob", "location": "Broker", "locationType": "veniam ut in cillum", "app": "et", "canvasName": "laborum laboris irure eiusmod", "displayName": "eiusmod", "summary": "do ea tempor", "description": "officia esse do", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/~1/jjFI1uzwxM/KIT37E/SclYnS3HwR6/ciadm/et-d/~0/ue,3RHdVbT/~0/ADJh6bZ/fgiFz4scabk" }, { "type": "encryption", "pointer": "/KiwSi/V0f/Iq,FWwF/PeEvs2dXHNR/~0/~0/Qf/M8fFdRxxz3" }, { "type": "encryption", "pointer": "/~1/~1/a/J/Ud8s/Dhc-0Wes/DQz9/~1/P6Q8+/~0/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "minim laborum enim in nisi", "highlightString": "sit eiusmod proident enim" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "e28f", "error_handler" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "workflow_start", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "revert" } ] }, "serverId": "dolore in ea tempor dolore", "start_time": "1999-08-18T08:55:49.459Z", "end_time": 52853191.32292035, "finish_state": "failure", "retrySettings": { "state": [ "success", "error", "failure", "success", "failure" ], "autoRetry": false, "limit": 79789091, "delay": 74186246, "count": 43642343, "finishedRetrying": false }, "type": "operation", "actor": "95aad38824109743eca78320", "groups": [ "default" ], "iterations": [ "b43c32C7-4Ae5-DA3e-0299-a725dC14c1FD", "31d013cd-beF3-dA63-8E0a-76a4aDEB8c87" ] } }, "parent": { "job": "do aliquip", "task": "anim", "iteration": 9195751.881810874, "element": -2406048.6895572245 }, "errorHandler": null, "groups": [ "5bff7a34fdf6477086ea5e59", { "_id": "aa86295a8109ebb3ab9dd21b", "provenance": "ullamco elit ut magna", "name": "deserunt", "description": "voluptate", "memberOf": [ { "groupId": "4cdbd8289573c6ee053b2ad7", "aaaManaged": true }, { "groupId": "7401e7a11d87056a83d91d9b", "aaaManaged": true }, { "groupId": "862e5ec3dc74384794d5bd82", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in do in et sunt" } ], "inactive": false, "_meta": { "created": "2005-09-23T19:52:59.786Z", "updated": "1955-09-19T08:27:57.035Z", "migrationVersion": 6814817 } }, { "_id": "602d6e575ae8e57fdf131739", "provenance": "non aliquip consectetur", "name": "esse", "description": "ut", "memberOf": [ { "groupId": "d57128b1ec3948a5ea7e5734", "aaaManaged": false }, { "groupId": "dff88f79b5952b391c061735", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu ut in" }, { "roleId": "ex in" }, { "roleId": "deserunt incididunt proident Excepteur nulla" } ], "inactive": false, "_meta": { "created": "2025-06-07T02:22:12.297Z", "updated": "2011-11-26T17:02:24.007Z", "migrationVersion": 82777161 } } ], "watchers": [ "Pronghorn", null, null, "Pronghorn" ], "metrics": { "start_time": 89747070.03599125, "progress": 0.7287471312241345, "end_time": -16773721.304776192, "user": "0a2157df677dbb282bacc037", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }