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": "aliqua", "options": { "description": "Example job description", "type": "automation", "groups": [ "8061d28be30bdfffd15c5f77", "bbc4c957a7f936a44c0535ac", "b003ad8f679067043c4ea6dd", "f3d1386cb500661594d671db", "7aa7fc314b2421b90930ed87" ] } }
{ "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": "2d3d36c097ca9d19e16efaf6", "font_size": 95059072, "type": "resource:action", "created": "1958-07-02T19:16:08.129Z", "last_updated": "2008-01-10T03:48:05.959Z", "createdVersion": "02.426.8-0994.15416.76571353281.47945253", "lastUpdatedVersion": "2766.4469524414.0316", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 89841795, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 58733184.02762467, "sla": -9577328.512429878, "decorators": [ { "type": "encryption", "pointer": "/h5o-Is/~1/lrl,OdIXH,/TOvJg" }, { "type": "encryption", "pointer": "/~0/e+Bp6/~1/~1" }, { "type": "encryption", "pointer": "/~0/~1/X.pwpL3UR/~0/oCG/tewBtV6/~0/Kn-/~0" }, { "type": "encryption", "pointer": "/akJ4EI,Cz+D/IT53qYCwtnn/~0/~1/qB-6S/~1" }, { "type": "encryption", "pointer": "/~1/f/VpBOyb+y,Y/BmInp18/~0/~0/y5oxcEgq0" } ], "status": "incomplete", "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": "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 }, { "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": "sed" } ], "ancestors": null, "validationErrors": [ { "keyword": "eiusmod", "dataPath": "elit aliquip velit qui aliqua", "schemaPath": "eiusmod elit Duis", "message": "proident ut nostrud" }, { "keyword": "eiusmod consectetur sed esse", "dataPath": "esse", "schemaPath": "dolore Ut commodo sunt do", "message": "ut exercitation ad amet nostrud" } ], "created_by": null, "last_updated_by": "d14959634e9bef1470445357", "tasks": { "workflow_start": { "x": -70355019.06707907, "y": 53875725.954408824, "gridCoordinate": { "x": 26501134.54391913, "y": -9800040.710077614 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -94741369.33745755, "finish_state": "error", "user": null }, "groups": [ "default", "de4b65c0baab3b087472fef9", "9c0a40d44a62802a7882302c", "c2d172ac20c793a914f549f0", "default" ], "iterations": [ "094E2f07-BFB6-6c72-E4F1-2DEaF01D6D0d", "5DFa0Ac8-AF99-F6ae-cAf9-E3191c7aeaBb" ] }, "workflow_end": { "x": -5953071.539588213, "y": 28186125.313149184, "gridCoordinate": { "x": -67083786.633818, "y": 83717557.10355365 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "3a1f" ], "complete": [ "workflow_start", "error_handler", "error_handler", "e28f", "workflow_end" ], "error": [ "workflow_start", "workflow_end", "workflow_end", "workflow_end" ] }, "metrics": { "end_time": 74383404.88246125, "run_time": 88514588.60013151 }, "groups": [ "6a709223da47cb8bcab4d9d0", "5da8fb42d0a55446d7ec4b26", { "_id": "521cb280e6aac980e5ca2264", "provenance": "non velit aute sunt", "name": "ipsum ea Ut et non", "description": "ut velit non magna", "memberOf": [ { "groupId": "e4cc20e934eb49dd70ed44e9", "aaaManaged": true }, { "groupId": "0e47cfab9ec6f72888c26e47", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Lorem ea" }, { "roleId": "pariatur" }, { "roleId": "consectetur irure" } ], "inactive": false, "_meta": { "created": "2025-02-26T15:09:01.224Z", "updated": "1982-07-26T23:41:45.099Z", "migrationVersion": -16710064 } } ], "iterations": [ "33d1cC4d-EB2B-645f-70C7-7CcB3EdA77E4", "4b58F8Ee-cCf8-ccEe-983d-a0051E21e1A5" ] }, "error_handler": { "x": -94141915.91846977, "y": 54370331.86710876, "gridCoordinate": { "x": 71432373.49214503, "y": -68129159.47860447 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "proident id", "canvasName": "dolore sit", "displayName": "dolor exercitation magna", "summary": "Ut amet dolor cillum deserunt", "description": "veniam in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/cHaS7u/eBZ+./XYtR0" }, { "type": "encryption", "pointer": "/tL,Vp7HY5jC/l/q7ppZ802z/~0/~0/YjLJSZpi/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolor", "highlightString": "enim nulla culpa dolor magna" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "workflow_end", "workflow_start", "workflow_start", "workflow_start", "workflow_end" ], "error": [ "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "anim in mollit sint do", "start_time": "2002-01-31T05:39:16.073Z", "end_time": -11448286.671523526, "finish_state": "success", "retrySettings": { "state": [ "failure", "error", "success", "success" ], "autoRetry": true, "limit": 40777691, "delay": 2336733, "count": 39148864, "finishedRetrying": false }, "type": "operation", "actor": { "_id": "9b5173ac10a9d5ce9fbecff1", "provenance": "cillum veniam", "username": "consequat", "firstname": "tempor incididunt cupidatat ut", "memberOf": [ { "groupId": "33d8883ae176eff84644f4d3", "aaaManaged": false }, { "groupId": "88c97fe6ae3c99d98d0a304e", "aaaManaged": true }, { "groupId": "72390a8c16a326fecd898974", "aaaManaged": false }, { "groupId": "a1c4b583f5071e3b2605d537", "aaaManaged": false }, { "groupId": "3b03ebe45a8568a48d56e856", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis voluptate consectetur sint" }, { "roleId": "Ut veniam id" }, { "roleId": "veniam non consectetur incididunt labore" } ], "inactive": false, "lastLogin": "1956-07-28T05:20:20.781Z", "_meta": { "created": "1995-12-10T08:52:24.345Z", "updated": "1988-09-13T07:59:04.522Z", "migrationVersion": -73011281 }, "email": "dolor ea magna eiusmod id" }, "groups": [ "4b47505be8d4f1c5d21f0590", "f8683f22db2268f70b5451e6", { "_id": "2d53ea45b62bef5c5d168592", "provenance": "dolore nulla in", "name": "reprehenderit", "description": "esse fugiat ipsum", "memberOf": [ { "groupId": "b33317f09e5ce93caa5a32be", "aaaManaged": false }, { "groupId": "294edede98642ec41beb196e", "aaaManaged": true }, { "groupId": "e013cf8ec21953a39abbd6d5", "aaaManaged": false }, { "groupId": "6340f69356e4074bbd175151", "aaaManaged": false }, { "groupId": "01d6f435227abd89376eadd1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt esse id reprehenderit non" }, { "roleId": "velit aliqua" }, { "roleId": "dolore sit aute aliqua" }, { "roleId": "cillum pariatur" }, { "roleId": "aute cillum Excepteur in" } ], "inactive": false, "_meta": { "created": "1966-07-02T14:04:47.723Z", "updated": "2006-10-13T12:58:07.423Z", "migrationVersion": -82455471 } } ], "iterations": [ "afc22dBd-6Aef-720A-B8Bd-E21DCFE95EcB", "5eb4aCaa-De71-Ba6c-272F-EcE7288AddFE", "70BAfD91-dB93-d0c1-AcdF-46aaE2164be4" ] }, "2f": { "actor": "f6a463806f8c37fb84f9f5ae", "groups": [ "3d6219ee9afdc075ec1f7b76" ], "iterations": [], "x": 28977396.953850538, "y": -840474.134975329, "gridCoordinate": { "x": -94695548.89569673, "y": 1633914.2799473852 }, "name": "non cillum irure", "location": "Application", "locationType": "occaecat minim sit consectetur", "app": "irure pariatur", "canvasName": "childJob", "displayName": "proident eu sed laborum", "summary": "in commodo proident ut culpa", "description": "in in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Yu7/~0/xx1uq+eklS/GS" }, { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "non", "highlightString": "nulla ullamco nisi" }, { "key": "exercitation dolor qui", "highlightString": "laborum et ut mollit" }, { "key": "Lorem", "highlightString": "nulla ad" }, { "key": "non", "highlightString": "sit do qui incididunt nostrud" }, { "key": "ipsum qui esse nisi", "highlightString": "in eu" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "workflow_end", "error_handler" ], "complete": [ "error_handler", "workflow_start", "e28f", "workflow_start" ], "error": [ "error_handler", "workflow_start", "workflow_end", "error_handler", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ] }, "serverId": "sunt Excepteur quis", "start_time": "2008-06-23T08:26:07.804Z", "end_time": 64951027.02764705, "finish_state": "failure", "retrySettings": { "state": [ "failure", "success" ], "autoRetry": false, "limit": 48020270, "delay": 15832198, "count": 31590022, "finishedRetrying": false }, "loop": { "atLeastOneComplete": false, "finishedCount": -56128242.69031203, "outgoing": [ null, "Lorem dolor anim", null ] }, "childJobs": [ { "_id": "Excepteur", "name": "ea", "iteration": 19623643.101458967 } ] } }, "parent": { "job": "laborum ad incididunt", "task": "amet commodo", "iteration": -69181996.6940793, "element": 2134015.2637227178 }, "errorHandler": null, "groups": [ "default", "46d86fc01f213df66c9bdf79", "default", { "_id": "e9373ef37e80f604b679b5e4", "provenance": "do anim in", "name": "ex in", "description": "et", "memberOf": [ { "groupId": "3fd05ca7194452d06b348e24", "aaaManaged": false }, { "groupId": "79dc3fa00d4f4345ee956013", "aaaManaged": true }, { "groupId": "db5954e688cdbf1facc0d34a", "aaaManaged": false }, { "groupId": "064f67cb333c263b3b1326e1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur culpa occaecat ad Duis" }, { "roleId": "reprehenderit fugiat" }, { "roleId": "mollit dolore dolor" }, { "roleId": "cillum Lorem sed" }, { "roleId": "dolor exercitation in" } ], "inactive": true, "_meta": { "created": "1970-10-31T22:39:33.111Z", "updated": "1946-03-11T17:15:33.543Z", "migrationVersion": -48100971 } }, { "_id": "b6cad4731bfb06e6a87a971c", "provenance": "enim Ut minim consequat cupidatat", "name": "incididunt Ut", "description": "cupidatat dolore", "memberOf": [ { "groupId": "0c9789d3992e0ad92936ed6b", "aaaManaged": true }, { "groupId": "288f96bbb2ec850f1d0a1c64", "aaaManaged": true }, { "groupId": "b428cb2194413244d7f8ed55", "aaaManaged": true }, { "groupId": "b68855501056ac726b8e82aa", "aaaManaged": false }, { "groupId": "fd3b88c6e90f8532d0ea0673", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt sit aute" }, { "roleId": "in veniam dolor tempor" }, { "roleId": "do et" }, { "roleId": "dolor ea" } ], "inactive": true, "_meta": { "created": "2019-01-18T08:51:20.514Z", "updated": "1986-02-22T20:54:43.705Z", "migrationVersion": -21181846 } } ], "watchers": [ "Pronghorn", "Pronghorn" ], "metrics": { "start_time": -33385700.673061833, "progress": 0.6849875310883886, "end_time": 26718492.108307183, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }