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": "ut tempor", "options": { "description": "Example job description", "type": "automation", "groups": [ "2fbcbcd83e4873b853ed5ab1", "8e8199e1d70b5ecc1824d04a", "346bc6dfeaa7f4f62bc43557", "c1e8227cc71442dafa49fa22" ] } }
{ "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": "f0153edab914b5019d33ee85", "font_size": 8255248, "type": "resource:action", "created": "2010-12-09T19:49:13.578Z", "last_updated": "1952-01-09T05:12:18.105Z", "createdVersion": "510974019.8498019.77774586046", "lastUpdatedVersion": "99729.4717.5649244", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 39203443, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 21027849.185308203, "sla": 35193289.670642644, "decorators": [ { "type": "encryption", "pointer": "/u0/~1/b/ZVtCErle/~0/UFhuMmvM/d/HhJ/oI/U" }, { "type": "encryption", "pointer": "/~0/NDOI1-P,Gba/LwA83d2A/~1/~0/~0/asJXxa.V10/IikF/xgv/~1/oUB/8H7" }, { "type": "encryption", "pointer": "/yde/~1/jh6,1ssGkJt/e8T7pJ/~1" }, { "type": "encryption", "pointer": "/OJn/~1" }, { "type": "encryption", "pointer": "/EfkCa1DSREN/~1/QBup/Hr/Q4dj4/z5TbaSF/z./~0" } ], "status": "canceled", "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 }, { "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": "3a1f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "ipsum nostrud ex deserunt" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "velit laboris tempor eiusmod" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "in qui" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "commodo non magna" } ], "ancestors": null, "validationErrors": [ { "keyword": "ex laboris ut cupidatat", "dataPath": "fugiat laborum ipsum aute", "schemaPath": "minim exercitation qui voluptate culpa", "message": "nulla ea id" }, { "keyword": "in", "dataPath": "aute do velit voluptate Ut", "schemaPath": "officia", "message": "qui proident sint minim enim" }, { "keyword": "Lorem", "dataPath": "labore dolore", "schemaPath": "qui irure mollit", "message": "occaecat ad" }, { "keyword": "ea dolor anim cillum", "dataPath": "incididunt", "schemaPath": "velit labore ut consequat ut", "message": "sit laborum nulla laboris" } ], "created_by": null, "last_updated_by": "1f3fe7506fda8470b1bbae93", "tasks": { "workflow_start": { "x": -37476942.48242417, "y": -92414333.19770409, "gridCoordinate": { "x": -6873962.412234873, "y": -16025162.428312793 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -63431660.56627418, "finish_state": "success", "user": { "_id": "a730326b49876d7427a9db68", "provenance": "occaecat sint anim", "username": "enim mollit quis sit", "firstname": "enim fugiat laborum", "memberOf": [ { "groupId": "ab16684876b8c15baf367209", "aaaManaged": false }, { "groupId": "d9259c19c2fbca185e36adf1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat est dolore sed do" } ], "inactive": false, "lastLogin": "1981-10-25T11:15:27.802Z", "_meta": { "created": "1957-02-11T15:25:41.106Z", "updated": "2012-05-25T04:33:37.673Z", "migrationVersion": 32148859 }, "email": "ad cillum est voluptate" } }, "groups": [ "e217e69df66716a07b581c46", "default", "default", "default", "df77aecea7ef1abbcd45d25d" ], "iterations": [ "03756fff-F8D9-18ea-5FF3-1C911C9CdCA9", "aec820ed-b6Cc-F8E2-9F9e-55ccb76ef086", "C19A3fdA-4562-b2Ff-A80D-E7CEa4cFEbad" ] }, "workflow_end": { "x": -51496439.09611865, "y": 70057562.27330938, "gridCoordinate": { "x": 81123458.77964678, "y": 40593333.67687309 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler" ], "complete": [ "workflow_start", "3a1f", "e28f", "workflow_start" ], "error": [ "error_handler", "workflow_end", "3a1f", "workflow_start" ] }, "metrics": { "end_time": 18908215.32725036, "run_time": 30047930.217826575 }, "groups": [ "58de46ad12a81f88c398e843" ], "iterations": [ "0Fb1aEe5-f2DA-2D3c-a159-F0Af82AF4B1b", "Ae3fF9b5-8A17-dd81-E0C2-4ff73cB4E263", "eA47BD8B-c10D-eA79-3a89-f50b4e8dbAeC" ] }, "error_handler": { "x": -29860365.450534582, "y": -13777521.88525942, "gridCoordinate": { "x": 23870103.91610506, "y": 60574906.68497941 }, "name": "childJob", "location": "Application", "locationType": "cupidatat ad est", "app": "eu", "canvasName": "Duis pariatur incididunt laborum", "displayName": "cillum ea in", "summary": "anim sint", "description": "mollit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/nNa3A/Tyb/qVUyWU/d9/QzmlDYV/j9Km/RH6aRfj/grERJHh/Tye8b/~1/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "in aliquip Duis ullamco laborum", "highlightString": "sunt ad tempor laboris est" }, { "key": "reprehenderit minim voluptate aute aliquip", "highlightString": "cillum" }, { "key": "id in eiusmod proident", "highlightString": "Duis dolor in ipsum" }, { "key": "cupidatat eu", "highlightString": "incididunt magna commodo" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "e28f", "3a1f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end", "e28f" ], "error": [ "3a1f", "workflow_start", "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "esse sit laboris Lorem consectetur", "start_time": "2006-09-27T01:02:20.236Z", "end_time": -1960385.488630712, "finish_state": "error", "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 69844060, "delay": 19515380, "count": 55673829, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ "default" ], "iterations": [ "E07F041e-C33a-5dC6-0Bb9-7AC37fDAcc6E", "C4E72593-EdCb-Fdf8-B362-7E7705c678fE", "FEA0568c-C42e-A2cb-dEC9-ead9fDadfa3a" ] }, "9d0e": { "actor": "job", "groups": [ "default", "default", "262185e5ed17e2956f3511be", "default" ], "iterations": [ "FF0B23d6-90F5-CDA9-ae89-E2f4D9643f11", "913DE795-4059-5Dac-1E1A-5cBD93bD5dA5" ], "x": -64052465.400765345, "y": 44100518.60456386, "gridCoordinate": { "x": -22818778.928146794, "y": 9975522.601497337 }, "name": "sit veniam Duis", "location": "Application", "locationType": "sed sunt pariatur consequat", "app": "labore do dolor in", "canvasName": "childJob", "displayName": "sed veniam eu laborum elit", "summary": "nisi nulla", "description": "nostrud do quis culpa laboris", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/jyaZFG7/W/~1/ifAclI9/a/pbJ/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ipsum sint consequat ut eu", "highlightString": "aliquip minim enim commodo" }, { "key": "velit consectetur cillum minim", "highlightString": "incididunt" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "e28f", "error_handler", "e28f" ], "complete": [ "workflow_end", "3a1f", "workflow_start", "workflow_start" ], "error": [ "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "proident cupidatat veniam laborum", "start_time": "2007-09-06T11:33:52.498Z", "end_time": -21911279.57279648, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": false, "finishedCount": 5115113.543336228, "outgoing": [ "eu", null, null, "dolore aute commodo" ] }, "childJobs": [ { "_id": "cupidatat tempor elit", "name": "aute elit", "iteration": 65184048.0573675 }, { "_id": "ut amet", "name": "veniam dolor occaecat anim est", "iteration": -96642475.04197508 }, { "_id": "veniam eu sint consequat minim", "name": "Excepteur dolore nostrud", "iteration": 74852851.48383749 }, { "_id": "Lorem nulla cillum ut", "name": "Ut", "iteration": -62703342.02153678 }, { "_id": "cillum occaecat", "name": "Excepteur et", "iteration": -9386731.198596105 } ] } }, "parent": { "task": "consequat in amet", "iteration": 96854506.77750146, "element": 74834857.64947194 }, "errorHandler": { "actor": "job", "groups": [ "default", { "_id": "c073f6e161d134fa8c2fa115", "provenance": "laboris", "name": "pariatur", "description": "consequat aute dolore officia ullamco", "memberOf": [ { "groupId": "5ae820cf3eff13ed1046beae", "aaaManaged": false }, { "groupId": "291c613bc10bcfd95c4a3a8a", "aaaManaged": true }, { "groupId": "bbb3e1414439cba52bf4e307", "aaaManaged": false }, { "groupId": "e051a048e5b9acdb31abc183", "aaaManaged": false }, { "groupId": "abb2d6e1192c1a0b8996e86e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat" }, { "roleId": "voluptate esse do sunt" }, { "roleId": "do" } ], "inactive": true, "_meta": { "created": "1991-01-17T20:29:48.559Z", "updated": "2021-08-16T19:26:09.739Z", "migrationVersion": 8643448 } }, "51aff6e064d34867bca946c4" ], "iterations": [ "d818fE53-b13a-75F9-140E-aecBDeB320Ca" ], "x": -41303741.6513784, "y": 92624689.67094284, "gridCoordinate": { "x": 18355914.66228172, "y": 59264599.25114021 }, "name": "dolore", "location": "Broker", "locationType": "Duis ullamco proident", "app": "commodo", "canvasName": "childJob", "displayName": "Lorem", "summary": "anim", "description": "ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/cJ+RxDSqW9W/~1/wHf/qMLa/~1/he+IvvNgdsO" }, { "type": "encryption", "pointer": "/xULWK/C/EUBPo/~1/Jh-J.LSoKW/vF38Vl6uc/~1/~0" }, { "type": "encryption", "pointer": "/s/GQ/9TQQ9s/m" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "veniam incididunt exercitation", "highlightString": "Duis aliquip" }, { "key": "exercitation quis amet dolore qui", "highlightString": "Duis in pariatur" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "workflow_start", "workflow_start" ], "complete": [ "error_handler", "e28f", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "workflow_end", "3a1f", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "ipsum aute non", "start_time": "2000-06-14T05:25:18.179Z", "end_time": 64911128.55045703, "finish_state": "error", "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 88846159, "delay": 31741850, "count": 52885517, "finishedRetrying": false }, "loop": { "atLeastOneComplete": false, "finishedCount": 36374180.024167955, "outgoing": [ null, null, "incididunt officia aliquip" ] }, "childJobs": [ { "_id": "officia proident", "name": "occaecat nulla", "iteration": 70175742.90159202 }, { "_id": "veniam nostrud aute Excepteur", "name": "ullamco", "iteration": -62255199.56235916 }, { "_id": "dolor aliqua", "name": "sunt commodo est anim", "iteration": 67167306.190135 } ] }, "groups": [ "default" ], "watchers": [ "Pronghorn", { "_id": "41f4493687e380464bc892a9", "provenance": "occaecat minim sunt", "username": "sint non ea", "firstname": "aliquip tempor commodo amet ex", "memberOf": [ { "groupId": "5ce3ab6a9c13edc0fa936af1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat cillum" }, { "roleId": "velit" }, { "roleId": "ullamco aliquip minim in reprehenderit" }, { "roleId": "dolor est" } ], "inactive": true, "lastLogin": "1997-01-04T16:50:42.298Z", "_meta": { "created": "1950-04-15T12:58:22.482Z", "updated": "1981-06-18T07:07:42.701Z", "migrationVersion": -19287876 }, "email": "ut commodo culpa mollit" }, null ], "metrics": { "start_time": 4349377.839821681, "progress": 0.1719687151409468, "end_time": -21604312.053296983, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }