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": "consequat quis", "options": { "description": "Example job description", "type": "automation", "groups": [ "d45c92378f77b96c13b2ce3c", "d114e865fbb360c226348867" ] } }
{ "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": "3d0c7068dd1b7221458cb0f6", "font_size": 4674438, "type": "resource:action", "created": "2012-11-30T21:36:14.451Z", "last_updated": "2013-01-26T16:23:03.163Z", "createdVersion": "62359.7.08909683928", "lastUpdatedVersion": "448482.1.48", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 54290710, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -56507791.50081004, "sla": 78647821.93967587, "decorators": [ { "type": "encryption", "pointer": "/~1/n6nwL/Y08Vyj/m/m+xwM/jLo0qC,NZJl/nr/0tpMb/~1/Uxd/pSTOX3/~0" } ], "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": "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", "message": "nulla aliqua" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": [ "c4b6023fcffce77b2ed4185b", "a4ce35ad52de509ab4949056", "831c835dd6ff6b8cf5c0a5d3", "fb859c71344d71be3232c99b" ], "validationErrors": [ { "keyword": "deserunt proident ut dolore", "dataPath": "eu et commodo sunt", "schemaPath": "dolor sunt", "message": "laborum dolore incididunt occaecat cillum" } ], "created_by": { "_id": "4ee3ec2b00773e6f547e96d3", "provenance": "esse laborum", "username": "quis mollit", "firstname": "ut laboris sed", "memberOf": [ { "groupId": "0e50ca6446be81a5c44c83ad", "aaaManaged": false }, { "groupId": "ad99223cda0614f73daf3008", "aaaManaged": false }, { "groupId": "68d2d7857d6436da1fd48edf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet in sint" } ], "inactive": true, "lastLogin": "1956-03-30T16:38:25.49Z", "_meta": { "created": "2021-05-25T20:55:08.266Z", "updated": "1981-05-16T06:06:13.174Z", "migrationVersion": -61583032 }, "email": "nostrud consequat fugiat laborum" }, "last_updated_by": null, "tasks": { "workflow_start": { "x": 90452215.08298588, "y": -90800831.692881, "gridCoordinate": { "x": 59856787.268759966, "y": 20746419.15840347 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 66661583.238574, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "89e5a37d9eb13164ddf61de9", "default", "default", "67034c7fd20fb06bb9e3cbf9", "787b683d09ff524928f47d7f" ], "iterations": [ "ef5dd7Ce-4f8a-86E9-21eE-eb8fAA4B0BAd" ] }, "workflow_end": { "x": -68270692.65711322, "y": -23431773.627408653, "gridCoordinate": { "x": 46669765.56050214, "y": -39331982.18149636 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_start" ], "complete": [ "e28f" ], "error": [ "workflow_start", "e28f", "3a1f", "workflow_end", "workflow_start" ] }, "metrics": { "end_time": 15716841.694482714, "run_time": -33220883.24513133 }, "groups": [ { "_id": "c5578c46ea99d2a94a920f7b", "provenance": "ipsum consequat veniam aliqua magna", "name": "deserunt cillum aliqua veniam", "description": "ullamco aliqua", "memberOf": [ { "groupId": "adc47dc821422bdf88e1f7de", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "magna" }, { "roleId": "cupidatat ad amet" }, { "roleId": "eu nisi nulla tempor" }, { "roleId": "exercitation veniam" } ], "inactive": true, "_meta": { "created": "1963-05-01T06:49:53.77Z", "updated": "2000-01-09T16:40:19.588Z", "migrationVersion": 79537228 } }, "default", "default", "7a920353caf9da3371aed867" ], "iterations": [] }, "error_handler": { "x": 77460618.1437389, "y": -33896558.483181804, "gridCoordinate": { "x": -19350341.491883636, "y": 67948893.90347233 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "in ullamco Lorem", "canvasName": "dolor dolore proident ut do", "displayName": "cupidatat consequat Duis sit", "summary": "laboris adipisicing mollit eiusmod aute", "description": "enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/hiw/ot7DON96bG,/~1/~0/YBD63iwi5/~0/~1/~1/~0/Rts+rkKslJ/CQQ0w1y2" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "nostrud", "highlightString": "nisi aliquip" }, { "key": "incididunt qui exercitation cillum dolor", "highlightString": "exercitation Duis culpa Excepteur" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler" ], "complete": [ "workflow_start", "e28f" ], "error": [ "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "in incididunt aliqua Excepteur labore", "start_time": "2024-03-08T15:18:25.341Z", "end_time": 23444554.612170875, "finish_state": "error", "retrySettings": { "state": [ "error", "success", "error", "success" ], "autoRetry": false, "limit": 8617806, "delay": 12289402, "count": 60961553, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ "f00027d3c9e294062182076d", { "_id": "8d8bc2fee4ca7c64d78d2941", "provenance": "minim labore", "name": "non commodo dolor enim", "description": "est voluptate sed", "memberOf": [ { "groupId": "ca0f1d1d93c9a2fed955475f", "aaaManaged": true }, { "groupId": "612e88f52fc9132bdf166f15", "aaaManaged": false }, { "groupId": "1f0c820295fc4691579a6283", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem consequat in" }, { "roleId": "do amet occaecat" }, { "roleId": "fugiat nostrud" }, { "roleId": "officia nisi commodo non" }, { "roleId": "mollit Excepteur" } ], "inactive": false, "_meta": { "created": "1963-02-17T10:35:37.04Z", "updated": "1989-01-26T12:16:32.273Z", "migrationVersion": 37627980 } }, "default", { "_id": "308665e03a13417730571046", "provenance": "qui occaecat", "name": "ut in", "description": "ex sint cillum", "memberOf": [ { "groupId": "73592fabbb9e41dc3e1f91c9", "aaaManaged": false }, { "groupId": "6b912f2566166da0c1a9628b", "aaaManaged": false }, { "groupId": "43d6aa9531513671b178adec", "aaaManaged": true }, { "groupId": "b2fb703495a286502d74b232", "aaaManaged": true }, { "groupId": "7cedc85190ca043bd06afed2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit nostrud laborum" } ], "inactive": false, "_meta": { "created": "1978-12-25T16:58:11.793Z", "updated": "1974-06-01T01:50:00.999Z", "migrationVersion": -12881700 } }, "default" ], "iterations": [] }, "6fab": { "actor": "job", "groups": [ "default", { "_id": "0d980ab0720708ad7fdd9fbb", "provenance": "Duis magna elit dolor exercitation", "name": "sit Duis velit reprehenderit Ut", "description": "labore minim", "memberOf": [ { "groupId": "d410e59136f157332a050077", "aaaManaged": false }, { "groupId": "c649d28ff19aa56da9ec1aa7", "aaaManaged": false }, { "groupId": "9e1c34364a41c8cf3bbf8deb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut nostrud" } ], "inactive": true, "_meta": { "created": "2021-06-05T23:18:13.926Z", "updated": "1986-03-26T11:38:07.668Z", "migrationVersion": -10044742 } }, "default", { "_id": "256023fdf0f9357ed622cbc7", "provenance": "dolor", "name": "qui amet consequat cillum incididunt", "description": "nulla ut minim Duis tempor", "memberOf": [ { "groupId": "fe1eff98040f07e7a7be6be7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non do laboris magna" } ], "inactive": false, "_meta": { "created": "1951-09-28T11:00:09.906Z", "updated": "1965-12-08T14:11:02.922Z", "migrationVersion": -78244766 } }, "21057f584fd2b03476646c4b" ], "iterations": [ "0716e68b-9FD3-C6fC-aAad-BE6650EaBf82", "86ddF200-af6d-2c6B-DeBc-4A96c83a6Aaa" ], "x": 27724132.48320502, "y": -64863682.25806416, "gridCoordinate": { "x": 27599461.433719918, "y": 81400200.2170052 }, "name": "nulla laboris", "location": "Application", "locationType": "amet", "app": "enim qui id", "canvasName": "eu esse adipisicing mollit", "displayName": "aliquip officia", "summary": "minim laborum", "description": "aliqua ex", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/xAQ58-rAq/zQpSzDbNN/cZ850eg/PC/Wqfe3VAWImy/~0/~0/g-ikGG" }, { "type": "encryption", "pointer": "/~0/I/-3/~1/~0/Kez4IW3/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0/~0/X.UC/P4jLyG/~1/~0" }, { "type": "encryption", "pointer": "/~0/~0/A0U.I-Mqcwx/U4/QB/XQnZjGQ6cS/~1/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "consectetur deserunt est proident", "highlightString": "Duis" } ], "status": "error", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "3a1f", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "consectetur ex Lorem pariatur", "start_time": "1999-06-01T04:43:10.76Z", "end_time": -12369216.12915656, "finish_state": "success", "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 44470247, "delay": 61928800, "count": 53173511, "finishedRetrying": true }, "type": "manual", "view": "adipisicing officia ex non" } }, "parent": { "task": "laborum sunt commodo cupidatat et", "iteration": -94327172.4060938, "element": -60011275.42233937 }, "errorHandler": null, "groups": [ { "_id": "58df1ce70cd20d116d4684cc", "provenance": "cillum reprehenderit non sunt", "name": "laboris veniam quis", "description": "est Ut eiusmod dolor dolore", "memberOf": [ { "groupId": "5433f19bd3fdaf596cf08059", "aaaManaged": false }, { "groupId": "3bf889363a3aef99ab510110", "aaaManaged": true }, { "groupId": "761eb1558bb0e3a598e65bda", "aaaManaged": false }, { "groupId": "a95abcd44675a9e39d576915", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "commodo id" }, { "roleId": "eiusmod cupidatat adipisicing dolor aliqua" }, { "roleId": "commodo laborum et sint" }, { "roleId": "pariatur" } ], "inactive": false, "_meta": { "created": "2014-05-26T02:14:05.027Z", "updated": "2000-04-28T07:23:44.376Z", "migrationVersion": -40372316 } }, "4cc80f99d1bc2daf456da756", "5dfb7ed4bfe13d18dbccbfb0", "default" ], "watchers": [ "3eb6879a7074493606a633c4", "Pronghorn", "Pronghorn" ], "metrics": { "start_time": 69674992.43214771, "progress": 0.058613375093481634, "end_time": 72727766.21474347, "user": "80376f5194773cf3c1e51d86", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }