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 mollit ad minim", "options": { "description": "Example job description", "type": "automation", "groups": [ "bc11a2364dad319a6c9787a6", "af85533c3c3cd06d7aa399e9", "1338dc6e5ce7e957fb0b318e", "c596a5fe8e9dd7db84dc4c65" ] } }
{ "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": "2e8de99682a611666db9e4dc", "uuid": "44a41d3d-209a-280c-b3b1-bbb0f0ea6fba", "font_size": -92582272, "type": "resource:compliance", "created": "2023-01-12T19:34:24.781Z", "last_updated": "1951-02-20T08:21:18.142Z", "createdVersion": "6429910150.19603683.6-7768.61522367.98240386.5831418", "lastUpdatedVersion": "804051993.83768.83598224981-8274.16323594.54090594167", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 7507779, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -36627007.78917478, "sla": 24872862.607641235, "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/SuzvqC" }, { "type": "encryption", "pointer": "/~1/~0/~0/ZEvSzMPEAD/y/h+Rslo/kI" } ], "status": "complete", "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName", "message": "anim mollit elit aliquip Excepteur" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "reprehenderit fugiat" } ], "ancestors": [ "b499adac97724ee908788d0a", "385c77cbee54bbb3fccf2823", "275d264617eff42a4dd7cf8d" ], "validationErrors": [ { "keyword": "dolor mollit Ut Duis magna", "instancePath": "fugiat mollit ea labore Excepteur", "schemaPath": "exercitation esse", "message": "culpa irure" }, { "keyword": "ad", "instancePath": "ut commodo", "schemaPath": "sint in qui est", "message": "commodo deserunt eu sint" }, { "keyword": "pariatur quis Lorem nostrud aute", "instancePath": "veniam ex est", "schemaPath": "sed ipsum enim sint", "message": "est minim nulla exercitation" }, { "keyword": "eu in", "instancePath": "in", "schemaPath": "qui", "message": "Excepteur" } ], "created_by": { "_id": "354ee94cef7c7eda4ff32ac5", "provenance": "nisi adipisicing dolor ipsum", "username": "qui dolor", "firstname": "proident", "memberOf": [ { "groupId": "6efa46c72a78385b311d57eb", "aaaManaged": true }, { "groupId": "c65cb9716d4824522b499cff", "aaaManaged": false }, { "groupId": "736346251114a52f7be0ad84", "aaaManaged": true }, { "groupId": "dfec88038295dc1c235741f3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor" }, { "roleId": "sit" }, { "roleId": "mollit nisi Excepteur commodo Duis" }, { "roleId": "in sint sunt reprehenderit deserunt" } ], "inactive": true, "lastLogin": "2005-08-19T11:52:57.129Z", "_meta": { "created": "1976-03-08T08:57:14.703Z", "updated": "1960-05-25T06:28:42.555Z", "migrationVersion": 62124575 }, "email": "Ut Excepteur Lorem commodo" }, "last_updated_by": "ebce886eb6f9c2634fc8295c", "tasks": { "9": { "actor": "job", "groups": [ "default" ], "iterations": [ "E4d394dc-4bfC-a26b-E42e-abeA85f926cC", "Af486c2a-3e7f-A4a4-C4Ac-bDECAF3fc77f" ], "x": -85963821.68486816, "y": -77752882.98433942, "gridCoordinate": { "x": -45646256.69779518, "y": -54717901.69971089 }, "name": "pending", "summary": "ut occaecat cillum nulla", "description": "eiusmod voluptate deserunt Excepteur laborum" }, "workflow_start": { "x": 35931806.192444384, "y": 94105705.22497556, "gridCoordinate": { "x": 91112709.11746994, "y": -6473478.315211922 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -97584933.90902384, "finish_state": "error", "user": "Pronghorn" }, "groups": [ { "_id": "0d0231305ba115cc7067bdb8", "provenance": "eu ullamco Lorem", "name": "dolore", "description": "pariatur et Ut veniam", "memberOf": [ { "groupId": "3bf5a008d992f1be2e587425", "aaaManaged": true }, { "groupId": "1cfe95e5fcd5f19548039235", "aaaManaged": false }, { "groupId": "58f189c694b06f583a96f2d3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sed qui officia" }, { "roleId": "Ut dolore" } ], "inactive": false, "_meta": { "created": "1956-06-22T12:50:14.265Z", "updated": "1961-07-14T02:17:02.804Z", "migrationVersion": 7539167 } }, "3623234cdcb9f15b75122e84", "9bbc5e4a45efe34594090900", "deea3dd7671965438954f3d5", "default" ], "iterations": [] }, "workflow_end": { "x": -22983030.777299747, "y": 82138832.62410647, "gridCoordinate": { "x": 31045535.51530698, "y": -60079422.443188645 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "e28f", "error_handler", "e28f" ], "complete": [ "3a1f" ], "error": [ "workflow_start", "workflow_start", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 17872860.806278765, "run_time": -74582344.81692241 }, "groups": [ "default", { "_id": "ac1596634637771ba59c83bb", "provenance": "magna ex in", "name": "adipisicing minim", "description": "voluptate", "memberOf": [ { "groupId": "a0ab269874bd87c1b5784556", "aaaManaged": true }, { "groupId": "5e9e301d8c7166c87cddf288", "aaaManaged": true }, { "groupId": "8d2c340350008f2ae38691b8", "aaaManaged": true }, { "groupId": "e2ac8fc40865138ce9e6e6ef", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris id ut in" } ], "inactive": true, "_meta": { "created": "1956-04-27T21:33:29.861Z", "updated": "1974-04-01T21:00:06.21Z", "migrationVersion": 5592036 } } ], "iterations": [ "65B1a3f0-F06A-2039-EFb3-EDbea2EF7ead" ] }, "error_handler": { "x": -3283173.400550738, "y": -14419354.344404846, "gridCoordinate": { "x": 62270581.50466856, "y": -2822689.0012161434 }, "name": "childJob", "location": "Application", "locationType": "elit", "app": "in dolore", "canvasName": "consequat proident", "displayName": "id", "summary": "Excepteur in eiusmod ut aute", "description": "Excepteur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~0/DR/vfyRkx4yZi-/g/f1oKM51LMp," }, { "type": "encryption", "pointer": "/rapsXbUZW,/~1/y/~1/RtnYSlupl0/JHQ4" }, { "type": "encryption", "pointer": "/~1/HA1G/K/rmE51jW/~1/~1/hzg+tyb0/~0/w9EEMZba/TPyCzb" }, { "type": "encryption", "pointer": "/~1/nxcohJSUqvZ/~0/~1/N3aciF" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ullamco", "highlightString": "et consequat anim nisi dolor" }, { "key": "cillum", "highlightString": "dolor in quis sint eiusmod" }, { "key": "deserunt magna velit laborum Excepteur", "highlightString": "occaecat" }, { "key": "labore amet mollit exercitation culpa", "highlightString": "est tempor" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_start", "workflow_end" ], "error": [ "e28f", "workflow_end", "error_handler", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" } ] }, "serverId": "aute", "start_time": "2018-06-25T14:34:18.869Z", "end_time": -56825439.16820091, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": { "_id": "ac6cca5f99cf83763ee40c91", "provenance": "ut labore ut officia", "username": "in sint labore", "firstname": "ex id incididunt", "memberOf": [ { "groupId": "3e05cf1025ef066616bb291c", "aaaManaged": true }, { "groupId": "a17a41ba9b9fcb54d5a77d42", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit" }, { "roleId": "sint ullamco" }, { "roleId": "laborum veniam" }, { "roleId": "incididunt mollit sit est dolor" }, { "roleId": "labore fugiat" } ], "inactive": false, "lastLogin": "1975-06-14T23:26:23.042Z", "_meta": { "created": "1953-05-14T09:22:31.792Z", "updated": "1971-12-02T21:19:49.26Z", "migrationVersion": -39431309 }, "email": "qui dolore aliqua incididunt ad" }, "groups": [ "default", { "_id": "537b6dc745ebb96de76727b0", "provenance": "ex", "name": "sit mollit", "description": "in", "memberOf": [ { "groupId": "75dade3117efe87fa588c77c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur sed" }, { "roleId": "culpa velit quis dolore" } ], "inactive": true, "_meta": { "created": "2009-02-18T10:48:33.728Z", "updated": "1982-06-16T12:04:08.056Z", "migrationVersion": 32807615 } }, "0f233f6f23229df1263c3948", { "_id": "b53043a8f508528e345ed455", "provenance": "in officia dolore", "name": "labore", "description": "aliquip minim incididunt officia ullamco", "memberOf": [ { "groupId": "386ab31f81c8191a3189b541", "aaaManaged": false }, { "groupId": "6768edc951cd1f3203e19823", "aaaManaged": false }, { "groupId": "4d187f96eb8a9a8bf2f333ce", "aaaManaged": true }, { "groupId": "9e4b5fee75c5ae30d47521fe", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in irure nisi" }, { "roleId": "sint elit in" }, { "roleId": "ut adipisicing mollit" }, { "roleId": "nisi laborum" } ], "inactive": false, "_meta": { "created": "1996-10-19T21:45:01.261Z", "updated": "1980-06-07T16:38:10.208Z", "migrationVersion": -47854053 } } ], "iterations": [ "CA2eE0C6-d370-2cfb-c6C6-aC388fA3Cdc3" ] } }, "parent": { "task": "magna commodo laborum tempor aliquip", "iteration": 39291151.03669548, "element": 88764225.69055343 }, "errorHandler": { "actor": "job", "groups": [ "default", { "_id": "eb6814ea5a2e25a8b33e5d28", "provenance": "labore laborum", "name": "Duis aliquip sit", "description": "in dolore exercitation id aliqua", "memberOf": [ { "groupId": "b7dcdd10f71cc719060f84ac", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit ut non" }, { "roleId": "sunt" }, { "roleId": "ad sint Lorem Duis deserunt" } ], "inactive": true, "_meta": { "created": "1955-09-06T07:26:52.214Z", "updated": "1971-02-23T18:22:59.996Z", "migrationVersion": 49268173 } }, "default" ], "iterations": [ "f2BC1B0d-83d1-4575-9570-0cf5AacdE712" ], "x": 27235874.492528334, "y": 20753079.88918355, "gridCoordinate": { "x": -57061447.321882896, "y": 47698467.17893863 }, "name": "pending", "summary": "cupidatat sint sed", "description": "pariatur aliquip magna esse" }, "groups": [ "cde4bd16f264a6bb585d4cbe" ], "watchers": [ "Pronghorn", "Pronghorn", "77b9a8a3ae6da551175d25f2" ], "metrics": { "start_time": 15887891.412138715, "progress": 0.5806314706934832, "end_time": -66121574.148133576, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }