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": "ad", "options": { "description": "Example job description", "type": "automation", "groups": [ "5cd69de114af36cbeab1552b", "6ac2575f9a2e482931c328c8", "33bd70b4e04b37d1d6737b7c", "25a78a161f1dd5e0e4e8139b" ] } }
{ "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": "3e69704d4db3a21a95e8507d", "font_size": 50830266, "type": "automation", "created": "1986-08-10T23:16:08.712Z", "last_updated": "1952-03-06T17:54:16.392Z", "createdVersion": "6188.92811499285.8342204091-1216.25085289.756", "lastUpdatedVersion": "773.2.58-5166.4603.4.57732794526", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 61225068, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -53508905.0842124, "sla": 83551324.99851191, "decorators": [ { "type": "encryption", "pointer": "/NT/dASNRz5/eAq+usX8OX/txU4VZ/bzlqgh86uh/~0/~0/Wlf/T0P8Dwzr/eD972r/BJju" }, { "type": "encryption", "pointer": "/~0/wI5MWM7Q1/drgb.PZx4/JLcSFFDwAD/y8WQbJSm/FLp/~1/G70w" }, { "type": "encryption", "pointer": "/~0/doz2tI/~1/k933PyJGSf/~1/U/~0/L/ZoKea0TH0s4/V33l" }, { "type": "encryption", "pointer": "/~0/YPjObO/~1" }, { "type": "encryption", "pointer": "/A4XgUJo/bKKqB,G//~0/sgKOk6I/~0" } ], "status": "error", "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": "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": "e28f", "name": "myCoolDocumentName", "message": "quis est" } ], "ancestors": null, "validationErrors": [ { "keyword": "nostrud dolore", "instancePath": "ex sint adipisicing", "schemaPath": "Excepteur sunt cillum dolor consectetur", "message": "consectetur amet tempor laboris est" }, { "keyword": "proident eu Duis nostrud", "instancePath": "nulla proident", "schemaPath": "adipisicing officia Ut", "message": "ut nisi velit" } ], "created_by": { "_id": "1a758dae0d89dcfe94e20112", "provenance": "anim mollit", "username": "est nostrud irure officia", "firstname": "reprehenderit cupidatat ut voluptate", "memberOf": [ { "groupId": "be55a5aa8b1b225d19998894", "aaaManaged": false }, { "groupId": "65a63b8f406a72b600fa4d0c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id Excepteur dolor officia" }, { "roleId": "elit pariatur" }, { "roleId": "mollit ea irure Excepteur" }, { "roleId": "dolor id" } ], "inactive": false, "lastLogin": "2017-08-19T19:37:55.069Z", "_meta": { "created": "1992-02-05T07:43:46.697Z", "updated": "2010-12-22T14:52:25.603Z", "migrationVersion": 80889187 }, "email": "eu incididunt eiusmod cillum et" }, "last_updated_by": "71f5a49105d13355ecce7b7b", "tasks": { "workflow_start": { "x": 10423291.807861373, "y": -7833417.598158434, "gridCoordinate": { "x": -94748951.0655343, "y": 96713757.54699814 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 35146299.09611085, "finish_state": "failure", "user": { "_id": "626e4065512ce739de06f9a1", "provenance": "do reprehenderit", "username": "mollit", "firstname": "do commodo ut", "memberOf": [ { "groupId": "eb039f095e3e7ee150d6f3d0", "aaaManaged": false }, { "groupId": "ff05fc0c0782f6f658f7435c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est sint veniam voluptate" }, { "roleId": "incididunt occaecat nulla minim Ut" }, { "roleId": "eiusmod nulla" }, { "roleId": "Excepteur adipisicing quis occaecat" } ], "inactive": false, "lastLogin": "2004-07-07T12:18:00.451Z", "_meta": { "created": "2017-08-27T23:42:36.611Z", "updated": "1958-02-04T19:43:32.582Z", "migrationVersion": -78195898 }, "email": "occaecat ea voluptate exercitation" } }, "groups": [ "default", { "_id": "693d3b57999536fb96ff1fad", "provenance": "in est ipsum id", "name": "in veniam adipisicing", "description": "consectetur", "memberOf": [ { "groupId": "4eb076410d8a87039f83cac0", "aaaManaged": false }, { "groupId": "917cea905eee4ef6409d75fc", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "voluptate dolor non commodo" }, { "roleId": "in eiusmod amet dolor cillum" }, { "roleId": "exercitation" }, { "roleId": "deserunt ipsum veniam occaecat" }, { "roleId": "anim laboris ipsum ut id" } ], "inactive": true, "_meta": { "created": "2023-09-12T17:49:53.093Z", "updated": "1973-12-17T05:28:01.585Z", "migrationVersion": -9215231 } } ], "iterations": [] }, "workflow_end": { "x": -19365313.70069976, "y": -83856352.16973588, "gridCoordinate": { "x": -12448213.575389698, "y": -18690188.03642741 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler", "error_handler", "3a1f" ], "complete": [ "error_handler", "e28f", "3a1f", "workflow_start", "workflow_start" ], "error": [ "workflow_start", "e28f", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": -89688670.15430324, "run_time": 23753462.00141348 }, "groups": [ "d4e99b618e04a0913d677005" ], "iterations": [ "94eD2fCc-c0D4-4FA7-5d72-B3Deabf30E9B", "9DDB6eD3-Ac55-DB2b-88AA-CbEA16e3c3Da", "4CF9De90-53fd-8CBc-f0e8-CAdFAaEBd15A" ] }, "error_handler": { "x": 84327643.65991029, "y": 62036133.827880055, "gridCoordinate": { "x": 9117382.225333735, "y": -24565821.563177347 }, "name": "childJob", "location": "Application", "locationType": null, "app": "exercitation eu fugiat est", "canvasName": "aute", "displayName": "culpa do", "summary": "ad do eiusmod anim veniam", "description": "dolor ad pariatur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/IdE06/b/dHf" }, { "type": "encryption", "pointer": "/~0/XK/EhZlUorqQpm/LTpiH/daSxIA6/~0/~0/~1/~0/J5qL.QY" }, { "type": "encryption", "pointer": "/al.iL8T/Vy1eB/~0/~0/aZ" }, { "type": "encryption", "pointer": "/~0/~1/M4/9Uz+1/FVmpUS/~0/rxD0zc3u/KkQQk9RNs/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolore", "highlightString": "aliquip aliqua quis" }, { "key": "Excepteur ullamco deserunt voluptate", "highlightString": "voluptate aliquip adipisicing deserunt est" }, { "key": "Excepteur minim", "highlightString": "dolore amet" }, { "key": "laboris aute aliqua nisi eiusmod", "highlightString": "mollit in non minim" } ], "status": "incomplete", "previous": { "incomplete": [ "e28f", "workflow_start" ], "complete": [ "3a1f", "e28f", "workflow_start", "workflow_end" ], "error": [ "workflow_end", "error_handler", "e28f", "workflow_end", "3a1f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "occaecat sunt incididunt ullamco sint", "start_time": "1971-01-01T05:05:04.393Z", "end_time": 24674077.204733625, "finish_state": "failure", "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 85858018, "delay": 53622382, "count": 21325210, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "6af4f06d42e463edbef5919d", "provenance": "commodo consectetur ea ipsum", "name": "labore veniam", "description": "culpa nulla Duis", "memberOf": [ { "groupId": "24c30760c05f414a31601fb6", "aaaManaged": false }, { "groupId": "8d4b90bb39620152b678ef3a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit" }, { "roleId": "veniam consequat" }, { "roleId": "consectetur enim ad" }, { "roleId": "irure nostrud" } ], "inactive": false, "_meta": { "created": "1971-09-30T10:16:34.577Z", "updated": "1963-01-29T13:55:54.139Z", "migrationVersion": -40172343 } }, "c188ac924f4be805a5f5e2bf", "default", "default" ], "iterations": [ "0dADbcf7-b3E8-F4Ae-dbe9-8055aC60A174", "59c7dF93-0cdB-992b-a734-bf4B6Bc30C13" ] }, "8c": { "actor": null, "groups": [ "default", { "_id": "20c5bc60d4db3580dbcb5ecb", "provenance": "sint et", "name": "in dolore", "description": "est dolore eu consequat deserunt", "memberOf": [ { "groupId": "c9580b695cebb4775a37e651", "aaaManaged": false }, { "groupId": "8cab34932e591e34be91f23d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in non Ut" } ], "inactive": true, "_meta": { "created": "1944-05-31T15:13:15.093Z", "updated": "1957-09-06T11:55:31.254Z", "migrationVersion": -15711202 } }, { "_id": "9a211e896a6ae81217c42760", "provenance": "adipisicing reprehenderit occaecat", "name": "laboris ut", "description": "sint in laborum", "memberOf": [ { "groupId": "9ffe7bbf6580eb38ab64db89", "aaaManaged": false }, { "groupId": "efe25e701ba5cca53f2e8a29", "aaaManaged": false }, { "groupId": "4608d8f69e8303812ee23da4", "aaaManaged": false }, { "groupId": "31d2756620b83bb744cc83c7", "aaaManaged": true }, { "groupId": "56faf1191cee00e523b5ff79", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris veniam" }, { "roleId": "commodo dolor" }, { "roleId": "laborum nisi esse" }, { "roleId": "ut mollit aute" } ], "inactive": false, "_meta": { "created": "1972-12-02T23:45:45.81Z", "updated": "1971-07-30T06:20:20.55Z", "migrationVersion": -25665371 } }, "c6df017d8c441ef960d64c85", "default" ], "iterations": [ "3AaFA74e-24B3-2D49-2EfE-CAAc5C27699d" ], "x": -90407445.91600989, "y": 28713125.82331887, "gridCoordinate": { "x": -93886752.52751124, "y": 34218311.045549095 }, "name": "pending", "summary": "qui Lorem laborum reprehenderit", "description": "consequat minim Lorem ipsum aliqua" } }, "parent": { "job": "occaecat amet sit ad in", "task": "ad laborum dolor nostrud", "iteration": -82362481.16728646, "element": 4100216.56216681 }, "errorHandler": null, "groups": [ "f338fde79a040a1d93e872ec", "default", "default" ], "watchers": [ "Pronghorn", "6f1f8c4f74e9ffdc8843fd11", { "_id": "6ed22043fec9b2c9312ad7fd", "provenance": "cupidatat ut do laborum", "username": "cillum aute ex dolor", "firstname": "fugiat", "memberOf": [ { "groupId": "e09e71551b8ab1b9bdb28cf4", "aaaManaged": true }, { "groupId": "36c13ee96999049ef9122b32", "aaaManaged": false }, { "groupId": "023165971a9db14b6533c24c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor consequat amet nulla enim" }, { "roleId": "id ullamco ea velit" }, { "roleId": "in quis mollit ullamco voluptate" }, { "roleId": "sit enim consectetur in cupidatat" }, { "roleId": "do cillum ad nisi" } ], "inactive": true, "lastLogin": "1955-04-08T01:49:51.552Z", "_meta": { "created": "1994-10-19T12:34:10.646Z", "updated": "1965-10-10T13:29:18.591Z", "migrationVersion": 27615422 }, "email": "magna pariatur deserunt eiusmod quis" }, "ee120add59f696cb6ee9a417", "df6f5c6a57d936a80d82f850" ], "metrics": { "start_time": 73560442.59687778, "progress": 0.23342350947931045, "end_time": 78072058.37881362, "user": null, "owner": "28d5eaf89d59f43ffd95af2d" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }