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": "est nisi exercitation sit id", "options": { "description": "Example job description", "type": "automation", "groups": [ "7f26b778153b871ecc81c3a9", "7a212855497c4b6b23d92a2b", "624cb2fd40811108f3caf78e", "c53705db498a6119efe5f0a5", "5ea27f0684d0167aedc40baa" ] } }
{ "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": "a36de2fddbbb396f9dc804f7", "font_size": 50265332, "type": "resource:compliance", "created": "1959-06-17T15:29:32.432Z", "last_updated": "2017-06-09T15:04:04.314Z", "createdVersion": "2213.4336.185052-2238.91372.1433846.587", "lastUpdatedVersion": "929990789.42.546998-4019.417.2539370824", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 60776264, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 44740919.97615975, "sla": -14020229.388640627, "decorators": [ { "type": "encryption", "pointer": "/~0/b8/prpUDlG/~0/ywCaHW/j/~0" }, { "type": "encryption", "pointer": "/FSOd" }, { "type": "encryption", "pointer": "/Nv-/~0/~1/kAvMoq06viB/~1/qclt7/~1/q8/~0" }, { "type": "encryption", "pointer": "/K,3.rxepQ/CMBqAhiK,z6/~1/wqayRv," }, { "type": "encryption", "pointer": "/~0/~0/~1/S2kGN+q/U8hC9m/j" } ], "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": "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": "workflow_start", "name": "myCoolDocumentName", "message": "in velit laboris dolor nisi" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "adipisicing et sit esse", "instancePath": "ex nisi", "schemaPath": "ipsum reprehenderit minim dolore", "message": "nostrud quis laboris fugiat enim" }, { "keyword": "officia", "instancePath": "ad consequat sit sunt", "schemaPath": "occaecat tempor culpa ea", "message": "ex tempor dolore sint commodo" }, { "keyword": "exercitation Excepteur qui adipisicing deserunt", "instancePath": "ut amet consectetur", "schemaPath": "est tempor", "message": "voluptate consequat consectetur dolor" }, { "keyword": "eu occaecat", "instancePath": "deserunt Duis", "schemaPath": "aute sit Duis mollit", "message": "proident" }, { "keyword": "reprehenderit elit ea fugiat", "instancePath": "quis in", "schemaPath": "Duis in ut deserunt", "message": "tempor in qui ex Lorem" } ], "created_by": { "_id": "6f6319e062a61de3d113e8b0", "provenance": "eiusmod ut", "username": "minim Ut nostrud", "firstname": "sit aliquip et", "memberOf": [ { "groupId": "faaed0be5d229fe4e2c46f1e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "id irure" } ], "inactive": false, "lastLogin": "1975-07-05T09:46:40.036Z", "_meta": { "created": "1986-07-17T11:32:26.352Z", "updated": "2021-10-14T20:49:20.586Z", "migrationVersion": -83681787 }, "email": "mollit cillum velit nulla dolore" }, "last_updated_by": { "_id": "fb81bef0b51be332dbcb2787", "provenance": "nisi cupidatat ex aliqua", "username": "Duis", "firstname": "et Excepteur exercitation occaecat", "memberOf": [ { "groupId": "0a2ce85b42bbacc84c9725c3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse" } ], "inactive": false, "lastLogin": "1990-09-22T04:23:23.628Z", "_meta": { "created": "1991-05-27T17:09:58.018Z", "updated": "2007-03-24T01:26:42.855Z", "migrationVersion": 40985086 }, "email": "est ut voluptate eu" }, "tasks": { "workflow_start": { "x": -17997541.73394388, "y": 54752157.81265077, "gridCoordinate": { "x": 84960688.03688285, "y": 12866210.339556709 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 25292932.568646267, "finish_state": "success", "user": "c22f541cdbf6c2afad5a121d" }, "groups": [ "default", { "_id": "c0176e7ed6a28d12cfde310a", "provenance": "ad anim amet", "name": "dolore nisi culpa", "description": "ad nulla", "memberOf": [ { "groupId": "5706e36a9ca5d925db6b8a29", "aaaManaged": false }, { "groupId": "88662f934ea97b6e18d0eb10", "aaaManaged": false }, { "groupId": "8dd2b8350d8e4eea99f38706", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor anim eiusmod non dolore" }, { "roleId": "sit dolore ut" }, { "roleId": "sunt exercitation magna" } ], "inactive": false, "_meta": { "created": "2001-02-21T21:33:28.613Z", "updated": "2013-03-22T21:56:03.764Z", "migrationVersion": -46242013 } } ], "iterations": [ "4A25fFfC-E25c-AaE5-03c7-7D4E0e52C1c8", "4CFf00fA-fFAc-04E7-e7f3-5Ea531aA4FCa", "51Ee1D09-d24C-D966-ded9-c9fC39321396" ] }, "workflow_end": { "x": -34861052.18179429, "y": -29057549.578474358, "gridCoordinate": { "x": 53309885.36205652, "y": -52657084.882802695 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "workflow_end", "workflow_start", "error_handler" ] }, "metrics": { "end_time": 12226334.064113066, "run_time": -30635532.49718876 }, "groups": [ { "_id": "a6621e1b25fd1f5cfa152ee4", "provenance": "dolore eu", "name": "ullamco dolore", "description": "nisi cillum in", "memberOf": [ { "groupId": "49189b400bea99252ddb3e6e", "aaaManaged": false }, { "groupId": "78f1a4560ffed3c1cde3cf58", "aaaManaged": false }, { "groupId": "5082a4c50a13d58fbc901368", "aaaManaged": true }, { "groupId": "cdf97e40967e6ae148769716", "aaaManaged": false }, { "groupId": "ead8e6e64b364915f54c8af3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing aliquip in Lorem dolore" }, { "roleId": "deserunt" } ], "inactive": false, "_meta": { "created": "1993-05-25T18:02:52.777Z", "updated": "1959-11-01T20:50:12.209Z", "migrationVersion": 13738976 } }, { "_id": "505925d7724ac5ca015c957e", "provenance": "officia adipisicing", "name": "nostrud mollit aute Ut do", "description": "id laboris in sit", "memberOf": [ { "groupId": "81a3170852a59b9919f55c42", "aaaManaged": false }, { "groupId": "42ba69c3659092306a9b3886", "aaaManaged": true }, { "groupId": "0ca6ec014ed0010bbbdb1bd9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum proident ea" } ], "inactive": false, "_meta": { "created": "1952-11-09T21:19:23.146Z", "updated": "1993-04-17T16:09:14.022Z", "migrationVersion": 47729653 } }, { "_id": "18122e6cae88bd589eb7878b", "provenance": "minim Ut in nulla", "name": "ad ipsum elit", "description": "labore cupidatat mollit velit", "memberOf": [ { "groupId": "5f76f8d8df54f1a18ec5e99b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat nostrud Lorem adipisicing" }, { "roleId": "magna dolore irure nisi dolor" } ], "inactive": true, "_meta": { "created": "1994-02-18T14:45:38.887Z", "updated": "2008-11-05T07:39:29.057Z", "migrationVersion": 59159754 } }, { "_id": "0202cf44b02f822a10557dbd", "provenance": "occaecat", "name": "nostrud ipsum", "description": "tempor ea pariatur", "memberOf": [ { "groupId": "e0270c1dd1decf5034195bbf", "aaaManaged": false }, { "groupId": "a568301ed39be905ada0d953", "aaaManaged": false }, { "groupId": "f5782248277419531fd8e943", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in ut officia sint amet" }, { "roleId": "sed" } ], "inactive": false, "_meta": { "created": "2011-01-20T03:15:38.367Z", "updated": "1960-09-02T20:25:23.608Z", "migrationVersion": -77358997 } }, { "_id": "b0b08579be258e1d6e6f89e8", "provenance": "enim amet eu fugiat est", "name": "qui pariatur sit voluptate", "description": "ut", "memberOf": [ { "groupId": "5269b5b982b967aae019c642", "aaaManaged": true }, { "groupId": "dc91e6281d92732a79e7e351", "aaaManaged": false }, { "groupId": "8c5c89a8d587cc19583c20af", "aaaManaged": false }, { "groupId": "b1cd08152e787ea5855ca4b8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat" }, { "roleId": "laboris voluptate" } ], "inactive": true, "_meta": { "created": "2024-12-24T01:27:08.618Z", "updated": "1945-08-26T13:30:08.513Z", "migrationVersion": -99646927 } } ], "iterations": [ "fF3ba5Fc-A9D2-8D87-75c9-DcE5eeD8a76F" ] }, "error_handler": { "x": -26162063.201430023, "y": -19909575.406770185, "gridCoordinate": { "x": 42863451.71259448, "y": -17137177.816718012 }, "name": "childJob", "location": "Application", "locationType": "adipisicing ut nisi dolore ut", "app": "occaecat exercitation", "canvasName": "ut velit veniam", "displayName": "irure", "summary": "id dolor", "description": "ad exercitation adipisicing", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/uW4Ns8lzE/~1/~0/~1/~0/jnwLcwLZ/~1/~0" }, { "type": "encryption", "pointer": "/j/~0/VYMv8C5/G/leXvk2/~0/q3.2n" }, { "type": "encryption", "pointer": "/W/mj/~0" }, { "type": "encryption", "pointer": "/Z//~1/pjS/h-/~0/iYSw/~0/~0/~1/~0/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in laboris eu ea id", "highlightString": "cillum ad sit aliquip" }, { "key": "magna ex officia nostrud ad", "highlightString": "enim cupidatat incididunt occaecat" }, { "key": "qui aliquip", "highlightString": "velit" }, { "key": "pariatur", "highlightString": "ut adipisicing incididunt" }, { "key": "dolore minim qui", "highlightString": "mollit" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "3a1f", "workflow_start", "error_handler" ], "complete": [ "workflow_start", "3a1f", "error_handler", "workflow_start", "workflow_end" ], "error": [ "error_handler", "3a1f", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "exercitation in do eu est", "start_time": "2008-08-22T23:35:57.235Z", "end_time": -60323799.69830149, "finish_state": "error", "retrySettings": { "state": [ "success", "error" ], "autoRetry": true, "limit": 71389756, "delay": 14080683, "count": 8652598, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "31740a64054dd016a07732d7", "5ce170038053b0e8b6a54473", "f192e83019151c36bbbfdd2a" ], "iterations": [] }, "a": { "actor": { "_id": "960f01c7caa07137eb3bd7d8", "provenance": "sunt pariatur cupidatat", "username": "qui", "firstname": "consequat incididunt", "memberOf": [ { "groupId": "4bab005ea055563e10a6168e", "aaaManaged": false }, { "groupId": "90cc02fafc8cdd6307a07fab", "aaaManaged": false }, { "groupId": "19a1d4c696857fad2235e670", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing tempor magna nisi cillum" }, { "roleId": "Duis sunt" }, { "roleId": "qui ut non" } ], "inactive": true, "lastLogin": "2007-11-24T17:41:34.605Z", "_meta": { "created": "2013-08-24T22:44:14.802Z", "updated": "1961-10-01T18:19:53.416Z", "migrationVersion": 29045987 }, "email": "consectetur ut eiusmod minim" }, "groups": [ "4c1e2aab1700903bde87c976" ], "iterations": [], "x": -61483666.20205543, "y": 64894961.09167522, "gridCoordinate": { "x": 83244190.22999048, "y": 8160287.515548736 }, "name": "pending", "summary": "cupidatat ea", "description": "Excepteur ex quis eu sint" } }, "parent": { "task": "tempor laboris anim adipisicing ut", "iteration": 40955944.73001391, "element": 37943588.58119491 }, "errorHandler": { "actor": "job", "groups": [ "default", "aae0bc6d79676bf71f36e26d" ], "iterations": [], "x": 66885709.8240698, "y": 28835143.443838358, "gridCoordinate": { "x": -64454056.73834399, "y": -38934684.94651211 }, "name": "pending", "summary": "laboris commodo tempor adipisicing cupidatat", "description": "officia sit dolor ad dolore" }, "groups": [ { "_id": "a37fba195efc00b7fd8ec697", "provenance": "culpa veniam", "name": "elit est dolore aliqua Lorem", "description": "commodo qui id amet tempor", "memberOf": [ { "groupId": "fdc67023a4ddf2eb1a685652", "aaaManaged": true }, { "groupId": "904ce93f9b797e19927c2c5b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum in" } ], "inactive": true, "_meta": { "created": "1963-05-28T14:42:20.151Z", "updated": "2023-03-10T16:43:11.224Z", "migrationVersion": 85066138 } } ], "watchers": [ "30209c3c163fe46dfdd4ecda", null ], "metrics": { "start_time": -81064365.53661668, "progress": 0.15471918394456252, "end_time": -35678071.23926943, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }