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": "fugiat dolore amet consequat do", "options": { "description": "Example job description", "type": "automation", "groups": [ "fe91a1aae1a4c918e01d4fa0", "54c831272f426e73a56012f3", "36143e9f62df243a2b8692f9", "0daf0925231e6964eaf2b72e", "4393030eea519123df1f2c2e" ] } }
{ "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": "23e8faa6514bd475033424c4", "uuid": "f0054a76-6a04-1716-8eac-e9410b22f32c", "font_size": 81506110, "type": "automation", "created": "1968-01-22T21:17:35.872Z", "last_updated": "1950-03-13T07:40:40.855Z", "createdVersion": "85596917790.52299774150.09893", "lastUpdatedVersion": "7625847.038353819.1", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 74263756, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -48866244.960208505, "sla": 72633948.55209807, "decorators": [ { "type": "encryption", "pointer": "/H/~1" }, { "type": "encryption", "pointer": "/~1/~0/~1/IgACywE/AJbW,AkJJ0/~1/~1/nl/Pv3/EcZjUlo/~1/~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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "eiusmod consequat" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "laborum et quis officia" } ], "ancestors": null, "validationErrors": [ { "keyword": "eu", "instancePath": "sint in dolore proident nulla", "schemaPath": "consectetur est sed elit", "message": "incididunt in" }, { "keyword": "commodo consequat quis", "instancePath": "anim enim qui Lorem sunt", "schemaPath": "nisi pariatur ea minim mollit", "message": "minim" }, { "keyword": "dolore incididunt Excepteur", "instancePath": "eiusmod dolor laborum", "schemaPath": "dolor velit incididunt anim", "message": "non aliquip ut" }, { "keyword": "aliquip ut Lorem est ipsum", "instancePath": "id amet mollit", "schemaPath": "cupidatat dolore eu reprehenderit tempor", "message": "quis sed esse" }, { "keyword": "pariatur cupidatat ea", "instancePath": "consectetur Lorem", "schemaPath": "non sed nulla occaecat", "message": "ut" } ], "created_by": null, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 70706188.56939274, "y": 56486571.62678245, "gridCoordinate": { "x": 88777845.63363197, "y": -89242485.9056245 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -67548487.32307738, "finish_state": "error", "user": null }, "groups": [ { "_id": "399c322773bd551b23b22bc4", "provenance": "ex aute id", "name": "ex dolore tempor pariatur laboris", "description": "minim proident cillum aliqua non", "memberOf": [ { "groupId": "82766b60494235d441e61945", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia" }, { "roleId": "Ut in aliqua" }, { "roleId": "fugiat dolor dolor" }, { "roleId": "consequat anim officia reprehenderit" }, { "roleId": "magna laborum dolor sed exercitation" } ], "inactive": false, "_meta": { "created": "2003-06-17T03:26:19.743Z", "updated": "1987-12-27T16:40:44.817Z", "migrationVersion": 30500998 } } ], "iterations": [ "Fd8bceED-C1aD-9Cef-f1aC-0FBc48b08Dbc" ] }, "workflow_end": { "x": 17619334.031817406, "y": 65930869.982812315, "gridCoordinate": { "x": -73630499.81156924, "y": -64916085.650918774 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "workflow_end", "error_handler", "workflow_end", "workflow_end" ], "error": [ "workflow_start", "e28f", "workflow_end", "error_handler" ] }, "metrics": { "end_time": -47777715.71018281, "run_time": 10976643.538979262 }, "groups": [ "519d563292333e9d8124e934", "90eaef0ccac19ff529c51834", "2413fa7179689450a95aa2dd" ], "iterations": [ "E2e73BAE-09F9-796B-aea9-6c9A9C5CcaD1" ] }, "error_handler": { "x": 23776248.794895142, "y": 58904847.04900065, "gridCoordinate": { "x": 18012775.42870286, "y": 97510520.95436287 }, "name": "childJob", "location": "Adapter", "locationType": "aute", "app": "reprehenderit", "canvasName": "sed ut", "displayName": "eiusmod quis Excepteur proident", "summary": "consectetur sint occaecat cupidatat Excepteur", "description": "ut consequat aute enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/X4XwKuI7/Kf-" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "non amet", "highlightString": "enim reprehenderit" }, { "key": "culpa pariatur cillum ad", "highlightString": "consequat occaecat velit dolore culpa" }, { "key": "dolor pariatur sit consequat", "highlightString": "amet" }, { "key": "ut laboris ex enim id", "highlightString": "id sunt reprehenderit" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_end", "3a1f", "workflow_start", "3a1f", "3a1f" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "workflow_start" ], "error": [ "workflow_start", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "proident do eu", "start_time": "1995-10-07T19:20:24.768Z", "end_time": -12557448.100323886, "finish_state": "failure", "retrySettings": { "state": [ "failure", "success" ], "autoRetry": false, "limit": 9754005, "delay": 61131081, "count": 88611031, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ { "_id": "1daa382b239acb6abb84aeac", "provenance": "Ut velit ut", "name": "velit in do", "description": "amet labore irure velit anim", "memberOf": [ { "groupId": "53b996427d0587aa95b5f6ce", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor sunt voluptate officia" }, { "roleId": "ex id dolore" }, { "roleId": "commodo sunt" }, { "roleId": "aliquip incididunt" }, { "roleId": "dolor sit" } ], "inactive": true, "_meta": { "created": "1985-08-25T17:11:02.135Z", "updated": "2025-09-18T00:44:11.865Z", "migrationVersion": -26548150 } }, "default", "default" ], "iterations": [ "8DC1F8C4-a9AC-DcFF-1649-caE3c94DFc31", "42EfF319-3cE4-Fd78-b5fb-C64DdA126B58", "80ceea04-E078-Afd8-c800-0EAe653d99Ea" ] }, "02": { "actor": "job", "groups": [ { "_id": "7e8ba78ecb2c732ab3ba6dee", "provenance": "qui", "name": "dolor eu ut ut exercitation", "description": "adipisicing nulla ullamco amet", "memberOf": [ { "groupId": "d71ba5810e6ae493043a1ac5", "aaaManaged": false }, { "groupId": "4e9355f5302f8cde249dd01c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse reprehenderit" }, { "roleId": "tempor dolore quis deserunt qui" }, { "roleId": "tempor proident in pariatur" }, { "roleId": "ullamco nostrud consectetur" } ], "inactive": false, "_meta": { "created": "1998-10-23T04:43:06.389Z", "updated": "1962-01-22T13:09:01.07Z", "migrationVersion": -41582541 } }, "2ecf7123ba0762a23ceaa8c5", { "_id": "be60f73857fecd60e9dde63a", "provenance": "Excepteur adipisicing proident", "name": "culpa", "description": "cupidatat est Lorem", "memberOf": [ { "groupId": "dd9267b486b6bffc320953fc", "aaaManaged": false }, { "groupId": "5be5505394c9455131584b5f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Ut irure" }, { "roleId": "dolor" }, { "roleId": "Duis quis" }, { "roleId": "labore laborum Ut commodo" } ], "inactive": true, "_meta": { "created": "1976-04-07T23:02:08.638Z", "updated": "2003-08-16T09:08:14.229Z", "migrationVersion": -42452155 } }, { "_id": "7df57f700d97526d164ca598", "provenance": "eu reprehenderit", "name": "in officia in", "description": "Lorem ullamco quis incididunt ea", "memberOf": [ { "groupId": "f2c00146f2e737d5bb0be8c9", "aaaManaged": true }, { "groupId": "c22b0dea932263d905d871a9", "aaaManaged": true }, { "groupId": "88e6f457f5d6647d231cae62", "aaaManaged": true }, { "groupId": "167018fa41acd0cb79264a66", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis labore commodo" }, { "roleId": "exercitation tempor amet irure" } ], "inactive": true, "_meta": { "created": "2024-08-21T17:03:57.792Z", "updated": "2003-10-19T23:32:42.854Z", "migrationVersion": -56072987 } } ], "iterations": [ "bC5eC2B2-dAFf-c10e-a59F-d51aE9bbACF9" ], "x": -69557053.81804234, "y": -30836437.6125748, "gridCoordinate": { "x": 76193669.749264, "y": -42996990.493851684 }, "name": "in consectetur ex ut sit", "location": "Application", "locationType": "nisi", "app": "labore et", "canvasName": "childJob", "displayName": "esse aliqua non in veniam", "summary": "ipsum labore Lorem", "description": "est sit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/SdoLs/S97QJ/N.sa.dJ3/kewGHrfNtV" }, { "type": "encryption", "pointer": "/N4Uapo/~1/Qsl/~0/~1/U0N/~1/~1" }, { "type": "encryption", "pointer": "/~1/rcO8YQM/jpxb2qtd/~0/XGEgxh/~1/~0/~1/p1jcv" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "proident", "highlightString": "deserunt eu culpa qui non" }, { "key": "ipsum eu", "highlightString": "esse anim" }, { "key": "in sunt sed", "highlightString": "proident labore" } ], "status": "running", "previous": { "incomplete": [ "error_handler", "e28f", "workflow_start", "workflow_start", "error_handler" ], "complete": [ "e28f", "e28f", "e28f", "workflow_start", "workflow_end" ], "error": [ "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "Duis dolore culpa ullamco", "start_time": "1996-09-27T06:51:59.679Z", "end_time": -25997940.37741381, "finish_state": "success", "retrySettings": { "state": [ "error", "success", "error", "failure" ], "autoRetry": true, "limit": 71159026, "delay": 45599320, "count": 92366626, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": 22577919.32270959, "outgoing": [] }, "childJobs": [ { "_id": "laboris deserunt cillum", "name": "mollit culpa", "iteration": -59239582.85210844 }, { "_id": "aliqua aute commodo do cupidatat", "name": "fugiat in", "iteration": 46668100.13633102 }, { "_id": "ullamco adipisicing deserunt Ut exercitation", "name": "laboris minim cillum reprehenderit sunt", "iteration": -13030292.563992634 }, { "_id": "esse voluptate labore fugiat", "name": "laboris Excepteur officia", "iteration": 4092819.156315565 }, { "_id": "in magna cillum ea", "name": "labore", "iteration": -22090309.445763618 } ] } }, "parent": { "task": "consequat dolor", "iteration": 82745747.86208671, "element": -94877259.04360436 }, "errorHandler": null, "groups": [ "default" ], "watchers": [ "Pronghorn", "Pronghorn", "b09a6dc99506655915348f80", { "_id": "2cef09789687abd68eb1b672", "provenance": "sit", "username": "reprehenderit Ut minim in nostrud", "firstname": "cupidatat culpa et ad", "memberOf": [ { "groupId": "0ade1ce17be2310e8207ebc6", "aaaManaged": false }, { "groupId": "9fe0dd54554665133f9b3d73", "aaaManaged": true }, { "groupId": "d2b20e049cea4950abde7fa4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non id dolor culpa" }, { "roleId": "elit" } ], "inactive": false, "lastLogin": "1962-01-23T05:25:22.317Z", "_meta": { "created": "2007-09-29T21:11:13.133Z", "updated": "1963-08-27T00:29:57.737Z", "migrationVersion": 85747459 }, "email": "est quis esse ea Excepteur" } ], "metrics": { "start_time": -85272173.74099033, "progress": 0.2939654522948887, "end_time": 85643642.02495053, "user": "4ee0451c0567a31235531765", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }