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": "in nostrud dolor deserunt", "options": { "description": "Example job description", "type": "automation", "groups": [ "e7d89dff476627174a63bb26", "dfed89887db804d784dc9454", "7ef75b28ba422e460d31cf28", "92846aee9c88293dbcb877cd" ] } }
{ "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": "626589ce6b8b3d14e60ab24a", "font_size": 23652273, "type": "automation", "created": "2002-12-18T05:16:22.739Z", "last_updated": "1984-09-26T01:14:58.446Z", "createdVersion": "222.59685.8232", "lastUpdatedVersion": "837312499.7238273571.104091972-9488.481.695970", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 59959408, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 51793323.32610384, "sla": 40279653.034939885, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/k-B/~1" }, { "type": "encryption", "pointer": "/~1/~1/P5/~0/~1/lh5I1+F/~1/IVit/HM-AGDq/Q+m" }, { "type": "encryption", "pointer": "/~0/E,FnLe/vAuon8Pw11/Mg/MLejK5G/~0/~0/~0" }, { "type": "encryption", "pointer": "/~0/~1/H-cG-/vcK2V5xl/~1/~0/~0/~1" } ], "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": "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 }, { "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_start", "name": "myCoolDocumentName", "message": "aliquip cupidatat labore reprehenderit ea" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "190be7c91f482443bce186d5" ], "validationErrors": [ { "keyword": "anim adipisicing voluptate", "dataPath": "aliquip", "schemaPath": "ut irure ad", "message": "et" }, { "keyword": "fugiat", "dataPath": "ipsum", "schemaPath": "commodo", "message": "commodo Ut qui" }, { "keyword": "ullamco do", "dataPath": "pariatur do minim ex velit", "schemaPath": "incididunt exercitation dolore", "message": "veniam" }, { "keyword": "sint Lorem", "dataPath": "Lorem dolore", "schemaPath": "veniam esse magna", "message": "proident est aute velit" }, { "keyword": "enim", "dataPath": "qui aute ut", "schemaPath": "Ut amet in ullamco velit", "message": "officia anim fugiat" } ], "created_by": { "_id": "30f7b275b0defc747b7c06c2", "provenance": "mollit aliqua", "username": "sed sunt", "firstname": "commodo laborum", "memberOf": [ { "groupId": "210ba8aadd3e28c7ab1b61df", "aaaManaged": false }, { "groupId": "f4a31d50aee18d1a49215eb1", "aaaManaged": true }, { "groupId": "f707b965f1cfe01be745dca9", "aaaManaged": true }, { "groupId": "d7f3b70f020db2bf16cb78f8", "aaaManaged": true }, { "groupId": "36595d07f0ea215138c4808b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla" }, { "roleId": "occaecat Lorem ad dolor" } ], "inactive": false, "lastLogin": "1998-02-11T06:52:46.151Z", "_meta": { "created": "1963-07-10T09:56:58.106Z", "updated": "1948-10-19T19:19:00.758Z", "migrationVersion": -39075664 }, "email": "ea ut" }, "last_updated_by": { "_id": "d92f0cacb7b9a9ced49954b1", "provenance": "est esse aliqua dolor voluptate", "username": "enim do proident dolor reprehenderit", "firstname": "ea nostrud cillum incididunt", "memberOf": [ { "groupId": "69fa3886d4ad93af8b56c31f", "aaaManaged": true }, { "groupId": "c3ca06a007a45336b079d825", "aaaManaged": false }, { "groupId": "362c6b0a809fe2989cccef5c", "aaaManaged": false }, { "groupId": "342b18ffa65f58a4422f427f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt aute" }, { "roleId": "ullamco in aute nisi" } ], "inactive": true, "lastLogin": "1993-01-03T19:44:47.804Z", "_meta": { "created": "2021-11-25T17:06:18.56Z", "updated": "1968-03-15T02:23:13.594Z", "migrationVersion": -30266198 }, "email": "eiusmod mollit" }, "tasks": { "workflow_start": { "x": -47209183.14019547, "y": -71557217.54218511, "gridCoordinate": { "x": -29164517.74735868, "y": 94813373.85228285 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 78601809.05384219, "finish_state": "error", "user": null }, "groups": [ "default" ], "iterations": [ "7bA4Af27-4a9a-F042-b2a4-d971a272dBCe" ] }, "workflow_end": { "x": -37480033.77188373, "y": -65099027.58724997, "gridCoordinate": { "x": 27549113.83570957, "y": -1629743.7485562712 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler" ], "complete": [ "workflow_start", "error_handler", "workflow_start", "e28f" ], "error": [ "3a1f", "workflow_end" ] }, "metrics": { "end_time": 18183537.918647245, "run_time": 92471442.77575198 }, "groups": [ "default" ], "iterations": [] }, "error_handler": { "x": 71770371.58389089, "y": -92231457.77264076, "gridCoordinate": { "x": 86063837.3568894, "y": -39255110.8998302 }, "name": "childJob", "location": "Application", "locationType": null, "app": "cupidatat enim irure", "canvasName": "in ex Duis", "displayName": "ad sed Ut", "summary": "pariatur sunt occaecat", "description": "sint Duis consectetur aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/f/D/~1/Mvc0pO8,/JRbW" }, { "type": "encryption", "pointer": "/~1/jK5sZkZKqZe/tGLS/j9mtb/~1/tW4i96kih+/~1/z-SOFrTG.1A" }, { "type": "encryption", "pointer": "/~0/Rz/kS/~0/hbBkupr5" }, { "type": "encryption", "pointer": "/~0/zjR/~0/~0/aXux18FSB3/e5uIOwmP3H/v0SmBzrK/~0/SDEEXSHcDbR/NJq" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "est", "highlightString": "commodo culpa dolor" }, { "key": "labore enim", "highlightString": "sunt" } ], "status": "canceled", "previous": { "incomplete": [ "3a1f", "error_handler", "3a1f" ], "complete": [ "workflow_end", "3a1f", "3a1f", "workflow_end", "error_handler" ], "error": [ "3a1f", "workflow_start", "error_handler", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "in ad", "start_time": "1993-12-20T05:06:24.478Z", "end_time": 83896325.32254484, "finish_state": "error", "retrySettings": { "state": [ "success", "failure" ], "autoRetry": false, "limit": 85054376, "delay": 49189381, "count": 90358255, "finishedRetrying": true }, "type": "operation", "actor": null, "groups": [ { "_id": "79c98e7555d1374990b00c09", "provenance": "dolor est incididunt proident", "name": "et consectetur non in", "description": "laboris consectetur", "memberOf": [ { "groupId": "af7a5d918dc69474d4a67bcd", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris" }, { "roleId": "mollit" }, { "roleId": "ex ullamco aliqua" }, { "roleId": "esse cillum id dolore" } ], "inactive": false, "_meta": { "created": "2004-04-26T10:32:16.095Z", "updated": "1993-08-26T11:18:56.199Z", "migrationVersion": -50168082 } }, "1c88c53de84c79ee7f1706cd" ], "iterations": [] }, "ab": { "actor": null, "groups": [ "118b23baa90bc00724b3517d" ], "iterations": [ "FE6Ec9d2-0A84-BDCb-6eeE-CB4fA0cB8e6f", "4684Fba2-d5A6-D6dB-a62F-f6A50FD7095D", "9F5d63ED-eB2A-65F8-F6ea-af24cccF3dbd" ], "x": 37445236.27983117, "y": -88560027.08740194, "gridCoordinate": { "x": 36260912.286529034, "y": -53782853.56626269 }, "name": "pending", "summary": "dolore do laborum ea in", "description": "in aliquip" } }, "parent": { "task": "culpa nulla", "iteration": 3323434.7149392962, "element": 55612811.02834937 }, "errorHandler": null, "groups": [ "6dbf179dfb425e9c49d02cbb" ], "watchers": [ { "_id": "7bd7c702674f23a84a6bd199", "provenance": "cillum ullamco enim", "username": "pariatur dolor veniam ex", "firstname": "laboris nulla", "memberOf": [ { "groupId": "3a004d41884aba8cfc485995", "aaaManaged": false }, { "groupId": "ad229e00ee0d4a01bcc67ff9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor dolore elit sunt" }, { "roleId": "voluptate sed quis sunt" }, { "roleId": "eiusmod" } ], "inactive": false, "lastLogin": "1970-04-30T05:10:05.184Z", "_meta": { "created": "1952-11-05T16:40:26.421Z", "updated": "1960-08-31T06:41:07.491Z", "migrationVersion": 29587907 }, "email": "dolor commodo ullamco enim ipsum" }, "73e79266e0ffd167ea2ce924", "Pronghorn", "d93264239d606ef7ad8878aa", { "_id": "cd02b4fae01f08de69e8843d", "provenance": "anim in esse ex quis", "username": "ipsum Ut in commodo", "firstname": "tempor occaecat velit", "memberOf": [ { "groupId": "e9ee2d8cb883a1d1a56b7e01", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit in ex" }, { "roleId": "culpa in" }, { "roleId": "in esse nostrud Duis" }, { "roleId": "elit nostrud culpa adipisicing voluptate" }, { "roleId": "laboris sunt enim Ut pariatur" } ], "inactive": true, "lastLogin": "2021-11-16T00:21:35.043Z", "_meta": { "created": "1958-12-02T15:29:34.737Z", "updated": "1989-12-16T10:10:31.787Z", "migrationVersion": -18287475 }, "email": "cillum proident eiusmod aute" } ], "metrics": { "start_time": 28497983.199168295, "progress": 0.8336092457052018, "end_time": -40738089.57272198, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }