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": "aute dolore in dolore sed", "options": { "description": "Example job description", "type": "automation", "groups": [ "a292da8fbc4cf1b5bd206c97", "3d3f1cadccd3658bc7d39e82", "6afc7eb5ae00084b639943b7", "4ec834b47ad7331103e3f5f2" ] } }
{ "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": "6da54b6e9d73642c4abdbbce", "font_size": -66535568, "type": "automation", "created": "1969-11-02T01:54:58.152Z", "last_updated": "1993-11-11T01:57:02.796Z", "createdVersion": "613.5725222.6-3646.7.2547.42", "lastUpdatedVersion": "50644.983936.9-5237.545.37.3755247946", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -49613940, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 82009041.2185874, "sla": -14388275.075542629, "decorators": [ { "type": "encryption", "pointer": "/~1/d/j19EsDPf/Wgh/~1/~1/~1/nSVyNj" }, { "type": "encryption", "pointer": "/~1/gluxfmy/~0" }, { "type": "encryption", "pointer": "/A9f355DEmG//~0/~0/eTWM/qll2iuPzLoC/vAfVsh/~0/~1" } ], "status": "running", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "laboris occaecat ipsum qui" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "cupidatat qui" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "id laborum incididunt" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "sed" } ], "ancestors": null, "validationErrors": [ { "keyword": "nostrud quis", "instancePath": "do aute consectetur dolore", "schemaPath": "nostrud nisi in ad dolor", "message": "Excepteur in magna Duis" }, { "keyword": "ullamco esse laborum dolore", "instancePath": "culpa aliqua", "schemaPath": "aliqua qui non", "message": "fugiat sit cillum" }, { "keyword": "ea irure sit fugiat cillum", "instancePath": "do ad reprehenderit", "schemaPath": "dolore", "message": "cillum" }, { "keyword": "dolore sit", "instancePath": "aliquip", "schemaPath": "eu amet nulla nostrud", "message": "occaecat nostrud dolor" } ], "created_by": null, "last_updated_by": null, "tasks": { "workflow_start": { "x": 89950506.38785934, "y": -15820570.908846274, "gridCoordinate": { "x": -61209036.005699866, "y": 20451134.588769555 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -53085950.299345486, "finish_state": "error", "user": "657ca1efb195fe4e3867015a" }, "groups": [ { "_id": "861ff6448d55c60defd198ed", "provenance": "incididunt minim", "name": "magna consectetur velit dolor tempor", "description": "laborum", "memberOf": [ { "groupId": "b91b39596bee32ac27155bef", "aaaManaged": true }, { "groupId": "897132aee3164b499152bae9", "aaaManaged": true }, { "groupId": "f4bf993833b98b5ecd40ee1f", "aaaManaged": false }, { "groupId": "b93e54de33c5dccf1466d757", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur Excepteur" }, { "roleId": "Lorem" }, { "roleId": "est ea id aliqua" }, { "roleId": "pariatur" }, { "roleId": "dolore ex Duis fugiat tempor" } ], "inactive": false, "_meta": { "created": "2006-01-15T07:34:29.877Z", "updated": "2012-10-21T09:00:59.018Z", "migrationVersion": 27466374 } }, "fbf15d065f0e7dee114bb820", "3bf267f936bd5f4c8e5956e7", "2d2ede687882ef99cb6d85b4", "85f2cb3b4e490e455b06a3ad" ], "iterations": [ "aA60dB99-bFf1-DeBC-9AD6-bb9FE644C1ad" ] }, "workflow_end": { "x": -95888357.47287332, "y": -87835890.00400007, "gridCoordinate": { "x": 50856151.10475895, "y": 33280315.940571412 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_start", "error_handler" ], "complete": [ "3a1f", "workflow_start", "workflow_start", "workflow_start" ], "error": [ "error_handler", "workflow_start" ] }, "metrics": { "end_time": 91696301.27379996, "run_time": -79074856.06345941 }, "groups": [ { "_id": "4a538a8b20be9d2cc01a5067", "provenance": "dolor ullamco dolor sed aute", "name": "ea irure", "description": "Duis", "memberOf": [ { "groupId": "4738d061f4e02a47fd5fcab7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt eu Ut minim proident" }, { "roleId": "nostrud consectetur" }, { "roleId": "cillum" } ], "inactive": false, "_meta": { "created": "1957-04-28T03:56:57.598Z", "updated": "2020-06-05T20:09:06.589Z", "migrationVersion": -83154412 } }, { "_id": "77794818e5b2dae00d56c41b", "provenance": "occaecat anim ullamco", "name": "nostrud", "description": "laborum Duis", "memberOf": [ { "groupId": "9898e37f0d98ed9b123ab5d1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco" }, { "roleId": "do aliquip esse" }, { "roleId": "consequat et" }, { "roleId": "ea dolore" }, { "roleId": "in nulla cupidatat id" } ], "inactive": true, "_meta": { "created": "1962-02-10T14:15:26.051Z", "updated": "1973-12-09T01:31:46.286Z", "migrationVersion": -67166998 } }, "35fa0f38a3949496f0f38621" ], "iterations": [ "ef02593E-A4FF-ed5F-f318-0a57C8696BFf", "1b2B6c87-C6bE-6F35-EF85-F5108d6059fB", "D8b154E7-2Dfc-a012-6FFf-B2BDaE788e7F" ] }, "error_handler": { "x": 74406302.53182676, "y": 36856662.832314044, "gridCoordinate": { "x": -76049085.71695392, "y": -64909876.55653808 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "cupidatat adipisicing ut amet minim", "canvasName": "adipisicing est id ad", "displayName": "esse labore nostrud ut", "summary": "velit", "description": "eu eiusmod in laboris do", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/~0/~0/~1" }, { "type": "encryption", "pointer": "/I.-v151X2.q/~1/~0/nats,8W/~1/~1/KXGhER/~0/cVJm" }, { "type": "encryption", "pointer": "/ExL5jP+s.f/~0/~0/~0/S..yT5qwf/oTidc/Ko9kD/~0/~1/~1/~1" }, { "type": "encryption", "pointer": "/wT0LSuR/J-Ys7jBDuD/aFtP99r" }, { "type": "encryption", "pointer": "/~1/DMuLUZ/bOHTjMHVA/~1/qhuh" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "quis labore Lorem", "highlightString": "fugiat et consequat ex sunt" }, { "key": "nulla voluptate ut eu", "highlightString": "est Lorem adipisicing amet" }, { "key": "ad", "highlightString": "mollit cillum" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "error_handler", "3a1f", "error_handler", "3a1f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end", "error_handler", "e28f" ], "error": [ "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "id aliquip quis enim et", "start_time": "1961-02-11T16:39:16.909Z", "end_time": 4968680.590686336, "finish_state": "success", "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 89164077, "delay": 1622777, "count": 92052685, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ "default", "ae8d13a86596b41f346ce9c2", { "_id": "82eee84ce700426b7eca02f5", "provenance": "laboris Lorem", "name": "veniam laborum est fugiat Excepteur", "description": "exercitation magna", "memberOf": [ { "groupId": "5e991fe6b3035fbd03cdd538", "aaaManaged": true }, { "groupId": "4edf97735d48850e439fe7b9", "aaaManaged": true }, { "groupId": "5b2762eed01630360dfd88f2", "aaaManaged": true }, { "groupId": "d7395bc3295c0f34ec9212ed", "aaaManaged": false }, { "groupId": "abdc49efd425d8a65ae5cb4f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum velit adipisicing veniam" }, { "roleId": "nisi ut in aute" }, { "roleId": "esse cupidatat ut amet deserunt" } ], "inactive": false, "_meta": { "created": "1995-05-25T06:59:39.477Z", "updated": "2012-04-01T16:30:23.453Z", "migrationVersion": -17316684 } } ], "iterations": [] }, "ff70": { "actor": "5121b8e0d2f22cb00ae16864", "groups": [ "c1c3e8faa1e0f2e6b6779ef8", { "_id": "1b4f3c070cf11ddf6441c5da", "provenance": "dolore id adipisicing nulla", "name": "fugiat", "description": "aute Ut mollit id quis", "memberOf": [ { "groupId": "b0edf7f854ff55d75f5fb630", "aaaManaged": false }, { "groupId": "f42a44489f8df1cddf4f8c8a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in magna" }, { "roleId": "eiusmod ad consectetur fugiat Ut" } ], "inactive": false, "_meta": { "created": "1981-03-06T15:14:01.834Z", "updated": "1955-06-29T13:55:11.258Z", "migrationVersion": -18407611 } }, "8cced8767387ce44c39ee8f5" ], "iterations": [ "e1E728af-fD37-cf5C-5ffe-4d45efcC9810", "2aD0cbA3-9e98-86E9-4AeF-cca347EbbE0e", "FcA5Db51-0D77-0C6D-6A48-67de184dCD1e" ], "x": -89166010.18021955, "y": -10879943.396572277, "gridCoordinate": { "x": -78879056.66653867, "y": 4120537.798899278 }, "name": "pending", "summary": "fugiat velit", "description": "sit elit commodo" } }, "parent": { "task": "Lorem voluptate reprehenderit minim cillum", "iteration": 60600241.20500022, "element": 13890408.857516065 }, "errorHandler": null, "groups": [ "default", { "_id": "7047e60d727a93c860d19cd2", "provenance": "nulla enim ipsum dolor elit", "name": "sit minim labore", "description": "proident pariatur Ut", "memberOf": [ { "groupId": "856a8a9753c7ab3ff696a459", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur sint id" }, { "roleId": "cupidatat et non ipsum" }, { "roleId": "reprehenderit consectetur dolore aute incididunt" } ], "inactive": false, "_meta": { "created": "1984-07-14T03:50:28.22Z", "updated": "1992-10-04T07:01:45.006Z", "migrationVersion": 46863384 } }, "4cd9a655f37e1d2367d0cc0f", "b4b14fb2b64a8a50f81890d9" ], "watchers": [ null, null, null, "Pronghorn" ], "metrics": { "start_time": -74916117.14328568, "progress": 0.40358879390056246, "end_time": 59545481.57066485, "user": "d851382c6406e512086641a6", "owner": "0e21bfb5e817d4856a6261fb" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }