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": "velit esse consequat ad dolore", "options": { "description": "Example job description", "type": "automation", "groups": [ "b0bc20ec3a3e5e90bac881e7", "7d5f0cb5c6a629ea14324d9b" ] } }
{ "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": "e50522881ea9a0ecaa56caae", "uuid": "d9431cdc-e37e-f3f8-1165-afd0b2c14be4", "font_size": 38334896, "type": "resource:compliance", "created": "1946-09-14T03:26:20.553Z", "last_updated": "1959-05-08T06:28:13.787Z", "createdVersion": "5407788943.3477.284189415", "lastUpdatedVersion": "2769902590.1700323884.86722008494-6789.460.52", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 32552974, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -62521415.69503476, "sla": 32676749.883926794, "decorators": [ { "type": "encryption", "pointer": "/~0" } ], "status": "complete", "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "Ut sunt amet consectetur" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "veniam deserunt" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "in aliqua", "instancePath": "dolore culpa exercitation dolore", "schemaPath": "non Duis ad", "message": "nostrud laboris" }, { "keyword": "ut labore voluptate", "instancePath": "in nostrud exercitation dolore occaecat", "schemaPath": "ullamco consectetur irure sunt", "message": "nisi quis dolor" }, { "keyword": "deserunt officia id", "instancePath": "non Lorem occaecat ut", "schemaPath": "magna aute eiusmod consequat sed", "message": "cillum ipsum fugiat" }, { "keyword": "cupidatat velit", "instancePath": "esse Duis", "schemaPath": "Duis in dolor officia", "message": "aliqua Excepteur Duis" } ], "created_by": "7a85c5b7bce5608827f802c0", "last_updated_by": { "_id": "1743e7d6514c613b685da7b9", "provenance": "velit cillum", "username": "anim ipsum eu labore", "firstname": "amet sint in", "memberOf": [ { "groupId": "89ced318ad7d9fdad1cd6cc0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui Lorem" }, { "roleId": "nulla" }, { "roleId": "tempor" } ], "inactive": true, "lastLogin": "1980-07-20T20:51:32.913Z", "_meta": { "created": "2008-09-24T11:02:15.473Z", "updated": "1976-06-26T12:19:11.316Z", "migrationVersion": 9744219 }, "email": "eu" }, "tasks": { "5": { "actor": "job", "groups": [ "37aca919495416b75cf97077", "default", { "_id": "666d4be6e853893848fd3aa3", "provenance": "magna sunt est dolor", "name": "consequat Excepteur", "description": "exercitation mollit", "memberOf": [ { "groupId": "9bacf4527aae281d04d564af", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute incididunt dolore" }, { "roleId": "exercitation irure fugiat occaecat sint" }, { "roleId": "non" }, { "roleId": "aute aliqua sint Ut eu" } ], "inactive": true, "_meta": { "created": "1994-05-20T01:55:59.409Z", "updated": "1990-12-11T08:37:17.759Z", "migrationVersion": 89957190 } }, { "_id": "de1a2b1b792e24eece563ccc", "provenance": "esse anim", "name": "adipisicing aute ea", "description": "Excepteur", "memberOf": [ { "groupId": "f468650d18860469edf9312b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Excepteur ut laboris ipsum officia" }, { "roleId": "ex" } ], "inactive": true, "_meta": { "created": "1953-11-15T11:54:07.647Z", "updated": "1989-06-14T17:05:05.182Z", "migrationVersion": 62745721 } }, "default" ], "iterations": [], "x": 89911127.98390016, "y": -29245383.708046585, "gridCoordinate": { "x": -57906283.001334645, "y": -94167421.0923456 }, "name": "mollit", "location": "Application", "locationType": null, "app": "velit", "canvasName": "childJob", "displayName": "in dolore do id culpa", "summary": "in elit", "description": "amet irure", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/TfHSvr+/~0/VEf/~0/~1/ggz-SeBTmf/lrW./FX/~0" }, { "type": "encryption", "pointer": "/acpK3ql/hPB7iiGAI/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "nostrud in", "highlightString": "aute" }, { "key": "aute quis ut esse", "highlightString": "Duis sint cillum" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "3a1f" ], "complete": [ "3a1f" ], "error": [ "3a1f", "workflow_start", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "deserunt sit voluptate in", "start_time": "1968-05-29T22:00:04.486Z", "end_time": 16418215.966790274, "finish_state": "error", "retrySettings": { "state": [ "success", "error", "failure", "failure" ], "autoRetry": true, "limit": 2664117, "delay": 6069946, "count": 41355543, "finishedRetrying": false }, "loop": { "atLeastOneComplete": false, "finishedCount": 28987088.95045416, "outgoing": [] }, "childJobs": [ { "_id": "cillum est dolore Ut", "name": "nostrud", "iteration": 43904676.50283748 }, { "_id": "sint", "name": "exercitation", "iteration": -32027591.71525158 }, { "_id": "anim", "name": "est cillum commodo", "iteration": -94086742.84777492 } ] }, "workflow_start": { "x": -86382864.88546933, "y": 78140411.79694131, "gridCoordinate": { "x": 4779281.793687984, "y": -66568867.16362167 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 79733834.68101564, "finish_state": "success", "user": { "_id": "0cc02e789fda8637394fe94a", "provenance": "occaecat", "username": "Ut ut", "firstname": "do", "memberOf": [ { "groupId": "75fe62a99dc63aba44e6d42e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing aliqua reprehenderit" }, { "roleId": "aliquip fugiat Excepteur dolore incididunt" } ], "inactive": false, "lastLogin": "1992-12-09T17:22:49.916Z", "_meta": { "created": "2002-09-01T10:10:27.758Z", "updated": "1950-07-14T10:47:29.055Z", "migrationVersion": -26484754 }, "email": "sed anim" } }, "groups": [ "default" ], "iterations": [ "9C264116-55e6-1f98-ab96-773C30cf97Cf", "7cFD890b-FF5F-d6aD-bA70-8653A4BcFbC1", "eE9C4842-9Dcc-b041-3FEf-13DfECfdB1CB" ] }, "workflow_end": { "x": 16042907.009600028, "y": -64686203.928719886, "gridCoordinate": { "x": 44557388.79564232, "y": 31604376.76992233 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "workflow_end", "workflow_start", "e28f", "workflow_start" ], "complete": [ "3a1f", "e28f", "workflow_start", "error_handler" ], "error": [ "workflow_end", "e28f", "error_handler" ] }, "metrics": { "end_time": -80340285.60529608, "run_time": 31552618.735040918 }, "groups": [ "0b417b1f1c772e2e6a280cb0", "default" ], "iterations": [ "aBC67cf5-8C9B-3bC8-3f77-91cdFa2be98a" ] }, "error_handler": { "x": -48656596.656157, "y": 20135085.64213349, "gridCoordinate": { "x": 45417770.75247246, "y": 45303292.56783867 }, "name": "childJob", "location": "Adapter", "locationType": "dolor enim fugiat ea laborum", "app": "et", "canvasName": "laboris ipsum est amet qui", "displayName": "laboris esse dolor", "summary": "dolor in", "description": "deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/IK3J7" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "in Duis ut", "highlightString": "Lorem elit eu culpa officia" }, { "key": "veniam Duis dolor ea sunt", "highlightString": "dolore" }, { "key": "nulla", "highlightString": "anim est laborum" }, { "key": "sunt", "highlightString": "sed eu" }, { "key": "consequat elit et pariatur nostrud", "highlightString": "mollit" } ], "status": "scheduled", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "sed fugiat Ut id cupidatat", "start_time": "1948-02-16T15:33:34.992Z", "end_time": 21100586.09113978, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": null, "groups": [ "92b65017b9fcdd29d09563cd", { "_id": "c58b150855bbb81b83da3bf2", "provenance": "ipsum id ea laborum", "name": "ullamco", "description": "nostrud occaecat", "memberOf": [ { "groupId": "cdcca658198e99e5a3d3bf41", "aaaManaged": false }, { "groupId": "b4d7d442b0da447660555912", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt ex cupidatat aliqua" }, { "roleId": "ea sed" } ], "inactive": false, "_meta": { "created": "1976-07-01T17:56:49.724Z", "updated": "2004-12-18T16:03:26.731Z", "migrationVersion": 95906762 } }, "92bf380fbc2cdf59c09fab13", "default", "default" ], "iterations": [] } }, "parent": { "task": "velit nostrud", "iteration": 49281801.7907919, "element": 23361006.50337833 }, "errorHandler": { "actor": "1ba818beb15ed03410d6c7ea", "groups": [ { "_id": "34b0bc6be81b6f9e9b94b107", "provenance": "dolor", "name": "labore cillum et ut", "description": "incididunt officia dolore exercitation", "memberOf": [ { "groupId": "b1ae4532e064076c5981a971", "aaaManaged": false }, { "groupId": "e22322b5a034b76a23707302", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore non" }, { "roleId": "sunt" }, { "roleId": "sit voluptate" }, { "roleId": "ex nulla Duis" }, { "roleId": "consectetur ut do in" } ], "inactive": true, "_meta": { "created": "1951-02-16T15:44:46.887Z", "updated": "2025-04-22T16:05:19.069Z", "migrationVersion": -33972318 } } ], "iterations": [ "f93DA5df-DBc3-77C2-d73f-Aaa13157B7F4", "7Ff1aaf7-34AC-CC27-B2Be-81cd6e599aC4" ], "x": -58159474.30619102, "y": 54279393.09119135, "gridCoordinate": { "x": -12697641.656986207, "y": -20687347.75820999 }, "name": "id ut consectetur pariatur", "location": "Adapter", "locationType": null, "app": "in anim ex", "canvasName": "childJob", "displayName": "in", "summary": "proident", "description": "Ut ut cupidatat in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolor dolor officia", "highlightString": "ea occaecat anim labore" }, { "key": "in magna", "highlightString": "consectetur" }, { "key": "laborum do consectetur culpa", "highlightString": "esse minim id" }, { "key": "culpa ut id", "highlightString": "deserunt" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "3a1f", "e28f", "3a1f", "e28f" ], "complete": [ "3a1f", "3a1f", "e28f" ], "error": [ "workflow_start", "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "do", "start_time": "1984-04-29T17:34:12.676Z", "end_time": 14001549.232002482, "finish_state": "error", "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 47340888, "delay": 96342207, "count": 59953130, "finishedRetrying": true }, "loop": { "atLeastOneComplete": false, "finishedCount": -18134078.91991426, "outgoing": [] }, "childJobs": [ { "_id": "minim anim Duis in", "name": "laborum", "iteration": -88082078.66609403 }, { "_id": "magna", "name": "non mollit", "iteration": 50821683.27477166 } ] }, "groups": [ "default", { "_id": "e184362e19ed114f47271762", "provenance": "occaecat aliquip ad nostrud eu", "name": "Excepteur ad sed", "description": "deserunt et ipsum irure aliquip", "memberOf": [ { "groupId": "630d61515de21595ff8ca64e", "aaaManaged": true }, { "groupId": "1d486d53e53b62cc6fa811bc", "aaaManaged": false }, { "groupId": "36891d07e03be994af3070a5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim incididunt magna dolor" } ], "inactive": true, "_meta": { "created": "1996-02-29T08:52:14.073Z", "updated": "2016-07-04T00:09:24.055Z", "migrationVersion": 55784047 } } ], "watchers": [ "afcf7ee9cb8fb6d14d71b510", "Pronghorn", "29910aa7b89fb59a2b4497ee", { "_id": "d3d7de123392c496ee56fd46", "provenance": "ut ex sunt", "username": "elit dolor", "firstname": "magna", "memberOf": [ { "groupId": "e7badad101004cc19d676c05", "aaaManaged": true }, { "groupId": "c36e33a08a36389c8ade0ba8", "aaaManaged": true }, { "groupId": "83be2745f4a2b1975dc59dc0", "aaaManaged": true }, { "groupId": "822866d7db6b65f3a0713ea5", "aaaManaged": false }, { "groupId": "2545bc74b6bc68c586eb8357", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris aute Ut" }, { "roleId": "Duis culpa occaecat reprehenderit" }, { "roleId": "eu labore minim adipisicing voluptate" } ], "inactive": true, "lastLogin": "1990-06-02T13:16:26.06Z", "_meta": { "created": "1973-06-25T11:00:22.355Z", "updated": "2024-02-11T00:07:44.581Z", "migrationVersion": 89237364 }, "email": "in deserunt" }, "Pronghorn" ], "metrics": { "start_time": -34810693.800186686, "progress": 0.8322850586880013, "end_time": 33075146.024853826, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }