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": "labore", "options": { "description": "Example job description", "type": "automation", "groups": [ "d5d441278e04858923147f1e", "1d6db7a1967c6f5bafc35a10" ] } }
{ "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": "73748b05120782a6da578406", "font_size": -82453627, "type": "automation", "created": "1946-02-27T10:35:02.162Z", "last_updated": "1961-07-26T21:46:42.421Z", "createdVersion": "480851.40113.0725176123-4416.44526545.27817592.378", "lastUpdatedVersion": "2095.5189.7105834307-1574.5089152.73426204", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -19864866, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -650849.0163627714, "sla": 32115010.711249158, "decorators": [ { "type": "encryption", "pointer": "/dnfPzbdey4o/~0/~1/~0/~0/UKgoR" }, { "type": "encryption", "pointer": "/OiB9MiQ./~1/grl1FqVjX9/tv9/Joes/yFQiv+I/~1/U613g86/aV/~1/c4iM" }, { "type": "encryption", "pointer": "/Cs.dEbm/~0/~1" }, { "type": "encryption", "pointer": "/IRe/PZSpjm/~0/g8Nam9t+/l8uh17Q3I/~1/~0/bqMo9/~0/~1" }, { "type": "encryption", "pointer": "/q1yGJYwK" } ], "status": "paused", "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "non Excepteur" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "fugiat Duis" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "fugiat" } ], "ancestors": null, "validationErrors": [ { "keyword": "deserunt", "dataPath": "magna ex anim", "schemaPath": "adipisicing velit", "message": "id minim eiusmod Excepteur" }, { "keyword": "et dolore nulla dolor ut", "dataPath": "aliquip nostrud qui laborum dolore", "schemaPath": "incididunt ipsum exercitation cupidatat", "message": "enim exercitation qui" }, { "keyword": "enim", "dataPath": "veniam anim", "schemaPath": "fugiat eu ad irure Ut", "message": "Ut" }, { "keyword": "tempor dolore", "dataPath": "cupidatat culpa magna dolor nisi", "schemaPath": "labore sunt Lorem officia", "message": "sunt consequat" }, { "keyword": "reprehenderit commodo ut Ut anim", "dataPath": "occaecat in aute ipsum mollit", "schemaPath": "sit ullamco Ut nisi", "message": "Ut ea" } ], "created_by": "02a04537bbeb0f111f8a5431", "last_updated_by": { "_id": "6b933fa7d0fa6644a406baa3", "provenance": "do nisi", "username": "adipisicing cillum qui dolore", "firstname": "non id laborum in Duis", "memberOf": [ { "groupId": "2111bcc84de44c33a14b0e93", "aaaManaged": true }, { "groupId": "1f000239fbf2548a6fc389b4", "aaaManaged": false }, { "groupId": "9c4081920d6486ef4f78a9d8", "aaaManaged": false }, { "groupId": "97425efcc7588442ef0e4578", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod Lorem reprehenderit voluptate ipsum" }, { "roleId": "eiusmod sit aute ut ullamco" }, { "roleId": "aliqua" }, { "roleId": "eiusmod ex" } ], "inactive": true, "lastLogin": "1955-06-17T14:24:11.591Z", "_meta": { "created": "1956-11-27T18:26:41.823Z", "updated": "1976-11-26T10:36:24.322Z", "migrationVersion": -8988101 }, "email": "mollit adipisicing consectetur sit ipsum" }, "tasks": { "workflow_start": { "x": 40545591.88007873, "y": 10433748.17648068, "gridCoordinate": { "x": -34649120.05357936, "y": -50056956.06875222 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -70255337.498436, "finish_state": "error", "user": "Pronghorn" }, "groups": [ "default", "963c32f036304229f70d3a2f", { "_id": "62b7b20c95fb3ee1dcff36a1", "provenance": "id mollit consectetur", "name": "eu incididunt quis irure", "description": "et", "memberOf": [ { "groupId": "682ebcebc738a9c1a68d710f", "aaaManaged": false }, { "groupId": "aff9428c52371f7a235e673d", "aaaManaged": false }, { "groupId": "943b8ca2b5d211d58d698a37", "aaaManaged": false }, { "groupId": "19e4674eb04a23e492734ced", "aaaManaged": true }, { "groupId": "54dc328e6fe67657d8367d69", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate deserunt enim exercitation" }, { "roleId": "esse" }, { "roleId": "laborum Lorem elit" } ], "inactive": true, "_meta": { "created": "1962-11-27T21:54:55.669Z", "updated": "1955-05-10T23:25:45.722Z", "migrationVersion": -72105772 } }, "66b769622bb4a8c4f76b1036", { "_id": "98a89e21a78f7957c3f384d4", "provenance": "eiusmod Ut esse minim", "name": "Lorem ea eiusmod adipisicing est", "description": "dolore non ut", "memberOf": [ { "groupId": "b46d49444c140aea95c04301", "aaaManaged": false }, { "groupId": "7f13593b4b55d5cdc34bc6b4", "aaaManaged": true }, { "groupId": "8851c1e1f7989425ec50132c", "aaaManaged": true }, { "groupId": "7618d37eb4f91f761f259122", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod adipisicing cillum pariatur cupidatat" }, { "roleId": "laborum" } ], "inactive": false, "_meta": { "created": "2003-09-14T16:51:28.56Z", "updated": "1960-08-01T15:16:51.533Z", "migrationVersion": -87907539 } } ], "iterations": [ "64c6Ec07-e25d-15Cb-2b9b-91d1Dea45DEa" ] }, "workflow_end": { "x": -53394653.17562926, "y": -51210111.31898312, "gridCoordinate": { "x": -27093150.36872302, "y": 64148039.92784056 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "3a1f", "3a1f" ], "complete": [ "e28f", "3a1f", "workflow_start", "error_handler", "3a1f" ], "error": [ "3a1f", "workflow_end", "workflow_start", "workflow_end" ] }, "metrics": { "end_time": -32336947.433184713, "run_time": 97054117.35903674 }, "groups": [ { "_id": "72de34d5b1de54139ca1debb", "provenance": "ea veniam", "name": "culpa ipsum in laborum", "description": "do qui aliquip id", "memberOf": [ { "groupId": "0f32c057052c5278ee42af59", "aaaManaged": false }, { "groupId": "e9a62cf97000c05b4fdaaefa", "aaaManaged": true }, { "groupId": "a1fb33add479c872e31ab06c", "aaaManaged": false }, { "groupId": "2c19ea4a7efc3479a1170958", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident" }, { "roleId": "sed irure" }, { "roleId": "minim in Ut aliquip" }, { "roleId": "fugiat" }, { "roleId": "dolore non sint est culpa" } ], "inactive": true, "_meta": { "created": "1959-10-10T22:33:39.662Z", "updated": "1984-04-27T05:29:54.76Z", "migrationVersion": 10578779 } } ], "iterations": [ "a53B9b4B-A0a1-fa4d-dD52-58Fa2cCeBfFa", "AE0Ac4d9-2282-2FBE-b9D8-982a0808Ff51" ] }, "error_handler": { "x": 98470816.51123565, "y": -50670378.41676219, "gridCoordinate": { "x": 5836942.942733318, "y": -38248287.23959759 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "ut", "canvasName": "enim quis veniam ipsum officia", "displayName": "deserunt do Ut", "summary": "Lorem mollit", "description": "in amet non est", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/VRm8JDFomQx/I/~0/bBP,6kX72/~1/h0RAUwVwoE//~1/oRby,oZI" }, { "type": "encryption", "pointer": "/~0/~0/YuNEbEuUjRA/~1" }, { "type": "encryption", "pointer": "/~1/O2oR/j9D,QO+iB7/podOS-mL/ATgL3funtU/Q1P/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "quis dolor mollit ut", "highlightString": "exercitation et officia ut in" }, { "key": "ex do consequat exercitation adipisicing", "highlightString": "quis in" }, { "key": "ut minim", "highlightString": "reprehenderit" }, { "key": "dolore velit", "highlightString": "nostrud dolore anim" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_start", "3a1f", "error_handler" ], "complete": [ "error_handler" ], "error": [ "workflow_start", "error_handler", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "quis", "start_time": "1969-09-15T19:59:49.803Z", "end_time": 42270388.60835391, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "2981a43c36c6ae91f1e74d9c", "default", "default" ], "iterations": [] }, "c2da": { "actor": "job", "groups": [ "e10068f980caee59043f8b76", { "_id": "364a38fec2c4e5d8e656413f", "provenance": "incididunt", "name": "in", "description": "do officia", "memberOf": [ { "groupId": "0383945ce5ad0ce2735a8046", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident Excepteur voluptate dolor" }, { "roleId": "fugiat et" } ], "inactive": false, "_meta": { "created": "1985-03-03T19:07:32.305Z", "updated": "2024-11-14T14:29:27.853Z", "migrationVersion": -66415756 } }, "6a2b41eb6de369d934083138", { "_id": "014c67d2fe3466e7e6287ce1", "provenance": "qui ipsum consequat laborum", "name": "minim", "description": "officia ad", "memberOf": [ { "groupId": "c354ab7e8a78e14215ae60d1", "aaaManaged": true }, { "groupId": "e0e97cc83ea13eba1b5c52f1", "aaaManaged": true }, { "groupId": "8cd07031cfa7293594092263", "aaaManaged": false }, { "groupId": "a9f6238f02aad789f1e4a95d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident reprehenderit minim ad" }, { "roleId": "cupidatat fugiat laborum" }, { "roleId": "cupidatat nostrud dolor" }, { "roleId": "aute ex Excepteur dolor" } ], "inactive": false, "_meta": { "created": "2005-02-18T16:53:44.31Z", "updated": "1978-01-11T20:36:53.298Z", "migrationVersion": -88853012 } }, "ea90e0d3a50ee655186ce7e2" ], "iterations": [ "4EB23Bd8-3cdF-5F9B-f6af-BDccB2cc135e", "0a45c6dc-9a0c-A178-85dd-CC0380f27440", "353701c2-d3e2-ef2b-7ff5-66A04c0eAc46", "3ff5dffD-874B-4CEA-0875-D42dDe000Ba7" ], "x": -78846792.49338013, "y": 52204014.42808828, "gridCoordinate": { "x": -57196149.17759177, "y": 58682743.71895513 }, "name": "consectetur", "location": "Broker", "locationType": "esse sunt incididunt sed", "app": "ut eu commodo magna reprehenderit", "canvasName": "ipsum", "displayName": "adipisicing Excepteur dolore", "summary": "consectetur eiusmod", "description": "aute veniam", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/jVTZJp3" }, { "type": "encryption", "pointer": "/vdFdpqPE/rZ/wu+/EGJObcq22k/~1/~1/UNvOqXa/kc/~1/s6QpibJ/R/~1" }, { "type": "encryption", "pointer": "/GaeFUU/amQOHK8/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ut Duis fugiat", "highlightString": "reprehenderit sint" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "error_handler", "3a1f", "workflow_end", "workflow_start" ], "complete": [ "e28f", "error_handler", "workflow_end", "workflow_start" ], "error": [ "workflow_start", "3a1f", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" } ] }, "serverId": "adipisicing magna", "start_time": "2003-07-26T14:45:08.257Z", "end_time": -82621050.67739984, "finish_state": "error", "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": false, "limit": 17515670, "delay": 1294637, "count": 10722205, "finishedRetrying": false }, "type": "manual", "view": "sint Ut occaecat" } }, "parent": { "task": "irure ex nostrud", "iteration": -8403093.03705667, "element": -37430870.32943091 }, "errorHandler": null, "groups": [ "default" ], "watchers": [ { "_id": "62dd2dae60487b8eea5166ae", "provenance": "ad aliqua exercitation in", "username": "quis non", "firstname": "Lorem officia", "memberOf": [ { "groupId": "7a7ad708994517b27afddde1", "aaaManaged": false }, { "groupId": "610897a066bb0486e0d0ab46", "aaaManaged": false }, { "groupId": "5c96f52bb1285dcdaea23bac", "aaaManaged": true }, { "groupId": "5072ba094fc5767c9320fb5b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt velit aliqua" }, { "roleId": "et ex ad occaecat" }, { "roleId": "id pariatur" }, { "roleId": "minim cupidatat dolore" }, { "roleId": "eiusmod Ut" } ], "inactive": false, "lastLogin": "1992-10-31T04:20:27.191Z", "_meta": { "created": "1963-04-02T04:25:23.372Z", "updated": "1969-03-28T03:01:01.803Z", "migrationVersion": -7693342 }, "email": "in exercitation dolore" }, { "_id": "e4e3412202755b393f4d1c5d", "provenance": "eiusmod ut irure", "username": "amet do commodo", "firstname": "aliquip sunt cillum", "memberOf": [ { "groupId": "32abffc26e7def4c97f63420", "aaaManaged": true }, { "groupId": "5cdc46b177d4a473d427decc", "aaaManaged": false }, { "groupId": "41cba2d0077ca09d9b9a9234", "aaaManaged": true }, { "groupId": "e2fafbc4bfd300b922b73940", "aaaManaged": true }, { "groupId": "10f3f423372e42ad334ef8a1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt Duis magna quis occaecat" }, { "roleId": "dolor do sit" } ], "inactive": false, "lastLogin": "1967-07-06T20:58:13.217Z", "_meta": { "created": "1976-02-02T10:40:47.407Z", "updated": "1994-06-04T09:40:43.126Z", "migrationVersion": -28378997 }, "email": "pariatur deserunt irure ut" }, "Pronghorn", "Pronghorn" ], "metrics": { "start_time": 48148361.80208513, "progress": 0.37387168242374424, "end_time": 39536188.80717826, "user": null, "owner": { "_id": "eeed40c734079515bcbe89c2", "provenance": "esse culpa laboris", "username": "qui labore exercitation", "firstname": "consectetur in proident dolore", "memberOf": [ { "groupId": "df5d9f41b0677bc07babfef3", "aaaManaged": true }, { "groupId": "f1f9900508aa793f2a4e794f", "aaaManaged": true }, { "groupId": "fe97459260100e5623baca93", "aaaManaged": false }, { "groupId": "e11a114f3a6adb2e84e21e3f", "aaaManaged": true }, { "groupId": "d90d8d9ce488893638e63253", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing proident sed" } ], "inactive": true, "lastLogin": "1962-05-10T15:06:12.001Z", "_meta": { "created": "1983-03-02T00:02:14.459Z", "updated": "2007-05-01T05:57:08.067Z", "migrationVersion": 25030779 }, "email": "tempor nisi et" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }