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": "anim dolor occaecat quis", "options": { "description": "Example job description", "type": "automation", "groups": [ "a4ddc01ccfedda5cc861dd4c", "56d24ce18ae80cf9aabf07ca", "84a9e1905f6993307e97d85a", "081ace22003e09c8a8e405dc" ] } }
{ "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 imported 3 of 4 documents", "data": { "_id": "c0e8b12a73e4897e0cd45620", "font_size": -69602687, "type": "automation", "created": "1994-06-18T18:31:47.25Z", "last_updated": "1967-12-21T04:54:22.548Z", "createdVersion": "907535.7.754", "lastUpdatedVersion": "647512993.351215026.42142462-3245.86008083771.026372.846", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 74749315, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -95352718.46552531, "sla": -35032278.85965523, "decorators": [ { "type": "encryption", "pointer": "/~0/dM/~0/YL/~1/zn/LBupiUg9mWF/~1/uEap836Q9m/hevCjm/~0" } ], "status": "running", "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": "error_handler", "name": "myCoolDocumentName", "message": "cupidatat velit" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "deserunt magna amet cillum" } ], "ancestors": [ "923d49af97127e908af11d07", "e9e1f6dcb069104bf663bff5" ], "validationErrors": [ { "keyword": "ut", "instancePath": "magna adipisicing velit", "schemaPath": "id et proident sit", "message": "proident culpa est" }, { "keyword": "do minim", "instancePath": "ex dolor", "schemaPath": "velit nisi aliqua ullamco", "message": "enim Duis ex aliquip" }, { "keyword": "mollit labore in", "instancePath": "cupidatat commodo ex mollit culpa", "schemaPath": "ut aliquip magna enim nulla", "message": "in sint ullamco" }, { "keyword": "veniam irure", "instancePath": "Ut laboris minim aute tempor", "schemaPath": "cupidatat dolore", "message": "ex ut dolore sit" }, { "keyword": "dolore velit reprehenderit proident quis", "instancePath": "pariatur id consectetur Ut cillum", "schemaPath": "velit Lorem dolor", "message": "cupidatat" } ], "created_by": "ce35b145cd7da82fff583639", "last_updated_by": { "_id": "9b5288bf1e17eebcda8b970c", "provenance": "commodo magna et minim", "username": "mollit esse tempor", "firstname": "in enim velit exercitation ipsum", "memberOf": [ { "groupId": "b839dd7520656add1f082332", "aaaManaged": true }, { "groupId": "4af6c31249382584c15658e5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur" }, { "roleId": "in sit aliqua fugiat quis" } ], "inactive": false, "lastLogin": "1962-08-29T21:00:36.311Z", "_meta": { "created": "1989-09-24T09:26:07.691Z", "updated": "2018-03-11T18:39:05.769Z", "migrationVersion": 58095349 }, "email": "dolore" }, "tasks": { "workflow_start": { "x": -65732518.17031087, "y": 88914691.98903576, "gridCoordinate": { "x": -12243739.189508855, "y": -59367979.96559462 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 92979870.46550378, "finish_state": "failure", "user": { "_id": "8e6f1dc2f53249d0650e0b61", "provenance": "ad do ea in in", "username": "labore aute consectetur ullamco", "firstname": "occaecat", "memberOf": [ { "groupId": "07396e61b66470218a636c50", "aaaManaged": true }, { "groupId": "482fc9c4a99ebe2ae070331c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud nisi incididunt non" }, { "roleId": "ut ut" } ], "inactive": true, "lastLogin": "1962-10-02T03:41:02.19Z", "_meta": { "created": "2015-05-13T18:20:13.313Z", "updated": "1947-06-03T02:24:59.57Z", "migrationVersion": 53943043 }, "email": "laborum nulla elit" } }, "groups": [ "default" ], "iterations": [ "d6cEEEB7-fb4c-DA90-70cf-BDCeB5b06BCE" ] }, "workflow_end": { "x": -21812758.964681715, "y": -48093550.92491216, "gridCoordinate": { "x": 79503852.53545326, "y": 63830020.388748914 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "e28f" ], "complete": [ "3a1f", "workflow_start", "e28f", "e28f" ], "error": [ "e28f", "workflow_end", "workflow_start", "workflow_start", "3a1f" ] }, "metrics": { "end_time": -78195500.8830864, "run_time": -64532988.73207447 }, "groups": [ "ded143d4bffa34a5000af0c1", { "_id": "479a5e7e6a9b5dc2859dd986", "provenance": "laborum ullamco", "name": "Duis fugiat sunt", "description": "amet", "memberOf": [ { "groupId": "f9387d2e43c5f75931edfa2a", "aaaManaged": false }, { "groupId": "1c4bae48ede9c3fc6ef8d01a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore dolor anim ut" }, { "roleId": "tempor proident ut" }, { "roleId": "dolore" }, { "roleId": "amet sunt dolore" }, { "roleId": "sunt proident aute in" } ], "inactive": false, "_meta": { "created": "1992-02-28T17:54:23.554Z", "updated": "1974-10-05T04:09:05.864Z", "migrationVersion": -81841532 } }, "5e3aa5bac07d95ff1b2eba81" ], "iterations": [ "d1575e11-Bc11-29be-ccD9-5CeaCebFdD71", "dDc34Af6-5cdC-ebFb-ff57-AaaAc55FC1BF", "d4abAC74-9e0C-5abf-Ff25-b0cB4b5d2DAd" ] }, "error_handler": { "x": -4439671.242530212, "y": -58361734.93918637, "gridCoordinate": { "x": -50377191.96317449, "y": -54912417.55408547 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "in qui officia dolor", "canvasName": "fugiat Excepteur do ex", "displayName": "laborum cillum officia deserunt", "summary": "ullamco Ut dolor", "description": "in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/Tp5-,Pay/upy/Gq9C" }, { "type": "encryption", "pointer": "/bg4Ro.7" }, { "type": "encryption", "pointer": "/f60psXZN/~0/~1/~0/H/QBIn5uvA/yKl6gWHx" }, { "type": "encryption", "pointer": "/UKys/~0/~1/Lobnwf+B" }, { "type": "encryption", "pointer": "/DMY7cIa027//~1/~1/wjx0yzPMOn/hJ1/r/AJijMjW23r/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "eu officia", "highlightString": "sint aliqua amet" }, { "key": "tempor", "highlightString": "consequat dolor" }, { "key": "ad nostrud magna ea", "highlightString": "ea ut exercitation" }, { "key": "elit adipisicing minim nulla", "highlightString": "velit" }, { "key": "reprehenderit in proident veniam", "highlightString": "consequat ullamco nostrud aute" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "workflow_start" ], "complete": [ "e28f", "e28f" ], "error": [ "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "loop" } ] }, "serverId": "fugiat non ut dolor", "start_time": "1995-04-05T22:09:52.112Z", "end_time": 55487189.73886949, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "96b9689b0dfbed4b1fe6b415", "provenance": "in cillum consectetur enim ipsum", "name": "in laborum esse sit", "description": "sed in ea", "memberOf": [ { "groupId": "59de520e801909ed0f64a735", "aaaManaged": true }, { "groupId": "d65a15a3b38c76ecc10e25a6", "aaaManaged": true }, { "groupId": "420d5cce7e134d735f20bf51", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis ullamco irure aliqua adipisicing" } ], "inactive": false, "_meta": { "created": "2010-11-17T23:45:14.01Z", "updated": "1995-11-10T05:10:50.919Z", "migrationVersion": 45882785 } }, "193648ff07b7240d9a5f49c8" ], "iterations": [ "5d56dA88-9B7c-EA24-CCcA-41CddAdA12f5", "438753FD-BfA1-Ce47-7BAE-5e2bd3b14b9a" ] }, "4fd": { "actor": "Pronghorn", "groups": [ { "_id": "12ee4fecde5f57284f2e78f6", "provenance": "dolor aute magna sit", "name": "quis ipsum", "description": "voluptate occaecat magna culpa dolor", "memberOf": [ { "groupId": "ba8d2685a42b9260ca158eff", "aaaManaged": true }, { "groupId": "3a7943545aa2021d510f6621", "aaaManaged": true }, { "groupId": "6d1fa23e8caf1ec9d967967a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse ea culpa quis nisi" }, { "roleId": "laboris anim sed" } ], "inactive": false, "_meta": { "created": "1963-05-26T17:10:39.183Z", "updated": "1967-10-06T17:07:26.301Z", "migrationVersion": 24363713 } }, { "_id": "f7b02c7d8d3630e8c3968f10", "provenance": "velit deserunt Lorem anim", "name": "nisi officia Ut non", "description": "proident", "memberOf": [ { "groupId": "c3f1b6725402d211fae0a6df", "aaaManaged": false }, { "groupId": "9fd312a90fbabe9b77468dc6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut" } ], "inactive": true, "_meta": { "created": "2007-10-01T20:16:45.735Z", "updated": "2010-10-28T03:50:08.135Z", "migrationVersion": -32942458 } }, { "_id": "ec19363aa16fbd3801295f0a", "provenance": "ex minim dolor reprehenderit incididunt", "name": "eu fugiat officia dolor exercitation", "description": "sit aliquip minim", "memberOf": [ { "groupId": "317e932a3635c05df06a67cd", "aaaManaged": true }, { "groupId": "75516f8e03922dcf720cd2db", "aaaManaged": false }, { "groupId": "ffd9504d10be7960013a5e6e", "aaaManaged": false }, { "groupId": "734ad87b0a91bf91e4b47a30", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat velit" }, { "roleId": "cillum" } ], "inactive": false, "_meta": { "created": "1957-06-18T10:17:42.625Z", "updated": "2001-11-13T08:34:12.374Z", "migrationVersion": 54934885 } }, "default" ], "iterations": [ "82ab59c6-808A-E4fd-D9c9-1EE4E97cE0C6" ], "x": -48661528.633727126, "y": -53638047.308260985, "gridCoordinate": { "x": -14755700.542418689, "y": 39809471.661415994 }, "name": "eu mollit", "location": "Broker", "locationType": null, "app": "eu Duis in", "canvasName": "ut exercitation officia", "displayName": "Duis cillum anim elit", "summary": "Excepteur eiusmod in", "description": "amet", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/g/uaxVbmpdJdG/~0/~1/O/~0/~1/C0yvyK6/T4JHGR/RDDE" }, { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "laborum", "highlightString": "quis elit occaecat velit in" }, { "key": "in minim consectetur pariatur magna", "highlightString": "non minim" }, { "key": "ut dolore", "highlightString": "fugiat" }, { "key": "enim aliquip", "highlightString": "laboris ex mollit" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "error_handler" ], "error": [ "error_handler", "workflow_start", "workflow_end", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "velit occaecat dolor incididunt", "start_time": "1950-11-12T05:20:29.451Z", "end_time": 4746760.546377435, "finish_state": "failure", "retrySettings": null, "type": "automatic" } }, "parent": { "task": "sunt", "iteration": -90950176.92455287, "element": 22506543.719038293 }, "errorHandler": { "actor": "Pronghorn", "groups": [ { "_id": "85690c644e913f86e8529d1f", "provenance": "culpa reprehenderit", "name": "magna", "description": "sint nisi labore adipisicing", "memberOf": [ { "groupId": "7fafbc142bb82f5810456c8f", "aaaManaged": false }, { "groupId": "fb42df1175621822593ec82d", "aaaManaged": true }, { "groupId": "5c6db9db68cb6e5f0cf60087", "aaaManaged": false }, { "groupId": "d7268aec4b826839311ef6ec", "aaaManaged": false }, { "groupId": "649a80376c58f61fbab277b3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor quis" } ], "inactive": true, "_meta": { "created": "1951-01-17T00:55:39.934Z", "updated": "2003-01-14T23:18:54.306Z", "migrationVersion": -29192949 } }, "default" ], "iterations": [ "cfd9e4Ad-DF1C-5FB7-6eB1-354F9DAa083F", "9d33e731-dDa3-62B7-C5dA-FABfE3e3F020" ], "x": -52211316.38840704, "y": -23419609.477943614, "gridCoordinate": { "x": -8142015.406398028, "y": -54064814.820019566 }, "name": "reprehenderit", "location": "Application", "locationType": "dolor dolor do aliquip consectetur", "app": "irure", "canvasName": "eu Duis laborum cupidatat", "displayName": "sed Excepteur consectetur voluptate", "summary": "nisi", "description": "minim nostrud deserunt culpa reprehenderit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/~1/~1/yf+z/jMoqur36" }, { "type": "encryption", "pointer": "/xAX/TSugLg/nmjpTfJ/pCCbo1gI3ub/~1/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "in est", "highlightString": "ut magna" }, { "key": "Duis anim magna consectetur", "highlightString": "ea amet" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "3a1f", "workflow_start", "e28f" ], "complete": [ "workflow_start", "error_handler" ], "error": [ "3a1f", "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "aliqua Ut deserunt Excepteur qui", "start_time": "1965-07-04T02:34:17.145Z", "end_time": 68870146.18109539, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "groups": [ "default", { "_id": "91d61a2d16248a444e8f885a", "provenance": "ea velit irure et", "name": "aute sint deserunt sunt qui", "description": "id proident Excepteur sint", "memberOf": [ { "groupId": "9ebc0357f6f2cb735b32d83c", "aaaManaged": true }, { "groupId": "426a23dddd79be3f3cd94ec9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed amet dolore reprehenderit" }, { "roleId": "cupidatat est ad" } ], "inactive": true, "_meta": { "created": "1987-01-25T09:22:32.204Z", "updated": "2007-09-03T22:29:38.594Z", "migrationVersion": -26313791 } }, { "_id": "7b509417918a5944968f57de", "provenance": "nisi Lorem do est", "name": "ea cupidatat officia ad", "description": "velit laborum officia", "memberOf": [ { "groupId": "2683ddfc6f70e1ace22c5038", "aaaManaged": true }, { "groupId": "36c0c442f4430e04cb3cbbce", "aaaManaged": false }, { "groupId": "c42732139b0958db94a1fd31", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in sit do officia" } ], "inactive": true, "_meta": { "created": "1949-10-09T22:52:44.935Z", "updated": "1977-11-19T12:06:07.839Z", "migrationVersion": 70778101 } }, { "_id": "a91a01dc3c1b68c0abd84fe0", "provenance": "nostrud consequat est quis", "name": "dolore nulla commodo dolor incididunt", "description": "dolor mollit commodo amet", "memberOf": [ { "groupId": "2c0d1f2bf72e70d788a4ab09", "aaaManaged": true }, { "groupId": "ddecd05887a043ba0b88edd8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing" } ], "inactive": true, "_meta": { "created": "2024-10-31T12:37:12.341Z", "updated": "2015-03-19T06:07:32.308Z", "migrationVersion": 52166668 } }, "0cbf11e3370cee198799e35e" ], "watchers": [ "Pronghorn", "c9150868332805972e6adb04" ], "metrics": { "start_time": 343539.34305530787, "progress": 0.08405186317211011, "end_time": 25492287.863099426, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }