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": "amet", "options": { "description": "Example job description", "type": "automation", "groups": [ "518cc067c1f70876030c3aa3" ] } }
{ "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": "5f474587fc497a7102ed1d39", "uuid": "70fa1061-1de3-a95c-c33b-4569a5fce564", "font_size": -4092494, "type": "automation", "created": "1972-05-20T23:07:18.803Z", "last_updated": "1952-05-21T08:16:51.913Z", "createdVersion": "7012596901.7.34093595", "lastUpdatedVersion": "218389501.0019730.3397", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 24162898, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -77254463.75202991, "sla": -12273414.567270577, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/y2Z9RQaipZX" }, { "type": "encryption", "pointer": "/~0/MPdd/~0/~0/bR9q/~1/~1/AEDH/pl4ZFA/hkkTk/V4" } ], "status": "canceled", "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 }, { "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": "sit est sunt" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "irure voluptate nulla veniam fugiat" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "adipisicing Lorem", "instancePath": "nostrud aute dolore commodo", "schemaPath": "adipisicing Ut deserunt", "message": "et dolore officia Duis do" }, { "keyword": "aliqua et sed", "instancePath": "labore sed minim mollit", "schemaPath": "mollit nisi do est deserunt", "message": "culpa sunt" } ], "created_by": null, "last_updated_by": { "_id": "ae1759fee5f7a9ee36ee7a1d", "provenance": "eiusmod", "username": "ipsum", "firstname": "voluptate", "memberOf": [ { "groupId": "cf5e20a200c9850512ddfbda", "aaaManaged": false }, { "groupId": "ad3fc5ef3b6fda4fe6ba452e", "aaaManaged": false }, { "groupId": "7b3d04f3dd8a6725f2a0af83", "aaaManaged": false }, { "groupId": "4689abb107d9e072c339846a", "aaaManaged": true }, { "groupId": "b0820af0835fd880c571ea02", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum ut laboris" }, { "roleId": "non occaecat Duis elit" }, { "roleId": "ut Duis proident" } ], "inactive": false, "lastLogin": "1996-07-14T18:07:06.595Z", "_meta": { "created": "1994-10-22T11:26:18.893Z", "updated": "2021-05-06T06:00:49.241Z", "migrationVersion": 12480852 }, "email": "dolor exercitation minim et" }, "tasks": { "workflow_start": { "x": -68274647.9024916, "y": -7546669.359183371, "gridCoordinate": { "x": -98995539.71338207, "y": -94074831.5084616 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -34149649.134913936, "finish_state": "error", "user": { "_id": "786a3a4deec74754106669a8", "provenance": "do officia veniam nulla", "username": "incididunt reprehenderit sint non culpa", "firstname": "consectetur id ipsum", "memberOf": [ { "groupId": "f3614bd6b009c84f36c46a76", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu" }, { "roleId": "sunt dolor in" } ], "inactive": true, "lastLogin": "1956-03-21T13:16:50.647Z", "_meta": { "created": "1961-04-25T07:26:40.53Z", "updated": "2000-10-07T09:39:55.193Z", "migrationVersion": 68639525 }, "email": "consequat minim" } }, "groups": [ "8122890d82a480be4c8d37ee", "default", "default", { "_id": "f0a21cf6b15da63270bb5bb8", "provenance": "consequat aliquip", "name": "sit dolor nostrud aliquip", "description": "in laboris", "memberOf": [ { "groupId": "2cb3031fb582ffd0a8f90d62", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam cillum mollit eiusmod" }, { "roleId": "ut anim dolor do aute" }, { "roleId": "dolore qui ea Lorem" }, { "roleId": "irure nulla ex" }, { "roleId": "laboris nulla mollit dolore sed" } ], "inactive": true, "_meta": { "created": "2017-05-21T06:08:14.659Z", "updated": "1963-12-13T12:49:43.224Z", "migrationVersion": -59190109 } }, { "_id": "9a42c70e014bf0d493178d8f", "provenance": "adipisicing eiusmod magna in culpa", "name": "deserunt laboris", "description": "ut exercitation", "memberOf": [ { "groupId": "c3154f0c9574be5918d041c7", "aaaManaged": true }, { "groupId": "b87e42e418e018810607cb83", "aaaManaged": false }, { "groupId": "c2579e146c2b18a009909c59", "aaaManaged": true }, { "groupId": "4208c6030a5ca5932dd1a15a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in aliquip sit elit" } ], "inactive": true, "_meta": { "created": "1982-08-11T13:12:33.373Z", "updated": "1988-06-23T10:18:43.597Z", "migrationVersion": 85871103 } } ], "iterations": [ "E91a2DA4-bF2B-c980-A78D-6abcE4b40acd" ] }, "workflow_end": { "x": 50802574.3187944, "y": -65866309.14414355, "gridCoordinate": { "x": 87648062.55771932, "y": -19069865.978934646 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "3a1f", "error_handler", "3a1f", "e28f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end", "3a1f", "workflow_start" ], "error": [ "error_handler", "3a1f" ] }, "metrics": { "end_time": -41938751.76866846, "run_time": 4931134.841252223 }, "groups": [ "default", "aa5593c6927f4fd093e46130", "default", "6eb9d93b4c9b263cbf81d951" ], "iterations": [] }, "error_handler": { "x": -22700483.071148843, "y": -95601682.3229509, "gridCoordinate": { "x": -29569299.396321386, "y": 26850200.2472025 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "aute", "canvasName": "adipisicing", "displayName": "consectetur et in", "summary": "magna sit in consequat", "description": "ullamco ipsum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/W/D6Eg/r/nCbryiQ/KX0SYYoFri" }, { "type": "encryption", "pointer": "/~0/Ss6BJ./vZ/L-/ExugsN2z/ZP.if/oiSeobxvlzz" }, { "type": "encryption", "pointer": "/~1/~0/~1/H/bM.1ANdhX/L8yH/fMzcS/~1/~1" }, { "type": "encryption", "pointer": "/nBfJ" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "eiusmod voluptate laborum", "highlightString": "dolore in anim" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "workflow_start", "e28f" ], "complete": [ "3a1f", "e28f", "workflow_end" ], "error": [ "workflow_start", "workflow_start", "3a1f", "workflow_end", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" } ] }, "serverId": "in", "start_time": "1990-01-29T20:31:05.175Z", "end_time": 64948846.56372228, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "f16642395a1af16979a97476", "provenance": "adipisicing", "name": "tempor", "description": "aliquip Ut eiusmod ut deserunt", "memberOf": [ { "groupId": "51cee68d040e163d9acac884", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum et ut" }, { "roleId": "proident" }, { "roleId": "minim cupidatat sint est ut" }, { "roleId": "ea laborum esse deserunt sunt" }, { "roleId": "nostrud fugiat id ex dolor" } ], "inactive": true, "_meta": { "created": "1987-05-28T13:54:09.221Z", "updated": "1965-06-24T09:23:53.465Z", "migrationVersion": -83232029 } }, "761efaa612f5067169bab06e", { "_id": "d97203a6f1bed77c866d4691", "provenance": "aliqua est esse", "name": "eu in labore est elit", "description": "dolor deserunt", "memberOf": [ { "groupId": "cbfa012bf748a38f8f3520e7", "aaaManaged": true }, { "groupId": "b3284cc0607924fc4914f445", "aaaManaged": true }, { "groupId": "86da6e678ae2e1a1bdddd468", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt quis" }, { "roleId": "in nisi eiusmod" }, { "roleId": "in eiusmod ad" }, { "roleId": "sed in anim nostrud adipisicing" }, { "roleId": "sit eu labore velit" } ], "inactive": false, "_meta": { "created": "1999-12-04T17:58:17.011Z", "updated": "1948-02-14T18:40:39.194Z", "migrationVersion": 18984036 } } ], "iterations": [] }, "a5a6": { "actor": "$var.job.tgcijMMqk", "groups": [ "79f0b1e5cb5d167b238d362f", "default" ], "iterations": [ "e2F7DFdC-2cB7-e2a5-d5AF-dE20DbDE6e09" ], "x": 4093373.456798494, "y": -84648145.17824993, "gridCoordinate": { "x": 70263355.32352933, "y": 73164490.45447215 }, "name": "ut aute", "location": "Adapter", "locationType": null, "app": "commodo labore fugiat nostrud", "canvasName": "nulla dolore Lorem veniam dolore", "displayName": "culpa", "summary": "exercitation", "description": "qui labore cupidatat ad", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/ADiTXCqp/n/UnosszD//~0/C" }, { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/w/~1/~0/yyfi/~1" }, { "type": "encryption", "pointer": "/~0/~1/Rth+E/CBeWt/bv8v77E/~1/q8XMyzqHb/dNbR" }, { "type": "encryption", "pointer": "/xx,1Nlb" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "laboris", "highlightString": "cillum id eu et" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start", "3a1f" ], "complete": [ "3a1f", "workflow_start", "e28f", "workflow_start", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" } ] }, "serverId": "sunt occaecat", "start_time": "2007-10-25T09:43:51.789Z", "end_time": 27710400.59863475, "finish_state": "error", "retrySettings": null, "type": "automatic" } }, "parent": { "task": "amet ut deserunt veniam", "iteration": -51796420.22607256, "element": -26147724.4095909 }, "errorHandler": { "actor": "job", "groups": [ "default" ], "iterations": [ "79891dEf-7942-1D9B-07e2-E5fe3B88Dc3C", "ce4Db6AB-C55F-723C-A8f0-62dfB57e4BaA" ], "x": -56005363.229354456, "y": 81443515.67235896, "gridCoordinate": { "x": 45987353.88710198, "y": 92612924.3151201 }, "name": "ea exercitation anim ut consequat", "location": "Broker", "locationType": "dolore", "app": "in sint sit ad exercitation", "canvasName": "in in nostrud culpa", "displayName": "est esse deserunt", "summary": "dolore minim aute veniam amet", "description": "ipsum deserunt aliqua", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "non aliqua esse aliquip laborum", "highlightString": "Lorem officia sed" }, { "key": "nulla Lorem dolor labore", "highlightString": "proident fugiat" }, { "key": "cillum", "highlightString": "nostrud" }, { "key": "dolor officia Lorem", "highlightString": "magna" }, { "key": "nulla enim aliqua dolore Duis", "highlightString": "laboris" } ], "status": "failure", "previous": { "incomplete": [ "workflow_end", "error_handler", "e28f", "3a1f", "e28f" ], "complete": [ "workflow_end", "workflow_start", "workflow_end" ], "error": [ "error_handler", "workflow_end", "e28f", "workflow_start", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "irure in Ut nisi commodo", "start_time": "1967-04-16T08:27:06.189Z", "end_time": -85256405.19166689, "finish_state": "success", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 73833160, "delay": 56530046, "count": 20237936, "finishedRetrying": true }, "type": "automatic" }, "groups": [ "38d082126dfc10d2faeb751d", { "_id": "9f209fc15278fe7fb6391a4a", "provenance": "sed anim", "name": "laborum occaecat Duis", "description": "mollit", "memberOf": [ { "groupId": "cdeceed6a9898377a70e3ef9", "aaaManaged": true }, { "groupId": "d5160fff9afe900345d7795b", "aaaManaged": false }, { "groupId": "5e362bfe7c77d37a1efe3913", "aaaManaged": true }, { "groupId": "6933ee463d49c927a32fe324", "aaaManaged": true }, { "groupId": "d3525636ee571bd404833ec6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco ea sed" }, { "roleId": "nisi Ut quis" } ], "inactive": false, "_meta": { "created": "2002-09-22T09:28:39.931Z", "updated": "1960-10-06T12:32:46.007Z", "migrationVersion": 57621296 } }, { "_id": "b4882796ed2e7b68f21f7df7", "provenance": "magna officia incididunt", "name": "sed ex magna anim tempor", "description": "ut occaecat", "memberOf": [ { "groupId": "fe0cab533bbc16d3e9429396", "aaaManaged": true }, { "groupId": "914ee9a305c1a051db882ede", "aaaManaged": false }, { "groupId": "75d5cc8bb60c6a51366e8a6a", "aaaManaged": true }, { "groupId": "1dc86be5637ab5186696fe54", "aaaManaged": false }, { "groupId": "b32079738314e6263b9ed22f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit aute" }, { "roleId": "mollit magna" }, { "roleId": "est labore aliquip" }, { "roleId": "dolor incididunt quis dolore" } ], "inactive": false, "_meta": { "created": "2024-11-24T13:03:18.657Z", "updated": "1988-02-26T10:23:31.182Z", "migrationVersion": -26627036 } }, { "_id": "ba9015fbc7265711b954cdfc", "provenance": "sint occaecat pariatur", "name": "culpa eiusmod nisi sint", "description": "laborum occaecat exercitation et", "memberOf": [ { "groupId": "35a71a2428b7d8c81c396392", "aaaManaged": false }, { "groupId": "65aad4df30de51c98b940418", "aaaManaged": false }, { "groupId": "f8c631a391f5a83d4bb7b92e", "aaaManaged": true }, { "groupId": "2fb51416333e9fa138a403d2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat nisi ipsum consequat" } ], "inactive": true, "_meta": { "created": "1993-06-24T22:44:06.06Z", "updated": "1980-11-15T15:26:54.351Z", "migrationVersion": -35366160 } }, "default" ], "watchers": [ { "_id": "ac73335e43aa5ca57f2d8ce0", "provenance": "dolor fugiat nisi Lorem labore", "username": "est esse", "firstname": "non proident enim", "memberOf": [ { "groupId": "834a4cfac0fa1968c0d79ef6", "aaaManaged": true }, { "groupId": "54a759e48c80e490ebc7b73c", "aaaManaged": false }, { "groupId": "5ea74c2596632e5a84ec262e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "est nulla" }, { "roleId": "commodo ipsum sint proident Lorem" }, { "roleId": "qui officia anim eiusmod dolore" } ], "inactive": true, "lastLogin": "2012-06-21T03:40:09.091Z", "_meta": { "created": "2021-11-06T08:40:18.127Z", "updated": "1978-04-21T22:23:03.671Z", "migrationVersion": -54307446 }, "email": "ut irure labore velit" }, "Pronghorn", "Pronghorn", { "_id": "d0a1cc5d42c988133a3b9e31", "provenance": "ea minim aliquip anim", "username": "aliquip", "firstname": "incididunt commodo", "memberOf": [ { "groupId": "8a310a140295095e51c4fd7a", "aaaManaged": true }, { "groupId": "bacfc3aa541e16d68c5faa83", "aaaManaged": false }, { "groupId": "914f6e41e7762d631a3701bf", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris consequat" } ], "inactive": true, "lastLogin": "1952-12-08T05:45:53.468Z", "_meta": { "created": "1949-02-14T22:20:21.554Z", "updated": "1975-12-06T08:13:24.125Z", "migrationVersion": -39569804 }, "email": "do in" }, null ], "metrics": { "start_time": -48874809.14895917, "progress": 0.4577169378481618, "end_time": 93134016.11666662, "user": { "_id": "cccf1536ad86a9adb72ed00b", "provenance": "quis sunt velit", "username": "magna non", "firstname": "ex nulla", "memberOf": [ { "groupId": "fec38c985b95ff713f2ed12f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis" }, { "roleId": "est" } ], "inactive": false, "lastLogin": "2019-07-15T14:40:40.482Z", "_meta": { "created": "1992-07-18T01:46:40.308Z", "updated": "2015-04-14T12:42:25.76Z", "migrationVersion": -23984142 }, "email": "reprehenderit ut" }, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }