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": "dolore adipisicing", "options": { "description": "Example job description", "type": "automation", "groups": [ "ee5ff9d5aa796c399207e493" ] } }
{ "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": "29aa072f26174ece2755836a", "font_size": 73557368, "type": "automation", "created": "1946-04-10T23:14:00.111Z", "last_updated": "1989-09-16T19:14:53.795Z", "createdVersion": "675754290.65642829437.6069374935-2111.7770.29.974", "lastUpdatedVersion": "75569180320.1502144.5256-8401.7428.92", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -57940753, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 3368564.99977687, "sla": 33007766.064831793, "decorators": [ { "type": "encryption", "pointer": "/wO0wM/~1" }, { "type": "encryption", "pointer": "/~1/~0/~1/~1/~0/OxlwRv7yb/~0/HUbBmC/cs,/EGAb" } ], "status": "error", "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": "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": "e28f", "name": "myCoolDocumentName", "message": "veniam ullamco" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "cupidatat dolore" } ], "ancestors": null, "validationErrors": [ { "keyword": "officia", "instancePath": "fugiat cillum ut Lorem dolor", "schemaPath": "culpa do", "message": "Excepteur in magna ipsum" }, { "keyword": "aliquip", "instancePath": "magna", "schemaPath": "qui laborum Excepteur", "message": "proident consectetur commodo sunt consequat" }, { "keyword": "Duis", "instancePath": "ut consequat amet ut", "schemaPath": "in", "message": "nostrud" }, { "keyword": "nulla", "instancePath": "dolore exercitation deserunt", "schemaPath": "nostrud et", "message": "aliqua non nulla cupidatat anim" }, { "keyword": "adipisicing deserunt", "instancePath": "culpa dolore sint anim ullamco", "schemaPath": "Excepteur", "message": "culpa in deserunt" } ], "created_by": "badbb197eec0e1d21df0ac91", "last_updated_by": { "_id": "e683450ea6f2253010f27d78", "provenance": "minim incididunt ea", "username": "ex reprehenderit aute dolor", "firstname": "Lorem voluptate", "memberOf": [ { "groupId": "be58bca6ea93ad96ecfdb267", "aaaManaged": false }, { "groupId": "7c2356da5f2cc6c3841878c6", "aaaManaged": true }, { "groupId": "f9f1d5e4c133b419cb18166a", "aaaManaged": true }, { "groupId": "855c01d4e8ab5197d3b8bb21", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit tempor Excepteur Ut" }, { "roleId": "pariatur dolor tempor Lorem sint" }, { "roleId": "Excepteur fugiat enim sit exercitation" }, { "roleId": "id" } ], "inactive": false, "lastLogin": "1950-03-16T01:48:24.364Z", "_meta": { "created": "2019-02-09T00:37:47.806Z", "updated": "1952-07-05T16:00:33.648Z", "migrationVersion": -41312680 }, "email": "in" }, "tasks": { "workflow_start": { "x": -83400750.17535117, "y": -3045073.5300561786, "gridCoordinate": { "x": -30968096.793259114, "y": 92471909.43798462 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -91174306.1431996, "finish_state": "error", "user": "Pronghorn" }, "groups": [ { "_id": "61a7a556f61ee3d12b56a5b3", "provenance": "elit", "name": "ea elit commodo dolore", "description": "ea", "memberOf": [ { "groupId": "9dacefb5fd134e9c05fe3a46", "aaaManaged": false }, { "groupId": "fd7d4d0cc8e585fa58645255", "aaaManaged": true }, { "groupId": "41605f2f354f228060c5dc0c", "aaaManaged": false }, { "groupId": "4487cead3c88e3422094a843", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris ipsum in ea consectetur" }, { "roleId": "cupidatat Ut in consectetur" }, { "roleId": "dolore id" }, { "roleId": "laborum velit" }, { "roleId": "consequat ea dolor deserunt ipsum" } ], "inactive": false, "_meta": { "created": "2006-10-26T07:28:05.634Z", "updated": "1977-06-02T06:17:49.422Z", "migrationVersion": -69455558 } }, "default", "default" ], "iterations": [ "C91e1B40-fae1-a4Ea-beBD-bAf017f2c41b", "D1cAf67C-Ce46-E1DF-BbCc-4960Ce8Fb401", "a7a32Acb-c2Ec-EB0A-9cAE-f6acEBDe0f0c" ] }, "workflow_end": { "x": -71358331.30229416, "y": 71579615.913504, "gridCoordinate": { "x": -54542262.39094733, "y": -69664572.86969447 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "error_handler", "workflow_start" ], "complete": [ "workflow_end" ], "error": [ "workflow_start", "3a1f", "3a1f" ] }, "metrics": { "end_time": 36297463.22822291, "run_time": 25650820.48699385 }, "groups": [ "default", { "_id": "7fa0a1e3e20a0915ebff2a50", "provenance": "commodo dolore", "name": "in", "description": "in Duis nulla sed", "memberOf": [ { "groupId": "57113f054c72ad4682d36896", "aaaManaged": false }, { "groupId": "54872736b53baa6eade01365", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat est laborum laboris" }, { "roleId": "voluptate exercitation ad ullamco" }, { "roleId": "eu pariatur velit" }, { "roleId": "minim ad Ut reprehenderit velit" }, { "roleId": "id nostrud deserunt dolore" } ], "inactive": true, "_meta": { "created": "2013-12-10T06:48:19.721Z", "updated": "1981-06-04T03:05:42.219Z", "migrationVersion": 19478623 } }, { "_id": "043ae4b0a4bd5e0844f03db7", "provenance": "in adipisicing irure", "name": "proident dolor quis laborum", "description": "anim", "memberOf": [ { "groupId": "6fcba64eb6faf25c68e02248", "aaaManaged": false }, { "groupId": "030d812800adebaf65689a0c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet" } ], "inactive": true, "_meta": { "created": "2021-09-18T00:24:55.253Z", "updated": "2004-08-22T09:54:04.075Z", "migrationVersion": 19011464 } }, { "_id": "5af6f3df90877d55f1323cc5", "provenance": "nisi est tempor sunt sed", "name": "culpa", "description": "eiusmod quis voluptate", "memberOf": [ { "groupId": "fe76fcca4811a43ecf64b0e2", "aaaManaged": false }, { "groupId": "65c2d6c89ca832e9db691600", "aaaManaged": true }, { "groupId": "033fbe64cce875b6f98a255e", "aaaManaged": true }, { "groupId": "421b058462bc2bd7103bb358", "aaaManaged": false }, { "groupId": "84d18d7afe5ea50d336bb9ff", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut irure dolore sint nostrud" }, { "roleId": "magna cillum officia eiusmod" }, { "roleId": "dolor anim" } ], "inactive": false, "_meta": { "created": "1965-12-09T08:01:39.817Z", "updated": "1947-07-19T03:02:35.249Z", "migrationVersion": -34490225 } } ], "iterations": [ "cd971CF9-26Cf-Bd9a-FB9b-A1De09bD675C" ] }, "error_handler": { "x": -21506003.871065184, "y": -27885972.68254596, "gridCoordinate": { "x": 98390433.00137687, "y": -1746669.6850942522 }, "name": "childJob", "location": "Adapter", "locationType": "labore Duis ullamco", "app": "non dolore", "canvasName": "non in sunt esse", "displayName": "est non Ut consectetur", "summary": "quis sit ad", "description": "esse", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/iEr/N43eTrES/Y3lDwE/I52B9/TLi3Q/ufzG2JmQku/~0/sNM/z/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "sunt id nostrud fugiat", "highlightString": "in non exercitation" }, { "key": "eiusmod laborum fugiat", "highlightString": "quis dolore Excepteur dolor" } ], "status": "complete", "previous": { "incomplete": [ "workflow_end", "workflow_start" ], "complete": [ "error_handler", "workflow_start", "e28f", "workflow_start" ], "error": [ "error_handler", "3a1f", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "standard" } ] }, "serverId": "est Lorem", "start_time": "1985-06-03T02:48:33.214Z", "end_time": 45700052.39507812, "finish_state": "success", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 85545425, "delay": 79763633, "count": 26925614, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "ca4993b0f378a5f2ff9c2705", { "_id": "8b384b56c8e5bb0194f217b4", "provenance": "anim in", "name": "sed laboris id", "description": "cillum nulla Lorem laboris", "memberOf": [ { "groupId": "459f12bd7ea5be187c72159c", "aaaManaged": true }, { "groupId": "44d13290eaa068ffda99aed4", "aaaManaged": false }, { "groupId": "01d2d788a67e9010826e4d43", "aaaManaged": false }, { "groupId": "502ae71178311fae38a29520", "aaaManaged": true }, { "groupId": "63d88b12750638a7a4004540", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor do minim cillum" } ], "inactive": true, "_meta": { "created": "1983-07-31T21:34:08.894Z", "updated": "1972-02-22T16:20:14.413Z", "migrationVersion": 9912195 } }, "0fd61c93fc17b4b3c47b73ad" ], "iterations": [ "B581DB14-B8D6-20AE-0d90-d6CcAee463eF", "6F7afeb8-7F02-7a07-EF0f-2Eced9FD65da", "cA6dFedD-c491-CFE0-e8ae-29272b6c3ef0" ] }, "316a": { "actor": "job", "groups": [ { "_id": "801b2ef23191599e39252875", "provenance": "id dolor sunt exercitation", "name": "velit aute exercitation dolor", "description": "labore id", "memberOf": [ { "groupId": "2f52ae211754de8267921c28", "aaaManaged": false }, { "groupId": "29700825aee6b40d581a1e1b", "aaaManaged": false }, { "groupId": "cf4485a473d76deeab990f04", "aaaManaged": false }, { "groupId": "dffeea39fbc55e9026380ec4", "aaaManaged": true }, { "groupId": "7187b2aa508cf266b9c9b78e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore" }, { "roleId": "eu" }, { "roleId": "elit anim est exercitation" }, { "roleId": "sunt in quis reprehenderit" } ], "inactive": true, "_meta": { "created": "2016-08-08T22:25:26.0Z", "updated": "1965-05-14T22:47:30.885Z", "migrationVersion": -23357706 } }, { "_id": "1a1120f5df264fc62aeb418a", "provenance": "voluptate elit anim ex", "name": "proident magna", "description": "irure veniam", "memberOf": [ { "groupId": "467c8ae10196e20aafd24d80", "aaaManaged": true }, { "groupId": "d360b792a519329d37e67366", "aaaManaged": true }, { "groupId": "be885a158c5f1eb0061d8707", "aaaManaged": false }, { "groupId": "0ef5efb42436837c9f8b5f54", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat nostrud" }, { "roleId": "dolore" }, { "roleId": "pariatur Duis ut aliqua nisi" }, { "roleId": "non" } ], "inactive": true, "_meta": { "created": "2014-12-18T09:52:22.36Z", "updated": "2005-07-06T05:28:46.148Z", "migrationVersion": -88300656 } }, { "_id": "10b1b8821288196872cb6327", "provenance": "adipisicing consectetur ad nulla", "name": "voluptate", "description": "ut anim pariatur", "memberOf": [ { "groupId": "4df7068c487055d9336bb02b", "aaaManaged": true }, { "groupId": "d35c872a371200a050faa2f0", "aaaManaged": true }, { "groupId": "db31c91c33678add4372af2d", "aaaManaged": true }, { "groupId": "6fbcf4644510a889ccfd54fb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet ut labore" } ], "inactive": true, "_meta": { "created": "2016-11-07T06:36:52.508Z", "updated": "1964-05-03T14:04:11.253Z", "migrationVersion": -27731230 } } ], "iterations": [ "6eAff6B0-D3be-8cfE-5eBc-B70ad0cBEd63" ], "x": 32880583.04555416, "y": 25613756.89899102, "gridCoordinate": { "x": -35620669.90135722, "y": 59730037.82802576 }, "name": "dolore Duis", "location": "Broker", "locationType": "aliquip", "app": "aliqua", "canvasName": "nisi", "displayName": "culpa", "summary": "enim", "description": "ex minim in sint", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~1/~1/t" }, { "type": "encryption", "pointer": "/HG-qO/Qr,/vXM/~0/si3sE9/~1/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "velit proident deserunt", "highlightString": "sit amet Lorem in" }, { "key": "Duis nisi est culpa amet", "highlightString": "eu sunt consectetur" } ], "status": "running", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_start", "3a1f", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "3a1f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "loop" } ] }, "serverId": "est veniam nisi ex proident", "start_time": "2014-09-19T09:01:33.038Z", "end_time": 68473023.91535783, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "in consequat" } }, "parent": { "task": "dolor", "iteration": -84660879.38103324, "element": 12419310.397494689 }, "errorHandler": null, "groups": [ { "_id": "2199cfbaaaf96390c3f7d5f9", "provenance": "Excepteur exercitation", "name": "do nostrud in cillum", "description": "mollit Excepteur in consequat do", "memberOf": [ { "groupId": "5081bc7f8705a81fbf6fbffa", "aaaManaged": true }, { "groupId": "bac84a6cc43a900e77216eea", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum magna mollit nulla" }, { "roleId": "et Duis" } ], "inactive": false, "_meta": { "created": "1952-05-11T02:43:11.949Z", "updated": "2012-08-09T15:19:12.941Z", "migrationVersion": -62054468 } }, { "_id": "0c84142ed0b800c9b4739726", "provenance": "sint aliqua dolor", "name": "nisi anim aliqua sit", "description": "officia", "memberOf": [ { "groupId": "a8de765752360a02a344a0c6", "aaaManaged": false }, { "groupId": "90095401087374307070279b", "aaaManaged": false }, { "groupId": "4cba4b22195282d6aeb6fceb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex non et pariatur" }, { "roleId": "eu sint anim" }, { "roleId": "Duis tempor anim id" }, { "roleId": "adipisicing magna cillum et" } ], "inactive": false, "_meta": { "created": "2008-08-18T04:48:37.587Z", "updated": "1989-07-22T09:05:24.384Z", "migrationVersion": 56503357 } } ], "watchers": [ "b0144bcc93b07170adcf9254", null, "Pronghorn" ], "metrics": { "start_time": -55330059.81879429, "progress": 0.631041298579897, "end_time": -92612430.78824037, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }