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": "adipisicing cillum dolor", "options": { "description": "Example job description", "type": "automation", "groups": [ "928476aa53476b0d4d4fd363", "4ce941bec077eb8372ad4fa6", "49033aeec7e16baac7b587f1" ] } }
{ "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": "e903e7b667609c4e3ef55159", "font_size": -29652319, "type": "resource:action", "created": "1981-03-24T00:24:29.558Z", "last_updated": "1974-11-13T08:03:42.355Z", "createdVersion": "0149.167466116.86-8741.7.85865.29782", "lastUpdatedVersion": "9500948950.0.45782-2708.4.732658.632", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -90162814, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -32593260.32876104, "sla": -81426815.30342917, "decorators": [ { "type": "encryption", "pointer": "/B0tnD/~1/eA/~0/~1/~0/~0/~0/~0/po/Tt.ex" }, { "type": "encryption", "pointer": "/~1" } ], "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": "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_end", "name": "myCoolDocumentName", "message": "in in aute Lorem" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "et" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "eb3135ca62aab21457a2b650" ], "validationErrors": [ { "keyword": "eu aliquip ex", "dataPath": "laborum ut sint reprehenderit eiusmod", "schemaPath": "ad dolor", "message": "ex do dolor eiusmod" }, { "keyword": "sunt velit laboris", "dataPath": "non minim pariatur", "schemaPath": "laboris ad elit mollit labore", "message": "eu eiusmod occaecat" }, { "keyword": "officia cupidatat", "dataPath": "commodo in est sunt ipsum", "schemaPath": "et exercitation dolore", "message": "Ut" }, { "keyword": "adipisicing nostrud eu", "dataPath": "ex quis eiusmod mollit in", "schemaPath": "in proident ipsum nulla", "message": "minim velit ea irure id" }, { "keyword": "amet in reprehenderit voluptate occaecat", "dataPath": "aliquip nulla nisi ut voluptate", "schemaPath": "aliqua adipisicing consectetur anim", "message": "Lorem" } ], "created_by": null, "last_updated_by": "edaec37ec1743d4674e2ea1c", "tasks": { "9": { "x": 53211616.10882288, "y": -32019286.615179703, "gridCoordinate": { "x": -41659571.3299881, "y": 23260876.979635283 }, "name": "ut velit elit", "location": "Application", "locationType": null, "app": "mollit nisi", "canvasName": "non est anim voluptate", "displayName": "anim aliquip amet tempor incididunt", "summary": "consequat dolor", "description": "dolor fugiat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~0/GMC/~0/UI/rxHYMwr" }, { "type": "encryption", "pointer": "/~1/OoZmg,/Lo/~1/rannRi/~0/ORK.kUiv3mo/ykLherx9gKT/OyvYsi/~1/fgbsh-pb3Mb/~1" }, { "type": "encryption", "pointer": "/~0/~1/N,gf262Uu.U/FeZpUb" }, { "type": "encryption", "pointer": "/b6I0fBtnb/~1/jxO/~0/MN/y/~1/IE5/g/~1" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "labore cupidatat tempor Lorem", "highlightString": "minim exercitation" }, { "key": "nisi est ad quis", "highlightString": "aute laborum" }, { "key": "cillum adipisicing ad culpa", "highlightString": "velit" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "error_handler", "e28f" ], "complete": [ "workflow_end" ], "error": [ "workflow_end", "workflow_end", "workflow_end", "error_handler", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "fugiat Lorem", "start_time": "1997-07-19T17:51:34.141Z", "end_time": 69033154.3010951, "finish_state": "success", "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 51804604, "delay": 83550255, "count": 57554266, "finishedRetrying": false }, "type": "operation", "actor": { "_id": "3649deac7242602dc0803ad9", "provenance": "in consequat ullamco occaecat tempor", "username": "exercitation reprehenderit", "firstname": "Excepteur laboris", "memberOf": [ { "groupId": "b3c4342b64c541ee77932307", "aaaManaged": false }, { "groupId": "5a9c13d61fefb7d253fdd066", "aaaManaged": true }, { "groupId": "d8131c375e58614615cc2b02", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu sed ut quis Lorem" }, { "roleId": "adipisicing deserunt reprehenderit sint sunt" } ], "inactive": true, "lastLogin": "1965-02-20T22:10:40.557Z", "_meta": { "created": "1992-09-04T11:27:34.378Z", "updated": "1986-04-30T08:49:58.68Z", "migrationVersion": 24201239 }, "email": "reprehenderit incididunt dolore" }, "groups": [ { "_id": "cd724a0eac54afd0f70193f9", "provenance": "anim culpa ipsum occaecat voluptate", "name": "mollit irure Lorem nisi", "description": "est", "memberOf": [ { "groupId": "f7cb7dce0f6a88b607dc2a37", "aaaManaged": true }, { "groupId": "caabe8fddf1508ca22c4ec2f", "aaaManaged": true }, { "groupId": "8d1d2fff7fc90331228f7093", "aaaManaged": false }, { "groupId": "e2dcfc8d38c8d2b436b8956b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident ea dolor Duis minim" }, { "roleId": "Excepteur aliqua quis eiusmod" }, { "roleId": "dolore quis sit" }, { "roleId": "nostrud" } ], "inactive": false, "_meta": { "created": "1955-04-21T20:39:29.598Z", "updated": "1967-08-22T06:43:12.571Z", "migrationVersion": 76503581 } }, { "_id": "7f6bb16c36d546db02404e30", "provenance": "dolore culpa cupidatat tempor est", "name": "nisi tempor commodo officia", "description": "est nostrud", "memberOf": [ { "groupId": "6fe92ec573a7be99cd2d5a34", "aaaManaged": false }, { "groupId": "82543671997ec115b938c06c", "aaaManaged": true }, { "groupId": "6b9d3206c78c78d419ed472a", "aaaManaged": false }, { "groupId": "a3133bf281787e2a0219adf0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia ullamco eiusmod mollit non" } ], "inactive": true, "_meta": { "created": "1983-05-21T00:11:40.289Z", "updated": "2011-09-07T16:17:00.376Z", "migrationVersion": 21232538 } }, { "_id": "bad22268a367f9a13e875c50", "provenance": "commodo ipsum deserunt", "name": "adipisicing dolor culpa labore", "description": "velit", "memberOf": [ { "groupId": "b0b0f49b0187236e8e54f204", "aaaManaged": false }, { "groupId": "d62f78845543ca78e32f02e6", "aaaManaged": true }, { "groupId": "72aa167cf879a9d978068727", "aaaManaged": true }, { "groupId": "e27ef8c6ea7cdd1e0613f04c", "aaaManaged": true }, { "groupId": "308ede021887ca660b2faf2f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis nulla tempor commodo occaecat" }, { "roleId": "est ex in" }, { "roleId": "eiusmod" }, { "roleId": "adipisicing magna occaecat dolore cillum" }, { "roleId": "proident minim cillum labore quis" } ], "inactive": false, "_meta": { "created": "1990-11-27T17:15:44.294Z", "updated": "2020-04-03T02:00:28.598Z", "migrationVersion": -86546292 } }, "4ada476322237525615e1d06" ], "iterations": [] }, "workflow_start": { "x": -92091968.08519171, "y": -58454618.875234, "gridCoordinate": { "x": 45577205.82647827, "y": -3563157.2225028723 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 77507068.41191936, "finish_state": "success", "user": "d3b01889cc5dd32f6cc8852f" }, "groups": [ "37d1d03145ef40153e9c516b" ], "iterations": [] }, "workflow_end": { "x": 28302562.725226596, "y": 83009212.71617544, "gridCoordinate": { "x": 90599582.67142427, "y": -20632398.888559192 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "error_handler", "error_handler", "workflow_end", "workflow_end" ], "error": [ "e28f", "workflow_end", "3a1f" ] }, "metrics": { "end_time": 80298744.03269163, "run_time": -96856322.52751417 }, "groups": [ { "_id": "281f56174f3bfffeb9ae74f4", "provenance": "deserunt", "name": "dolore adipisicing in dolor", "description": "minim elit fugiat", "memberOf": [ { "groupId": "f30cf749724af950f107f0df", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor non velit sit cillum" }, { "roleId": "pariatur officia dolore occaecat eiusmod" }, { "roleId": "do aliquip" }, { "roleId": "cupidatat" }, { "roleId": "eu adipisicing" } ], "inactive": true, "_meta": { "created": "1980-07-20T02:13:52.677Z", "updated": "1975-07-09T23:46:53.81Z", "migrationVersion": -35743991 } } ], "iterations": [ "9Cd58a1B-c36f-BEAe-5b32-0AB799c7e5e2" ] }, "error_handler": { "x": 24644628.119594187, "y": 39836927.27807453, "gridCoordinate": { "x": 99806319.21219772, "y": 53600884.09737182 }, "name": "childJob", "location": "Application", "locationType": null, "app": "laboris eiusmod", "canvasName": "elit quis magna culpa", "displayName": "Duis ut proident", "summary": "nostrud", "description": "nostrud tempor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/ZP33nKcU9v/~0/~1/~0/e,URbB/dMZ/cwh/XEHk.uD/GLjq5M1aB" }, { "type": "encryption", "pointer": "/~0/DpC,a/~1/j4B4YN46/~0/~1/L/SFv1lSW/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0/LehkDD6uO/~1/zt3WVr-s/~1/~1/~1/m-/tEs" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "exercitation voluptate", "highlightString": "deserunt" }, { "key": "sed reprehenderit eiusmod culpa", "highlightString": "ut Ut sint occaecat est" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_end", "workflow_end" ], "complete": [ "error_handler", "3a1f" ], "error": [ "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "occaecat reprehenderit culpa sit", "start_time": "1957-08-25T22:26:28.738Z", "end_time": 44169327.21507281, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "default", { "_id": "c3806a4beea51d048e386078", "provenance": "consectetur voluptate ad deserunt exercitation", "name": "ipsum", "description": "Ut ut dolore", "memberOf": [ { "groupId": "c56a44555bd6e304588be809", "aaaManaged": true }, { "groupId": "52e0e3c7ede351e1cb75fb67", "aaaManaged": false }, { "groupId": "46e4e3508ac6dd1925ee42ec", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore non aliqua voluptate deserunt" }, { "roleId": "tempor Duis" }, { "roleId": "dolore proident" }, { "roleId": "sunt cillum ex veniam" }, { "roleId": "velit in amet occaecat magna" } ], "inactive": true, "_meta": { "created": "2019-10-28T01:12:44.889Z", "updated": "1991-04-30T13:16:12.897Z", "migrationVersion": -97486056 } }, "default" ], "iterations": [] } }, "parent": { "task": "adipisicing proident exercitation", "iteration": 81364254.90067464, "element": 82827626.48661238 }, "errorHandler": null, "groups": [ { "_id": "64ffee936fc3720f37dac531", "provenance": "Excepteur dolore aute", "name": "in cillum laborum non", "description": "consequat aliqua id", "memberOf": [ { "groupId": "ce17239ea32a3f79a7fce108", "aaaManaged": false }, { "groupId": "19e8fa33585c68f0f0e4d3e1", "aaaManaged": false }, { "groupId": "974f0130fd3c2f7c1e877e41", "aaaManaged": false }, { "groupId": "f5e03f7427249bb1cb82ab18", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem occaecat adipisicing" } ], "inactive": true, "_meta": { "created": "1946-01-11T06:31:29.162Z", "updated": "2006-03-12T22:56:11.846Z", "migrationVersion": -22158441 } }, { "_id": "758b2f2ebb600b0468c46458", "provenance": "ea", "name": "sit reprehenderit labore laboris", "description": "officia quis", "memberOf": [ { "groupId": "c1bcdcab00242fcdd66302a5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco culpa magna officia nostrud" }, { "roleId": "magna ad in nisi anim" } ], "inactive": false, "_meta": { "created": "2014-10-12T00:07:58.378Z", "updated": "2022-03-15T19:22:16.958Z", "migrationVersion": 7698909 } }, "default", "a6d2959d16ab1f3a44ede2f5" ], "watchers": [ null ], "metrics": { "start_time": -31790018.153723672, "progress": 0.7719518457108818, "end_time": -65638262.67000788, "user": null, "owner": { "_id": "4f42991ec7111624f4e7cdd2", "provenance": "laborum", "username": "ullamco sit non", "firstname": "ipsum irure cupidatat nisi minim", "memberOf": [ { "groupId": "21505367ba6b71adc76bad4a", "aaaManaged": true }, { "groupId": "55b97766696b3cf05590ebd6", "aaaManaged": true }, { "groupId": "90e18b87edce8127a9d79347", "aaaManaged": true }, { "groupId": "8fd0962b491c6bc0af9914a5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis nulla deserunt sunt in" } ], "inactive": false, "lastLogin": "1977-01-27T14:28:06.389Z", "_meta": { "created": "2008-11-30T22:45:48.025Z", "updated": "1956-08-05T03:15:05.742Z", "migrationVersion": -91078666 }, "email": "reprehenderit" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }