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": "ut cupidatat", "options": { "description": "Example job description", "type": "automation", "groups": [ "b78318244ec71f76c2078376", "6a27f4a9b8eba20b70692249", "4c622088d84a5a54c6acd583", "922bcd1097a276f37ac175b1", "1df26edadff3d00475b54e3a" ] } }
{ "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": "fb1cb18ba587d92f43050e59", "font_size": 93686831, "type": "resource:compliance", "created": "1978-11-28T01:57:31.765Z", "last_updated": "1969-05-13T05:22:35.61Z", "createdVersion": "91.12.974-9377.20.050121.6885408559", "lastUpdatedVersion": "2.6309053732.9012", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -83931327, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 77697301.80872455, "sla": -98500293.83397536, "decorators": [ { "type": "encryption", "pointer": "/HWQbf7EG" } ], "status": "complete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "officia quis labore in" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "enim dolor sunt" } ], "ancestors": null, "validationErrors": [ { "keyword": "dolore qui", "instancePath": "culpa tempor voluptate laborum consequat", "schemaPath": "sint", "message": "sed laborum culpa eu ipsum" }, { "keyword": "mollit deserunt velit culpa ipsum", "instancePath": "adipisicing consequat", "schemaPath": "cupidatat et sint", "message": "dolore occaecat culpa in laboris" }, { "keyword": "sunt", "instancePath": "adipisicing commodo", "schemaPath": "ea", "message": "Excepteur" }, { "keyword": "officia ea nostrud anim culpa", "instancePath": "non id velit esse", "schemaPath": "amet id ad", "message": "Duis tempor" } ], "created_by": "3ef5755c34265ef22ebd96c7", "last_updated_by": "d8d4d2bfc35267e68a2cece3", "tasks": { "workflow_start": { "x": -73413936.22049814, "y": 96166690.67139089, "gridCoordinate": { "x": -44983006.899033114, "y": -24706576.179405987 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -16844104.777305484, "finish_state": "error", "user": "0dfbf68ef987ff21cc6cc26b" }, "groups": [ { "_id": "5b1bd4fb7927ccc43eab554e", "provenance": "aliqua ut", "name": "ut eu", "description": "incididunt amet", "memberOf": [ { "groupId": "544f2d2390a93ed722f4438a", "aaaManaged": true }, { "groupId": "ab51c461c46e1d62f4fad92c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "occaecat Excepteur ea Duis" }, { "roleId": "culpa dolor proident" }, { "roleId": "ullamco veniam irure" }, { "roleId": "ipsum ut ullamco eiusmod" }, { "roleId": "in" } ], "inactive": false, "_meta": { "created": "1987-06-06T03:02:21.562Z", "updated": "2022-03-04T12:32:03.165Z", "migrationVersion": -91456495 } } ], "iterations": [ "95E63c50-Da7b-761b-9eba-A5B403Fb47bE", "3Ce45DfF-feC9-16d8-fCfb-A5264A65eDdE" ] }, "workflow_end": { "x": -60815211.03009884, "y": -67347891.0330473, "gridCoordinate": { "x": 24447443.344098836, "y": 44941885.86209279 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f" ], "complete": [ "e28f" ], "error": [ "3a1f", "workflow_start", "workflow_end", "3a1f", "workflow_end" ] }, "metrics": { "end_time": -45034058.08453276, "run_time": 23723240.742641896 }, "groups": [ "default", "default", "b353a8095e5cf4b4c846efa4" ], "iterations": [ "BE79cDea-4ddb-7FAB-D2cc-9e26BBA3E51c" ] }, "error_handler": { "x": 44534216.85772011, "y": -74356927.05773559, "gridCoordinate": { "x": -7419086.507047147, "y": 46880266.56147683 }, "name": "childJob", "location": "Adapter", "locationType": "in amet", "app": "consequat elit", "canvasName": "anim consequat", "displayName": "Ut eu magna enim est", "summary": "nisi aliquip fugiat mollit", "description": "ut officia nisi cupidatat qui", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/cKAYgC/JeG/nce6mu/~1/FcRb2jnj/~0/~1" }, { "type": "encryption", "pointer": "/D+Ts6a/Enc1dKSQ/ze09z6iPT7/DBd/qgl,2,us" }, { "type": "encryption", "pointer": "/~0/~1/Z,tcL" }, { "type": "encryption", "pointer": "/zwUUJetNpO2/VnXSE/~0" }, { "type": "encryption", "pointer": "/mQuMk/W/HJ/CrgK,syl9/M.FMFy/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "in", "highlightString": "ex est dolor aliqua" }, { "key": "officia non occaecat fugiat sed", "highlightString": "elit" }, { "key": "tempor et Excepteur", "highlightString": "nisi ad Duis" }, { "key": "dolor occaecat anim adipisicing minim", "highlightString": "sed enim non id amet" }, { "key": "deserunt nostrud", "highlightString": "in proident" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "workflow_end", "3a1f", "workflow_start", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "voluptate Duis velit in", "start_time": "2005-10-10T17:06:40.242Z", "end_time": -74847265.29962918, "finish_state": "error", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 82656610, "delay": 52979531, "count": 4493350, "finishedRetrying": false }, "type": "operation", "actor": "2b52f80c51703de7ee1a8cf7", "groups": [ { "_id": "486bf2ab8bd1eb8bb885610c", "provenance": "irure ad", "name": "laborum Duis quis", "description": "est anim minim ut irure", "memberOf": [ { "groupId": "f9575da56d12b8bb4d28528f", "aaaManaged": true }, { "groupId": "9911d633b38f0673d48681bc", "aaaManaged": true }, { "groupId": "17e9219720b8bde823b74a1d", "aaaManaged": false }, { "groupId": "17d23b5ae68dadd6f3c8a795", "aaaManaged": true }, { "groupId": "05a744599ed84d7268a06b0e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit do" }, { "roleId": "cillum mollit voluptate veniam commodo" }, { "roleId": "mollit in aliquip tempor" } ], "inactive": true, "_meta": { "created": "1998-04-09T09:05:44.935Z", "updated": "1968-08-28T23:58:07.604Z", "migrationVersion": 56593952 } }, { "_id": "cc6fd3813a8ae505a692f82c", "provenance": "Excepteur", "name": "aliquip elit", "description": "sint amet voluptate dolor deserunt", "memberOf": [ { "groupId": "f19690b3aacd06c3dbf6eac2", "aaaManaged": false }, { "groupId": "ce2030d141688983eb96db66", "aaaManaged": false }, { "groupId": "b246075abee2d4d5c75be320", "aaaManaged": false }, { "groupId": "304ed819461f69676d8d65d5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "commodo dolor" }, { "roleId": "eu dolor sint aliquip Duis" }, { "roleId": "aliquip Lorem velit" }, { "roleId": "ea elit ut" }, { "roleId": "est" } ], "inactive": true, "_meta": { "created": "1988-06-23T05:52:20.063Z", "updated": "1960-09-09T01:32:50.318Z", "migrationVersion": -91374665 } }, "e3b3cc0de21c5118aa9247c5", "e9eb1dab3d65219b2f03b863", "default" ], "iterations": [ "d9de2bB2-a339-Ced8-f4cF-f86bec47661a" ] }, "db5": { "actor": "Pronghorn", "groups": [ "c1ea429d5464871813983c1c", "default", { "_id": "d497e7cdea2a276bef7b7ba8", "provenance": "consectetur cupidatat pariatur occaecat aute", "name": "elit ad enim", "description": "ut mollit consectetur", "memberOf": [ { "groupId": "7137a21c0ed3e734103525bb", "aaaManaged": true }, { "groupId": "a8115e4b90156fe5eca59a6b", "aaaManaged": true }, { "groupId": "2937cbb177ab151ae89ee6d5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id sit minim culpa est" }, { "roleId": "adipisicing irure" }, { "roleId": "ex est sint eu" } ], "inactive": true, "_meta": { "created": "1950-01-15T15:06:14.162Z", "updated": "1977-08-16T02:53:43.04Z", "migrationVersion": -76511373 } }, "default" ], "iterations": [], "x": -60066447.901272066, "y": -98825415.6266859, "gridCoordinate": { "x": -88677334.28894429, "y": -19102270.0869627 }, "name": "pending", "summary": "Excepteur in ut anim consequat", "description": "esse qui" } }, "parent": { "task": "et sed exercitation eiusmod", "iteration": 61283889.37624657, "element": -18817992.2951293 }, "errorHandler": { "actor": "aa76b235d9d279d5eccb61e3", "groups": [ "default", "default", { "_id": "f36f25834925c9cf4111fde9", "provenance": "dolor", "name": "quis sit tempor", "description": "consectetur", "memberOf": [ { "groupId": "6135eef31408ceab37387dc1", "aaaManaged": true }, { "groupId": "6d2fc8f684d4d1fc164b2d9b", "aaaManaged": false }, { "groupId": "62e21b81e6bbe42f2e1f573e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur est eiusmod ut ut" }, { "roleId": "dolor et eiusmod cillum" } ], "inactive": true, "_meta": { "created": "1979-07-17T03:18:04.548Z", "updated": "2025-01-05T02:01:14.408Z", "migrationVersion": 18676610 } }, "3605f6098c2ff4de717e917d" ], "iterations": [ "cCf62C7b-9811-57A3-Ff73-9CcE0672CF6B", "289A64bd-F8Fe-b89B-3860-5ACAfCdd00BA" ], "x": -89551498.45892301, "y": -47241833.08878445, "gridCoordinate": { "x": 35752991.07198018, "y": -77040326.9485521 }, "name": "pending", "summary": "eu magna velit anim", "description": "ex exercitation" }, "groups": [ { "_id": "b605ede8b06f9f457bfdda8f", "provenance": "enim", "name": "ut occaecat commodo pariatur exercitation", "description": "eu in et consequat", "memberOf": [ { "groupId": "b26c85c3b87ce0f777b195be", "aaaManaged": true }, { "groupId": "a1d04eadaa9b5dfde4d1408c", "aaaManaged": true }, { "groupId": "232f22f8d75078bcc7565162", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id occaecat" }, { "roleId": "tempor sint" }, { "roleId": "pariatur dolor ut" } ], "inactive": true, "_meta": { "created": "2001-12-08T14:51:43.515Z", "updated": "2014-12-01T14:18:25.319Z", "migrationVersion": 48611089 } }, "d1384b652aac15d760f0bd4a", "default" ], "watchers": [ null, null, { "_id": "d89e483982900ef20378bb68", "provenance": "sed dolore ullamco qui", "username": "nulla enim ut dolore", "firstname": "occaecat sint", "memberOf": [ { "groupId": "c9d8318e9d9ca2105f065593", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor" } ], "inactive": true, "lastLogin": "1955-09-08T23:07:47.254Z", "_meta": { "created": "1954-07-08T20:14:10.021Z", "updated": "1948-06-07T15:15:26.271Z", "migrationVersion": 51743157 }, "email": "anim exercitation" } ], "metrics": { "start_time": 76825150.14723435, "progress": 0.13708816215836728, "end_time": 19703004.954776928, "user": { "_id": "fa747455f6b33ba2a90bc3c3", "provenance": "id sed adipisicing laboris minim", "username": "sed in cillum reprehenderit", "firstname": "dolore culpa", "memberOf": [ { "groupId": "56840748957fda1d17773144", "aaaManaged": true }, { "groupId": "96f1e715ce9d1eea87c3bed0", "aaaManaged": false }, { "groupId": "e3b7ef1d6a382e39286a1e5f", "aaaManaged": true }, { "groupId": "8b2ee618117d061199019d20", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor reprehenderit magna" }, { "roleId": "irure" }, { "roleId": "cillum" }, { "roleId": "ad" }, { "roleId": "id Excepteur fugiat sint ipsum" } ], "inactive": true, "lastLogin": "2017-11-27T14:10:33.48Z", "_meta": { "created": "1996-10-23T09:03:41.665Z", "updated": "1996-12-22T02:39:17.428Z", "migrationVersion": 52774864 }, "email": "commodo" }, "owner": { "_id": "a460885540a12822f5656cc6", "provenance": "occaecat culpa eiusmod proident deserunt", "username": "cillum consequat in qui", "firstname": "ut reprehenderit dolore velit nostrud", "memberOf": [ { "groupId": "fb5951b6d2b537e760b4de4e", "aaaManaged": true }, { "groupId": "f8858db93365c4240bbb4fce", "aaaManaged": true }, { "groupId": "b9fb616a6dfba142b6f9a492", "aaaManaged": true }, { "groupId": "8aebd0b70694e908da38af3f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed deserunt" }, { "roleId": "irure" }, { "roleId": "reprehenderit enim" }, { "roleId": "sit incididunt" }, { "roleId": "laboris dolor" } ], "inactive": true, "lastLogin": "1980-03-21T07:22:50.635Z", "_meta": { "created": "2009-06-28T07:45:00.367Z", "updated": "1985-11-10T16:13:36.56Z", "migrationVersion": -62444380 }, "email": "irure" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }