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": "id dolore enim mollit", "options": { "description": "Example job description", "type": "automation", "groups": [ "6636a601cb878907f86e134d" ] } }
{ "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 retrieved search results", "data": { "_id": "f078d7a475f1445edd54cb55", "font_size": -65252396, "type": "automation", "created": "1990-11-11T19:55:45.267Z", "last_updated": "1960-08-19T04:17:37.91Z", "createdVersion": "81984.072300.54253-9252.997672.9", "lastUpdatedVersion": "843724153.02.186-0902.84.4165", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -22858544, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -5867019.710971683, "sla": 77980475.78792495, "decorators": [ { "type": "encryption", "pointer": "/~1/IdyyD3,4d" } ], "status": "canceled", "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": "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "cupidatat eiusmod in reprehenderit aliquip" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "culpa aliqua elit sint" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "qui non magna sed proident" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "cupidatat aliquip" } ], "ancestors": [ "c225a71b334efb2d1bb9e52a", "2b26ba3604f4bd3572803615" ], "validationErrors": [ { "keyword": "reprehenderit", "dataPath": "voluptate reprehenderit", "schemaPath": "sed sit laborum ad Excepteur", "message": "dolore" }, { "keyword": "ad", "dataPath": "id eu laboris consequat mollit", "schemaPath": "est", "message": "proident" }, { "keyword": "in", "dataPath": "proident", "schemaPath": "veniam magna Duis eiusmod tempor", "message": "exercitation eu ut non dolore" } ], "created_by": { "_id": "9f17fd7c130451c830dfe1f2", "provenance": "reprehenderit sint eu esse nulla", "username": "aute labore", "firstname": "labore commodo voluptate", "memberOf": [ { "groupId": "a4b1e1d419cc1177ff8ec96d", "aaaManaged": true }, { "groupId": "9dd220b52908ed1530d585c2", "aaaManaged": false }, { "groupId": "f0ca257952fc92d3709eb139", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem sed" }, { "roleId": "Lorem ut" }, { "roleId": "do exercitation pariatur aliqua" }, { "roleId": "occaecat" }, { "roleId": "sint voluptate" } ], "inactive": true, "lastLogin": "2005-06-15T05:48:15.636Z", "_meta": { "created": "1979-02-18T00:00:43.184Z", "updated": "1983-08-26T08:28:24.243Z", "migrationVersion": -39840833 }, "email": "in commodo in anim veniam" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 37749657.50800797, "y": -66332492.93832559, "gridCoordinate": { "x": 67098558.68877283, "y": 87070303.31578496 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -26438665.379389107, "finish_state": "success", "user": null }, "groups": [ "9507278097ec924ec5c80dd9", "default", "2f150d605e4b1b2e8b34becb" ], "iterations": [ "4bdf41bc-4Bf1-74C5-F2Fc-D6E8960B0eaF" ] }, "workflow_end": { "x": -19500110.042948246, "y": 4502181.513499036, "gridCoordinate": { "x": 70502356.88069221, "y": -77648715.84562165 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "e28f", "error_handler", "3a1f" ], "complete": [ "workflow_start", "error_handler", "e28f" ], "error": [ "workflow_start", "error_handler", "3a1f", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 37813864.16354957, "run_time": -17963442.248727858 }, "groups": [ { "_id": "adc4bb53be770f2ded7ccf60", "provenance": "et amet irure sit enim", "name": "qui veniam minim ut irure", "description": "sit dolor sed officia in", "memberOf": [ { "groupId": "d5b74bdfc35de1171b02ddd0", "aaaManaged": true }, { "groupId": "7f8776f88a03f6f56518e8ac", "aaaManaged": true }, { "groupId": "aa5ca326b08294aa7de691a1", "aaaManaged": true }, { "groupId": "19a935ddffcd4e58b353223a", "aaaManaged": false }, { "groupId": "4e5e73ccd4a9aa64f6b141fa", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod sit velit veniam occaecat" }, { "roleId": "do ea elit magna minim" }, { "roleId": "Lorem sunt tempor aute irure" }, { "roleId": "eu in proident reprehenderit ut" }, { "roleId": "deserunt tempor" } ], "inactive": true, "_meta": { "created": "2016-07-28T06:06:28.098Z", "updated": "2006-06-20T06:24:47.246Z", "migrationVersion": 13466494 } } ], "iterations": [] }, "error_handler": { "x": -44520095.6316623, "y": 39275919.79761806, "gridCoordinate": { "x": 49839218.68755722, "y": 63242905.70752522 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "aliqua", "canvasName": "non", "displayName": "velit veniam Duis aute dolor", "summary": "irure consectetur veniam", "description": "in elit cupidatat aliqua", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/msC8aA/aP1tx" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "in aliquip laboris nostrud", "highlightString": "Excepteur" }, { "key": "Excepteur anim", "highlightString": "consequat" }, { "key": "consequat occaecat", "highlightString": "exercitation consectetur occaecat" } ], "status": "incomplete", "previous": { "incomplete": [ "e28f", "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "e28f", "error_handler" ], "error": [ "workflow_end", "workflow_start", "workflow_start", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "amet", "start_time": "1957-11-16T04:51:01.96Z", "end_time": -81025302.69574615, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "90fa228153d211e9e191822c", "groups": [ { "_id": "66e1cc74210d236ad380da72", "provenance": "labore anim velit nisi", "name": "cillum", "description": "reprehenderit", "memberOf": [ { "groupId": "876ed3f93e611d289ad12c3d", "aaaManaged": true }, { "groupId": "26dd2afaeda9a60610262b22", "aaaManaged": true }, { "groupId": "45638cec78184797c386e9e8", "aaaManaged": false }, { "groupId": "0abd26c1c8df37665ee98359", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt magna cupidatat commodo" }, { "roleId": "non proident qui" }, { "roleId": "occaecat nostrud voluptate deserunt officia" }, { "roleId": "elit" } ], "inactive": false, "_meta": { "created": "2025-10-24T03:07:22.817Z", "updated": "1999-10-04T20:53:17.028Z", "migrationVersion": -89036075 } } ], "iterations": [ "1BA3880E-6afb-2350-Ebbb-782dF27401A0", "7C6ed8DF-c649-1Ca7-244B-1bEA23C13cFe" ] }, "c": { "x": -87846448.959057, "y": -10592221.171385765, "gridCoordinate": { "x": -24760129.28396836, "y": -37892077.23691219 }, "name": "anim consequat", "location": "Adapter", "locationType": "mollit consectetur cillum Ut", "app": "in pariatur Excepteur", "canvasName": "sunt ea consectetur elit", "displayName": "enim reprehenderit", "summary": "laboris sit", "description": "quis nulla minim ea", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/u/~0/Pvv+g/~0/~1/~0/zFjc/~0" }, { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/BVU6ae9/dbcNfbihp/NeZM9O0iPC" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ullamco tempor fugiat", "highlightString": "cupidatat veniam laboris sunt" }, { "key": "aute velit enim", "highlightString": "culpa qui aute Excepteur est" }, { "key": "mollit sunt ut elit", "highlightString": "sed exercitation et id fugiat" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler", "workflow_start", "error_handler", "workflow_end", "workflow_end" ], "complete": [ "error_handler", "workflow_start" ], "error": [ "error_handler", "workflow_end", "error_handler", "workflow_start", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "in voluptate", "start_time": "2012-06-26T17:57:14.955Z", "end_time": -73273443.8172006, "finish_state": "success", "retrySettings": { "state": [ "failure", "success", "failure" ], "autoRetry": false, "limit": 16144950, "delay": 70944030, "count": 3487963, "finishedRetrying": false }, "type": "operation", "actor": { "_id": "bc7ea1579fe728d0302ffa57", "provenance": "irure ipsum ad proident", "username": "esse", "firstname": "voluptate", "memberOf": [ { "groupId": "200724a212b47b24974c5ec8", "aaaManaged": false }, { "groupId": "5fc2624cfc499606d2aeda10", "aaaManaged": true }, { "groupId": "0bcf2a2db781808550e846b8", "aaaManaged": true }, { "groupId": "926cd5f00bbb17dabb96168e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad sed Lorem" }, { "roleId": "nulla quis ea consequat aliquip" } ], "inactive": true, "lastLogin": "1970-10-18T09:45:23.824Z", "_meta": { "created": "2006-10-22T21:27:38.039Z", "updated": "2011-04-08T21:04:41.78Z", "migrationVersion": -57740327 }, "email": "in dolor" }, "groups": [ "default" ], "iterations": [ "9a7dCB25-0eD6-eF9d-CEB8-Fc851176E5F8" ] } }, "parent": { "job": "pariatur irure tempor", "task": "in", "iteration": -77103397.28693278, "element": -35914776.59651226 }, "errorHandler": { "x": 36592393.42471251, "y": -36073688.20360195, "gridCoordinate": { "x": 65119379.028244674, "y": 65468223.30882734 }, "name": "magna in labore ad", "location": "Application", "locationType": null, "app": "est ut esse adipisicing", "canvasName": "amet cupidatat ullamco eu in", "displayName": "magna officia ullamco", "summary": "est veniam mollit incididunt dolore", "description": "aliqua ullamco sint", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "est ut", "highlightString": "dolore veniam" }, { "key": "dolor ipsum occaecat magna ea", "highlightString": "occaecat" }, { "key": "do commodo sed ut exercitation", "highlightString": "consectetur nisi" }, { "key": "in", "highlightString": "laboris" }, { "key": "consectetur", "highlightString": "labore Lorem" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "e28f" ], "error": [ "workflow_start", "workflow_start", "e28f", "3a1f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "do adipisicing", "start_time": "2012-04-19T19:53:13.737Z", "end_time": 77842837.88356209, "finish_state": "success", "retrySettings": { "state": [ "success", "error", "failure", "success" ], "autoRetry": true, "limit": 6256662, "delay": 63894347, "count": 70017863, "finishedRetrying": true }, "type": "operation", "actor": "1802a8675b4f196e51277943", "groups": [ "default" ], "iterations": [ "5460B45E-4ede-D1cc-3Ffa-724301EfF2A5", "E4Dc410e-99fd-Bf8d-fcC9-C65D7c485dCe" ] }, "groups": [ "01437be08a20714401d41430", { "_id": "461ec1458391655b6cf0f7b1", "provenance": "enim eiusmod", "name": "magna pariatur consequat Duis eiusmod", "description": "laboris non aliquip tempor Excepteur", "memberOf": [ { "groupId": "948600d33260f0ef3bb10e49", "aaaManaged": false }, { "groupId": "d6a2cea80934c3173c40c0f4", "aaaManaged": true }, { "groupId": "b9e7476f05ba2f40350ebccb", "aaaManaged": true }, { "groupId": "e3aad9cbf3d2b3cd6fb4b16e", "aaaManaged": false }, { "groupId": "42ff3d78a409155ee9ee9cc5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris elit" }, { "roleId": "ullamco esse dolore" } ], "inactive": false, "_meta": { "created": "1945-12-01T22:48:36.266Z", "updated": "1964-06-05T17:14:36.114Z", "migrationVersion": -60555696 } }, { "_id": "ce5e6a2c50233ec1074ef27d", "provenance": "minim esse ipsum", "name": "do nisi ea", "description": "dolor est dolore", "memberOf": [ { "groupId": "9bffed04ded0fffeb6cd119e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa est qui" }, { "roleId": "proident" }, { "roleId": "eu laboris eiusmod cupidatat voluptate" }, { "roleId": "ad Ut deserunt" } ], "inactive": false, "_meta": { "created": "1972-07-31T13:24:01.819Z", "updated": "1981-03-24T13:41:31.547Z", "migrationVersion": 80996508 } } ], "watchers": [ "Pronghorn", "fe02377ff922d70843f29b7a" ], "metrics": { "start_time": -99991906.69341673, "progress": 0.8547224068285966, "end_time": -29815900.037577897, "user": "Pronghorn", "owner": "eba2add0c62cf6736ec9b320" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }