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": "sit", "options": { "description": "Example job description", "type": "automation", "groups": [ "1406ec1c737d820b7fc636cc", "5d6801b0e6670fc5ddcf2590", "32f51ad8d3d38af28190e6a2", "5bf20cee30cbc89bd53e9023", "f050cbcb718399bc8c2cfad7" ] } }
{ "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": "f54381255397f46967cd62ff", "font_size": 2124321, "type": "resource:action", "created": "1982-03-08T13:44:44.756Z", "last_updated": "1992-05-11T22:42:01.265Z", "createdVersion": "9553325.99698163826.47", "lastUpdatedVersion": "0.0.45467665489-7221.35105397.353135001.4210", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -18215631, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 82601785.78847393, "sla": 24667899.585182652, "decorators": [ { "type": "encryption", "pointer": "/~1/FrtA/P3Pqg2/V4/~1/aPyTYyFFHW/BDqn8Eo1/~0/M9bMe-.EwO" }, { "type": "encryption", "pointer": "/ecyPMP/~0/~0/~1/PfNYz" }, { "type": "encryption", "pointer": "/UV+fLPhc" }, { "type": "encryption", "pointer": "/GhJpxcRs2wx/~0/YUQCmHBn/P/tGUtRcWHL9S/b-oLz/Jz/dpTx/~0/~1" }, { "type": "encryption", "pointer": "/Fv9KCR/M/~0/ybgl/mSI/~0/~1" } ], "status": "paused", "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 }, { "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": "e28f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "non occaecat" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "culpa cillum sunt" } ], "ancestors": [ "a56489d9fa6c9f22cabeca54", "e258f1c45ce62bebff5dac6e" ], "validationErrors": [ { "keyword": "labore irure commodo", "dataPath": "adipisicing occaecat ea non", "schemaPath": "velit ullamco veniam id", "message": "et eiusmod incididunt voluptate amet" }, { "keyword": "dolor dolore", "dataPath": "non eiusmod", "schemaPath": "voluptate nulla", "message": "in" }, { "keyword": "in laborum", "dataPath": "ad voluptate et Excepteur", "schemaPath": "eu consectetur Excepteur anim", "message": "proident do sunt quis" }, { "keyword": "deserunt do", "dataPath": "deserunt id", "schemaPath": "sit ullamco aliqua", "message": "eiusmod qui" } ], "created_by": "Pronghorn", "last_updated_by": null, "tasks": { "workflow_start": { "x": -96874928.39999461, "y": 14521502.206747487, "gridCoordinate": { "x": -20369121.7217433, "y": 28729715.459968746 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -94354248.24562895, "finish_state": "success", "user": "Pronghorn" }, "groups": [ { "_id": "6114d9261747a556671c5582", "provenance": "labore cupidatat sit nostrud", "name": "quis", "description": "in", "memberOf": [ { "groupId": "db80d14f6e8900de07e6f9a6", "aaaManaged": false }, { "groupId": "e699509413eaa3edb43b6c9d", "aaaManaged": false }, { "groupId": "7f29c7d037135fae39129e7e", "aaaManaged": false }, { "groupId": "0765e95f47bf8066f4744e85", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa pariatur adipisicing" }, { "roleId": "ex" } ], "inactive": false, "_meta": { "created": "1986-11-12T02:20:49.047Z", "updated": "2011-07-03T04:25:10.606Z", "migrationVersion": 84391813 } } ], "iterations": [ "871cCc2E-d2EC-Da65-9FF3-ddd1A979db6E", "fb075ccA-Faea-7b51-e46D-cEDD4E91fbb8" ] }, "workflow_end": { "x": -67665394.39038143, "y": -59558180.47397203, "gridCoordinate": { "x": -23943514.286312923, "y": 38027059.30446035 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_start", "e28f", "3a1f", "e28f" ], "error": [ "e28f", "e28f", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": -79115553.13432643, "run_time": 86250721.71831104 }, "groups": [ "default", "4fa7f4b0c40382058f74e791", "default", "default", "default" ], "iterations": [ "e6bbF50A-48dB-02C8-Dc7B-bc5A1faac581" ] }, "error_handler": { "x": -47093462.94682386, "y": 17128934.022790253, "gridCoordinate": { "x": 69915972.25890926, "y": 79404262.88140988 }, "name": "childJob", "location": "Broker", "locationType": "dolor in nostrud occaecat", "app": "ipsum in minim", "canvasName": "Duis aliquip ad", "displayName": "elit ea", "summary": "dolor", "description": "laboris", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "enim exercitation ut adipisicing nostrud", "highlightString": "et in dolor cupidatat aute" }, { "key": "sit consectetur", "highlightString": "sed in eiusmod" }, { "key": "cupidatat nulla", "highlightString": "nulla mollit ut dolor eiusmod" } ], "status": "running", "previous": { "incomplete": [ "e28f", "3a1f" ], "complete": [ "error_handler", "3a1f", "workflow_start" ], "error": [ "e28f", "3a1f", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "Excepteur qui non veniam nostrud", "start_time": "2000-02-07T09:24:55.176Z", "end_time": -37678087.39968754, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "67b4a302be9159da57aa5c5e", "default" ], "iterations": [ "EFFE2B80-82DB-eFc1-80c6-cEDc2eEdA992" ] }, "7a": { "actor": "493e118a41fac8a30cb00f74", "groups": [ { "_id": "0a5bc98d14c0ba4703e14e78", "provenance": "enim", "name": "mollit fugiat proident", "description": "ex quis eu", "memberOf": [ { "groupId": "38a65a7018f60991a6ea0045", "aaaManaged": true }, { "groupId": "c7def1020528221b03de47d9", "aaaManaged": false }, { "groupId": "0ba98d5585201ff52cec83fe", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam reprehenderit ipsum" }, { "roleId": "irure culpa in mollit cupidatat" }, { "roleId": "culpa commodo voluptate" }, { "roleId": "nostrud magna occaecat" }, { "roleId": "eu in dolore" } ], "inactive": true, "_meta": { "created": "1956-09-26T09:19:28.386Z", "updated": "1998-01-29T04:08:54.514Z", "migrationVersion": -35927256 } } ], "iterations": [], "x": 91766661.06291407, "y": -16010114.463139892, "gridCoordinate": { "x": -97032250.28557867, "y": -70774789.20460281 }, "name": "pending", "summary": "incididunt", "description": "cupidatat et sed veniam" } }, "parent": { "job": "id sint in", "task": "veniam velit ea", "iteration": 18035763.527980417, "element": -65865600.89324687 }, "errorHandler": null, "groups": [ { "_id": "1d477ee8ac417151a65b6f14", "provenance": "do esse dolor", "name": "ad in elit irure nulla", "description": "fugiat", "memberOf": [ { "groupId": "ecbb19153a7326e40f12e9ec", "aaaManaged": true }, { "groupId": "ecf09a29ec4c0cd78790b41d", "aaaManaged": false }, { "groupId": "919962c18683d8710413cc8f", "aaaManaged": true }, { "groupId": "8b5df1808030d8e802a68de1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore cillum sit aliquip laborum" }, { "roleId": "laboris" }, { "roleId": "exercitation incididunt" } ], "inactive": true, "_meta": { "created": "1969-08-08T09:22:43.04Z", "updated": "1961-09-12T01:55:32.59Z", "migrationVersion": -13339348 } }, { "_id": "bddf50faeac1b8bb995087ae", "provenance": "velit commodo deserunt qui proident", "name": "eu et cupidatat ex", "description": "cupidatat dolor sed", "memberOf": [ { "groupId": "658d4ada975954a0f6f13b32", "aaaManaged": true }, { "groupId": "3808ce94322401bd46d0b1d5", "aaaManaged": true }, { "groupId": "6a5e4e4de897bb6e99678d53", "aaaManaged": false }, { "groupId": "efddcfa9413acffdbf95ba25", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu veniam" }, { "roleId": "deserunt" }, { "roleId": "sit" }, { "roleId": "non id Lorem" }, { "roleId": "sunt commodo tempor dolor" } ], "inactive": true, "_meta": { "created": "1976-07-20T05:41:08.16Z", "updated": "2008-03-16T06:26:21.717Z", "migrationVersion": 95604435 } }, "7297c67cd086aed9698da6c3", { "_id": "4a17b90ee369e4a8f3c3f89e", "provenance": "mollit enim proident eiusmod in", "name": "reprehenderit pariatur Duis sed irure", "description": "deserunt nulla et esse est", "memberOf": [ { "groupId": "db16cb72da4acf8f56eead42", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam culpa" }, { "roleId": "est minim Ut incididunt sit" }, { "roleId": "sunt cillum reprehenderit" }, { "roleId": "quis dolor" } ], "inactive": true, "_meta": { "created": "2025-01-01T07:22:26.836Z", "updated": "2022-07-18T16:21:35.642Z", "migrationVersion": 78238514 } } ], "watchers": [ null, null, "Pronghorn" ], "metrics": { "start_time": 31967947.766766697, "progress": 0.32432672290764786, "end_time": -24701734.14631325, "user": "6def52de4ee8ca4439e654b0", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }