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": "sint consequat occaecat culpa", "options": { "description": "Example job description", "type": "automation", "groups": [ "fe98b753122a548bc07eff33", "8730413331da800c9bd76ea2", "5c18a21883ee419ac84c29d7" ] } }
{ "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": "80c213e2c0f7e5cd95c8b416", "font_size": 79272166, "type": "resource:action", "created": "1979-08-14T20:16:51.076Z", "last_updated": "1988-08-18T05:35:44.151Z", "createdVersion": "55882690088.02590955618.5402301262", "lastUpdatedVersion": "348.6711097794.652621766", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -72572110, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 64151116.925689965, "sla": -49852880.59630717, "decorators": [ { "type": "encryption", "pointer": "/~0/rDW/X/~1/~0/uyBA3bd/LPJ/~0/YK7Dk/~1" } ], "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 }, { "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": [ "857c7137b3b2776ece71c27f", "e6d7c7442fbf2cb8ddb9a888", "939ac693cfe5e25fbce732e5" ], "validationErrors": [ { "keyword": "Ut dolore", "dataPath": "nostrud", "schemaPath": "est sit esse laborum nisi", "message": "ea sint ad magna" }, { "keyword": "ex irure officia ea", "dataPath": "ea occaecat irure sit culpa", "schemaPath": "exercitation", "message": "in" }, { "keyword": "dolore ipsum sint in sit", "dataPath": "quis aliqua nostrud", "schemaPath": "ex cupidatat sit", "message": "anim ad pariatur commodo" }, { "keyword": "Excepteur voluptate consectetur", "dataPath": "culpa", "schemaPath": "Excepteur fugiat eu labore aute", "message": "id cupidatat minim quis nisi" } ], "created_by": "Pronghorn", "last_updated_by": null, "tasks": { "7": { "actor": "Pronghorn", "groups": [ { "_id": "99c29bad3aa127fcc425ff6b", "provenance": "do", "name": "qui dolor", "description": "ut aliqua officia sint est", "memberOf": [ { "groupId": "aac1c68ad89e9b4cda96a697", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor eiusmod proident" }, { "roleId": "in" }, { "roleId": "cupidatat" }, { "roleId": "dolor aliqua Ut" } ], "inactive": true, "_meta": { "created": "1947-04-25T17:08:47.237Z", "updated": "2012-07-03T19:39:45.174Z", "migrationVersion": 85177070 } }, "3e641b95ef1e9a26953aa995", "e8f49a254cb0ddd04c743aa7" ], "iterations": [ "65E4fB6b-d12b-624F-dA8B-2BE2FdDb1e91" ], "x": -4212760.549253851, "y": -51937375.644424446, "gridCoordinate": { "x": 45816362.67386863, "y": -54405445.65823369 }, "name": "non nostrud sunt laborum do", "location": "Adapter", "locationType": "consequat laboris amet voluptate sit", "app": "et aliquip aute adipisicing sunt", "canvasName": "cillum Ut elit", "displayName": "cupidatat ullamco esse et irure", "summary": "do commodo tempor Duis deserunt", "description": "eiusmod", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/HWtAc/~1/~1/~0/~0/VbK/~0" }, { "type": "encryption", "pointer": "/~0/zz" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/~1/~0" }, { "type": "encryption", "pointer": "/X2R6WaM/~0/~0/~1/I3N-s1T/~0" }, { "type": "encryption", "pointer": "/~1/L1vw/oL.55fmM/~0/~1/ftO-/~1/bJ/KD4/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in", "highlightString": "labore" }, { "key": "adipisicing do enim cillum qui", "highlightString": "esse aliqua" }, { "key": "officia", "highlightString": "velit" }, { "key": "dolor", "highlightString": "ut ullamco" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "workflow_start", "workflow_end" ], "complete": [ "3a1f", "error_handler" ], "error": [ "workflow_start", "workflow_start", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "proident qui ad eiusmod", "start_time": "1952-12-14T15:46:25.837Z", "end_time": -24820973.632751152, "finish_state": "failure", "retrySettings": { "state": [ "success", "success" ], "autoRetry": true, "limit": 59597593, "delay": 14914673, "count": 54891970, "finishedRetrying": true }, "type": "automatic" }, "workflow_start": { "x": 16378366.347370937, "y": 67182940.60864794, "gridCoordinate": { "x": 46938206.41701114, "y": -85965319.39015883 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -21745217.87917362, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "default", { "_id": "e3ad3c76259b07c864d6a2cc", "provenance": "in", "name": "quis et cupidatat", "description": "commodo laborum minim mollit", "memberOf": [ { "groupId": "7055f2eb34e29ccfb4e9a9d0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit veniam" }, { "roleId": "elit aute eu irure" }, { "roleId": "enim" } ], "inactive": true, "_meta": { "created": "1953-06-03T05:46:33.559Z", "updated": "2012-08-29T15:25:48.486Z", "migrationVersion": 2855140 } }, { "_id": "dfbc1caf30c5cb7cd20ecb6b", "provenance": "consequat sed ipsum exercitation", "name": "eiusmod aliqua eu quis irure", "description": "amet", "memberOf": [ { "groupId": "415045dd12ec246cda19017e", "aaaManaged": true }, { "groupId": "cb4eb0f818df8452eb037781", "aaaManaged": false }, { "groupId": "2d37ac6a41c403eafa1b2a26", "aaaManaged": false }, { "groupId": "6305f64d1cbf75e13080ea0d", "aaaManaged": true }, { "groupId": "8369f6fc1b3558306d75269d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat irure ea pariatur velit" } ], "inactive": true, "_meta": { "created": "2006-03-08T04:53:50.107Z", "updated": "1972-11-22T15:57:26.735Z", "migrationVersion": 17517376 } } ], "iterations": [ "11951e66-BEDA-2Cf5-56c9-0C44dC62f08B", "b2F43DdC-1B4a-ACc5-BD08-86Be6DC53fcf" ] }, "workflow_end": { "x": -46823006.47820861, "y": -3258231.1560147107, "gridCoordinate": { "x": -14888682.52444835, "y": 81813710.57306156 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "e28f", "3a1f", "workflow_end" ], "complete": [ "3a1f", "e28f", "workflow_start" ], "error": [ "workflow_start", "error_handler", "e28f", "error_handler", "workflow_start" ] }, "metrics": { "end_time": -32846093.23444259, "run_time": 27942821.593814537 }, "groups": [ { "_id": "4820b4bdb306afe39bf412d0", "provenance": "commodo ea", "name": "anim eiusmod proident", "description": "do pariatur qui", "memberOf": [ { "groupId": "c406fe6bbcfa66e943697ba9", "aaaManaged": false }, { "groupId": "cd7ac5d5494b711a2f2a935e", "aaaManaged": true }, { "groupId": "5c76998d6ea0246ebec919fd", "aaaManaged": false }, { "groupId": "9c41fc3b10646a135ae5bdec", "aaaManaged": false }, { "groupId": "c91159a5cd7d089f5b2840fb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit voluptate ad" }, { "roleId": "Ut ad commodo" } ], "inactive": true, "_meta": { "created": "1977-11-17T03:18:11.796Z", "updated": "1992-02-06T04:36:52.766Z", "migrationVersion": 26324304 } }, { "_id": "df0986dc6935e272883aeca8", "provenance": "eu Duis Lorem officia", "name": "Ut quis sed", "description": "aliqua", "memberOf": [ { "groupId": "cd433fd8a3a571df4063ca7a", "aaaManaged": true }, { "groupId": "a9486bdff58713f2de641899", "aaaManaged": true }, { "groupId": "09806f894087e473f5da95a0", "aaaManaged": true }, { "groupId": "d0bfa8931d6b2d04791a4cd0", "aaaManaged": true }, { "groupId": "1f12d985750202859fd4aa30", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "velit" }, { "roleId": "tempor" }, { "roleId": "veniam in dolore enim sunt" }, { "roleId": "sed veniam" } ], "inactive": true, "_meta": { "created": "1982-07-03T13:13:30.9Z", "updated": "2025-11-26T10:04:08.932Z", "migrationVersion": 4711176 } }, { "_id": "de0c1bdf50d5c552ca638b04", "provenance": "velit", "name": "minim cupidatat", "description": "labore consectetur pariatur sunt", "memberOf": [ { "groupId": "0892ea9d2bb1a853052c74f0", "aaaManaged": true }, { "groupId": "2f355e45b3c2ed8dd4f3f853", "aaaManaged": false }, { "groupId": "3144fb663e3db40b3c6979e7", "aaaManaged": true }, { "groupId": "4ba3976b90469524aa63cc9c", "aaaManaged": false }, { "groupId": "f888ab175a85e5f18ed1e87a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sint laborum elit labore consectetur" }, { "roleId": "culpa Excepteur officia consectetur" }, { "roleId": "irure culpa incididunt" }, { "roleId": "cillum incididunt dolore irure" }, { "roleId": "tempor laborum amet sit" } ], "inactive": true, "_meta": { "created": "1955-05-18T15:18:28.091Z", "updated": "2007-07-06T05:43:00.901Z", "migrationVersion": -63109137 } }, "default", "default" ], "iterations": [ "FAbD6aAa-357c-Cad8-Fff3-be09eFa35dfe" ] }, "error_handler": { "x": 44185892.54099682, "y": 85934396.14550543, "gridCoordinate": { "x": -85796165.70046556, "y": -77368652.69709194 }, "name": "childJob", "location": "Application", "locationType": null, "app": "aliquip ipsum laboris cillum", "canvasName": "occaecat dolore", "displayName": "exercitation adipisicing laborum", "summary": "ullamco pariatur", "description": "id eu nulla", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/MEY0/~1/~0/~0/~0/Npe3cV" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/~1/~1/Vdv5aPKr8V/izWlenQeB" }, { "type": "encryption", "pointer": "/PARu80zSs/~1/~0/~1/~0/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "quis Ut sunt", "highlightString": "deserunt eiusmod laboris esse quis" }, { "key": "anim ex nostrud", "highlightString": "fugiat proident irure" } ], "status": "error", "previous": { "incomplete": [ "error_handler", "workflow_start", "workflow_start", "3a1f" ], "complete": [ "e28f", "workflow_start", "workflow_end", "error_handler", "workflow_start" ], "error": [ "e28f", "workflow_end", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "incididunt nisi", "start_time": "1958-02-25T14:59:22.988Z", "end_time": 78101260.57752377, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "default" ], "iterations": [ "50A13099-9AeF-56B4-037E-234b6334C2DA" ] } }, "parent": { "job": "elit occaecat dolore", "task": "Lorem laboris", "iteration": 91623794.09584406, "element": 64202191.579904616 }, "errorHandler": null, "groups": [ "fd964c47e60882233269b49c", "default", "e9d4a7cab9af82e936ff4716" ], "watchers": [ "07b507f2945e1d31a178b143", "Pronghorn", { "_id": "b80c664df83add630a4fe8e6", "provenance": "in", "username": "quis commodo eiusmod voluptate", "firstname": "qui Duis", "memberOf": [ { "groupId": "34d1b0a89213df65bc661479", "aaaManaged": false }, { "groupId": "a925bb2e1e4358e72bbdaee1", "aaaManaged": true }, { "groupId": "08c6246684e9ecde93417e86", "aaaManaged": true }, { "groupId": "20f78ced0d5c51c97aaf773f", "aaaManaged": false }, { "groupId": "cbfac78f22bd24cdaaf65a51", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in aliquip ipsum" }, { "roleId": "Ut" }, { "roleId": "qui" } ], "inactive": true, "lastLogin": "2008-12-02T10:17:57.517Z", "_meta": { "created": "1975-04-03T10:14:21.193Z", "updated": "2004-06-23T01:07:20.419Z", "migrationVersion": 37594661 }, "email": "laborum ea" }, { "_id": "c35578a69733c493f4bc09c3", "provenance": "nulla deserunt et", "username": "ullamco et pariatur", "firstname": "quis qui deserunt", "memberOf": [ { "groupId": "fa68314359fe5f8e20cb5d54", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim ad" }, { "roleId": "esse laboris dolor fugiat" }, { "roleId": "culpa sunt" } ], "inactive": true, "lastLogin": "1976-11-07T17:14:01.207Z", "_meta": { "created": "1962-04-24T17:40:07.687Z", "updated": "2014-04-23T18:11:57.583Z", "migrationVersion": 47512420 }, "email": "Ut deserunt" }, "Pronghorn" ], "metrics": { "start_time": -24583065.265158102, "progress": 0.8223799115303838, "end_time": 53504001.204981476, "user": "Pronghorn", "owner": { "_id": "8667b385eb404065d9d907da", "provenance": "amet laboris tempor", "username": "reprehenderit", "firstname": "qui consequat dolore id", "memberOf": [ { "groupId": "34c794e87e933d5a228220d7", "aaaManaged": true }, { "groupId": "df7ca65e94687a703ccea0db", "aaaManaged": false }, { "groupId": "9b71d61af81fa3f03ea02d20", "aaaManaged": false }, { "groupId": "c811e21b6e00ce36554b4bf7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod aute Ut" }, { "roleId": "quis" }, { "roleId": "sit voluptate" }, { "roleId": "aliqua laborum adipisicing in" } ], "inactive": true, "lastLogin": "2016-05-04T20:49:08.466Z", "_meta": { "created": "1978-07-15T23:26:46.751Z", "updated": "1985-01-07T16:10:24.133Z", "migrationVersion": 69892663 }, "email": "tempor ad nulla ea Lorem" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }