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 voluptate", "options": { "description": "Example job description", "type": "automation", "groups": [ "9fbf034d476cb8036255425f" ] } }
{ "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": "e20a4a7a1408b3318652a9d5", "font_size": -85139266, "type": "automation", "created": "2018-05-28T13:08:54.865Z", "last_updated": "1953-01-05T03:51:22.297Z", "createdVersion": "047240832.77.0144842", "lastUpdatedVersion": "8.09030984283.9812841512-1334.718766106.7901432827", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -43181001, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -93334181.00119287, "sla": 65323317.43384114, "decorators": [ { "type": "encryption", "pointer": "/~1/RdgR+eoabB/~1/g/~0/~0" }, { "type": "encryption", "pointer": "/~0/~0/myGDXpA8/~1/o-Q/~1/H4Ml/WSBfH" }, { "type": "encryption", "pointer": "/DeqdaKL6h/~0/D3HTXrUg/oB1VK/~0/n6rv/~1/~1/~1/QTD.m/bD0" }, { "type": "encryption", "pointer": "/UO-/xmpJ/Af.H/ccoXCU,/~0/Y496jqA/lZ" }, { "type": "encryption", "pointer": "/AY/n1h/PHlqD0J/uO26V7" } ], "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": "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName", "message": "aliquip" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "et" } ], "ancestors": [ "845d81f46b74102991620f76", "72acba1084477df55adf0328" ], "validationErrors": [ { "keyword": "dolore consectetur labore", "dataPath": "consequat aliquip culpa dolor", "schemaPath": "Duis eiusmod", "message": "dolore ut consequat culpa sed" }, { "keyword": "fugiat deserunt elit", "dataPath": "Lorem cupidatat eu aute", "schemaPath": "dolore minim in", "message": "occaecat dolor sunt sit" }, { "keyword": "ut amet enim Ut", "dataPath": "in ut", "schemaPath": "labore", "message": "enim consequat" }, { "keyword": "enim non", "dataPath": "fugiat", "schemaPath": "velit quis culpa", "message": "eu elit dolor culpa" }, { "keyword": "fugiat laboris nostrud eu mollit", "dataPath": "aliqua do laboris sint", "schemaPath": "nostrud dolor ullamco ea", "message": "esse adipisicing cupidatat" } ], "created_by": null, "last_updated_by": { "_id": "7060034f1f8bc6a5f5b49b1c", "provenance": "qui nisi in", "username": "laborum do mollit adipisicing", "firstname": "Lorem do", "memberOf": [ { "groupId": "c64c8373f1a1b6e70edeb087", "aaaManaged": false }, { "groupId": "4dcff31781e005fd3e89b560", "aaaManaged": true }, { "groupId": "52a2da09abac6f14119456b3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi proident non eiusmod" }, { "roleId": "ut" } ], "inactive": true, "lastLogin": "1962-01-05T00:45:19.091Z", "_meta": { "created": "1985-07-05T22:50:41.397Z", "updated": "1970-08-17T20:17:36.784Z", "migrationVersion": 41426506 }, "email": "eu eiusmod Lorem laborum" }, "tasks": { "779": { "x": 69462647.06372622, "y": -47905859.486662105, "gridCoordinate": { "x": -94008477.22862378, "y": -97546100.65102103 }, "name": "irure", "location": "Broker", "locationType": null, "app": "officia eu nostrud irure", "canvasName": "Ut dolor elit culpa in", "displayName": "exercitation", "summary": "sed sunt", "description": "ipsum exercitation irure ut ex", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/kYtVHD" }, { "type": "encryption", "pointer": "/~1/~1/~0/L76,IR6Zfi/~0/~1/~0/ie/VfvfM/sibV9nT" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "culpa exercitation consequat laboris", "highlightString": "ad nisi adipisicing dolor dolore" }, { "key": "labore enim in culpa adipisicing", "highlightString": "in consectetur nulla" }, { "key": "elit officia quis ut culpa", "highlightString": "sunt adipisicing Excepteur anim amet" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "workflow_end", "error_handler" ], "error": [ "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "standard" } ] }, "serverId": "pariatur ullamco deserunt consequat elit", "start_time": "1966-07-09T02:48:18.73Z", "end_time": -19685099.986275792, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "7e18b6aba0faf449a8deae85", { "_id": "d1403dcb4b30b58ccbcb15ad", "provenance": "sed", "name": "exercitation Ut ut labore", "description": "in reprehenderit cillum", "memberOf": [ { "groupId": "1f967063cc9e9f557e21fcf6", "aaaManaged": true }, { "groupId": "1217559e9a3fd8c9b8bcdad3", "aaaManaged": true }, { "groupId": "167264042ed0b2690371b00e", "aaaManaged": true }, { "groupId": "54d27e848f0e7a9d881ab622", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed labore occaecat ex" }, { "roleId": "labore" }, { "roleId": "quis ut ut elit" }, { "roleId": "ex dolor et esse sed" }, { "roleId": "elit pariatur ipsum" } ], "inactive": true, "_meta": { "created": "2010-03-16T23:16:22.046Z", "updated": "2008-01-11T20:14:34.47Z", "migrationVersion": 92725743 } }, { "_id": "5071bbd47dd08f36d879c0bd", "provenance": "id in voluptate", "name": "sint est minim cupidatat officia", "description": "fugiat", "memberOf": [ { "groupId": "7d688750f53dde6c0a85273b", "aaaManaged": true }, { "groupId": "1ab506b9955daf5fb4bc6fcf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint minim eiusmod in" }, { "roleId": "ad labore do et" }, { "roleId": "labore ut tempor" }, { "roleId": "deserunt sunt ut" } ], "inactive": true, "_meta": { "created": "2002-08-07T04:26:27.585Z", "updated": "1976-09-25T04:13:56.994Z", "migrationVersion": -53990893 } }, { "_id": "1217a0fbd657e36bfa8dbbd6", "provenance": "proident in ea", "name": "deserunt culpa nisi nostrud laborum", "description": "ut dolore", "memberOf": [ { "groupId": "5fad1ec6e6ac4d9a23eedbe8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur exercitation" }, { "roleId": "et elit enim" } ], "inactive": false, "_meta": { "created": "1999-09-02T01:49:05.246Z", "updated": "1962-09-13T01:26:14.64Z", "migrationVersion": -36950789 } } ], "iterations": [ "1F8BeB4a-35E9-b54F-a172-FEaCfAC55569" ] }, "workflow_start": { "x": -26108117.606599852, "y": 97293835.88518625, "gridCoordinate": { "x": 30099160.833264753, "y": 72567464.29596686 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 34474658.376450926, "finish_state": "error", "user": "fcf768945d16c26d2d86f91e" }, "groups": [ "default", "default", { "_id": "61639aa64dceb8718ab6725b", "provenance": "sed voluptate eu", "name": "exercitation laboris cillum esse sit", "description": "minim quis est commodo deserunt", "memberOf": [ { "groupId": "841e1b5df98d5d47ec181408", "aaaManaged": true }, { "groupId": "ccca8472ea106e0a87c4123c", "aaaManaged": true }, { "groupId": "310ce062fac0442266498b91", "aaaManaged": false }, { "groupId": "4ae168ecb048dd17d056b9dd", "aaaManaged": false }, { "groupId": "3a4a5d851caad83544b1de4b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur enim veniam" }, { "roleId": "cillum voluptate" }, { "roleId": "in sed" }, { "roleId": "amet reprehenderit cupidatat velit" } ], "inactive": true, "_meta": { "created": "1993-08-04T23:31:09.263Z", "updated": "2003-01-17T05:28:22.93Z", "migrationVersion": -18448572 } }, "c86b97f176763cf4e708dddb" ], "iterations": [ "B5b3EDdC-FAda-ae4D-952E-EfdA168CB9bb" ] }, "workflow_end": { "x": -76249081.48896328, "y": -84985359.78051703, "gridCoordinate": { "x": 16747986.860314116, "y": -48050659.214428574 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "3a1f" ], "error": [ "workflow_end", "workflow_start", "workflow_end", "3a1f" ] }, "metrics": { "end_time": -96595835.07935902, "run_time": -78565609.79327711 }, "groups": [ "4a322a6149e8ab718a3e68a5", "default" ], "iterations": [ "Dc5d23Ca-B681-6CD2-e2Ca-BA7E05AcAEb3" ] }, "error_handler": { "x": -58931392.41100744, "y": 21623556.90606135, "gridCoordinate": { "x": 60425122.601929456, "y": 3991971.702322766 }, "name": "childJob", "location": "Application", "locationType": null, "app": "pariatur", "canvasName": "voluptate sed proident culpa", "displayName": "exercitation et minim", "summary": "anim sint aliqua aute elit", "description": "Duis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/O/~0" }, { "type": "encryption", "pointer": "/ctH12/TrcXZ/~0/~0" }, { "type": "encryption", "pointer": "/zj4/~0/TTPcg.F/s/mp.lug/~1/SRc/zNG.1Z/R6-L3.wUY/~1/FsJX9u/E5" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "est in qui ullamco tempor", "highlightString": "ullamco sunt do fugiat" }, { "key": "dolore nisi elit", "highlightString": "eiusmod" } ], "status": "paused", "previous": { "incomplete": [ "3a1f", "3a1f" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "workflow_end" ], "error": [ "workflow_start", "workflow_start", "error_handler", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "irure enim sint", "start_time": "2005-01-20T01:56:44.527Z", "end_time": 23510311.994706795, "finish_state": "error", "retrySettings": { "state": [ "error", "success", "failure", "error", "success" ], "autoRetry": true, "limit": 94147569, "delay": 87767345, "count": 5971564, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ "default", { "_id": "0161446154b6da5881ceba9e", "provenance": "aute culpa", "name": "aliquip", "description": "reprehenderit ut esse", "memberOf": [ { "groupId": "cc7490f3c4c9a5f933b96305", "aaaManaged": true }, { "groupId": "2c7cc53fccf0638c620a486f", "aaaManaged": true }, { "groupId": "25454e40d42634b9f61adede", "aaaManaged": false }, { "groupId": "383e33cf4a5caaaa4751fe48", "aaaManaged": false }, { "groupId": "3a2a6a1e1e9d6efa3131bc25", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla deserunt pariatur aliqua anim" }, { "roleId": "non cillum elit" }, { "roleId": "in" }, { "roleId": "ad aute" } ], "inactive": true, "_meta": { "created": "1963-08-11T22:53:49.989Z", "updated": "2018-02-14T19:49:48.966Z", "migrationVersion": -56818560 } }, "default", "default" ], "iterations": [ "8c4dD1BF-eAFa-D545-D2F8-9c83f6Be690b", "B6dDc7Ab-c77d-eFBc-C2b6-EF0C7CceE8DE" ] } }, "parent": { "job": "nulla qui eu adipisicing sit", "task": "nulla", "iteration": -75131218.50497568, "element": 86617076.46232948 }, "errorHandler": { "x": 85107361.14577192, "y": -29659659.841020063, "gridCoordinate": { "x": 49398886.15377757, "y": 90699171.43677583 }, "name": "laboris fugiat aute", "location": "Broker", "locationType": null, "app": "voluptate sint Excepteur", "canvasName": "tempor", "displayName": "in nisi", "summary": "in eiusmod", "description": "reprehenderit sed labore incididunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/C6uE2fv81QZ/gPLjR7V/~1/~0/~1/l/~0/~1/~1/~1/L3650" }, { "type": "encryption", "pointer": "/n13/X6m.kkAfAL4" }, { "type": "encryption", "pointer": "/Jsf,/rnBIZv/~1/hrZ,Y/gWQ0XqqUo/Gw/~0/DlWY/m1,/S-5iK9c1at/~1" }, { "type": "encryption", "pointer": "/jKV/~1/~1/udIGOHa89g/~0/~1/aDVLVB7Q/~0/~0/sQkI3rmXId" }, { "type": "encryption", "pointer": "/qY7/~0/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "aliquip ea in consectetur ut", "highlightString": "elit aute dolore irure" } ], "status": "failure", "previous": { "incomplete": [ "workflow_end", "e28f", "workflow_end" ], "complete": [ "e28f", "workflow_end", "workflow_start", "3a1f" ], "error": [ "error_handler", "3a1f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "nostrud ea", "start_time": "2024-12-29T14:32:46.179Z", "end_time": 33671236.55010928, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": { "_id": "b429ec26a1e059e76b3e7b93", "provenance": "ullamco", "username": "elit", "firstname": "aute eu", "memberOf": [ { "groupId": "aae5bd608306e99435d2c4b4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure" } ], "inactive": true, "lastLogin": "1976-10-12T12:33:55.026Z", "_meta": { "created": "2012-01-29T10:37:39.016Z", "updated": "1973-10-07T15:13:50.301Z", "migrationVersion": -25159028 }, "email": "culpa" }, "groups": [ "default", "default", "default" ], "iterations": [] }, "groups": [ { "_id": "953037793c7839a418e95399", "provenance": "in", "name": "est", "description": "tempor", "memberOf": [ { "groupId": "c31a7967ae3ecd9d7e67dd3a", "aaaManaged": true }, { "groupId": "fef7923ffc68eef8024c7e7d", "aaaManaged": true }, { "groupId": "608668614d7b530572f985d0", "aaaManaged": true }, { "groupId": "3724a5faa00cba93dc6693d6", "aaaManaged": true }, { "groupId": "5acc12641478cbb87827188b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam laboris aute" }, { "roleId": "in nostrud mollit eiusmod do" }, { "roleId": "culpa Ut pariatur nostrud" } ], "inactive": true, "_meta": { "created": "1996-04-23T02:28:44.871Z", "updated": "1948-10-24T10:33:48.6Z", "migrationVersion": 96070025 } } ], "watchers": [ "Pronghorn" ], "metrics": { "start_time": -38578355.87007985, "progress": 0.19318689784007437, "end_time": 59642096.62864423, "user": "b14336e3e769945f5a96d06a", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }