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": "consequat in quis fugiat consectetur", "options": { "description": "Example job description", "type": "automation", "groups": [ "cea395057416e617630cba22", "4a282a57621c25ece6e3d7a6" ] } }
{ "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": "20af962072b378c7dd244a3b", "font_size": 37130207, "type": "resource:action", "created": "1971-07-02T20:11:33.165Z", "last_updated": "1969-10-09T16:36:38.032Z", "createdVersion": "17652.196.970", "lastUpdatedVersion": "317986188.7967.53596527", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -4768637, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 84186394.9406592, "sla": 21416166.30096528, "decorators": [ { "type": "encryption", "pointer": "/Q+i8a0EM/eDeK3r2-Py/~1/vLsG9/~1" }, { "type": "encryption", "pointer": "/On5U/~1" }, { "type": "encryption", "pointer": "/~1/~1/~1/~0/KduPY-tYmbC/~0/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1/v2/hBE+TJ/THW3Ct3k/s/6Y++R.1-L/~1" }, { "type": "encryption", "pointer": "/LcrYbr/GhFf" } ], "status": "running", "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": "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": "e28f", "name": "myCoolDocumentName", "message": "ut sit" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "non consequat commodo magna Excepteur" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "sunt", "dataPath": "nulla consequat", "schemaPath": "fugiat", "message": "et adipisicing proident ex" }, { "keyword": "fugiat consectetur officia do in", "dataPath": "nisi ut magna cupidatat fugiat", "schemaPath": "incididunt nostrud est irure", "message": "magna cillum fugiat incididunt" }, { "keyword": "deserunt nisi laborum", "dataPath": "laboris et", "schemaPath": "Lorem Excepteur adipisicing cillum nulla", "message": "sed laboris esse cupidatat" }, { "keyword": "nisi irure ullamco aliquip", "dataPath": "aute dolor", "schemaPath": "fugiat quis aliquip do pariatur", "message": "voluptate amet" } ], "created_by": null, "last_updated_by": "Pronghorn", "tasks": { "3": { "actor": "job", "groups": [ "67e47e24f087c293ffb293a7", "d6b1ed644593b50a7eb76dac", { "_id": "f4d64ee0d59e442a08094e61", "provenance": "tempor laboris culpa elit dolor", "name": "occaecat sit deserunt irure", "description": "dolore consequat Duis deserunt culpa", "memberOf": [ { "groupId": "1157a756ac48e1a1b4a056cb", "aaaManaged": true }, { "groupId": "3e7b0d9988ee65a7d5b47ee1", "aaaManaged": false }, { "groupId": "4ce72b9152d0c86024e8f649", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco et" } ], "inactive": true, "_meta": { "created": "2007-10-09T15:47:01.027Z", "updated": "2002-10-23T12:57:17.145Z", "migrationVersion": 27967727 } }, "default" ], "iterations": [ "1DF02229-6E36-bECe-293c-7EBFBBBCe123" ], "x": -27645782.370415047, "y": 59798813.36511096, "gridCoordinate": { "x": 72568653.1255343, "y": -78310151.40877065 }, "name": "fugiat cillum elit", "location": "Adapter", "locationType": "magna tempor", "app": "aliquip", "canvasName": "childJob", "displayName": "quis irure Excepteur", "summary": "magna in", "description": "adipisicing", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/pHL2EnfT/~0/P,/wN/e/E-tDUwyq8G/LvkD-27/yp.R6s/~1/~0/~0" }, { "type": "encryption", "pointer": "/~0/nRV/O4+,tEqctl2" }, { "type": "encryption", "pointer": "/~0/RV7r3/~1/mrjU/e/jo5IgnD/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/~1/~1/~0/~1" }, { "type": "encryption", "pointer": "/Z/~0/v-geQFny7Og/X7tk9X" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "aliqua Duis exercitation", "highlightString": "ipsum ex occaecat nostrud" }, { "key": "enim", "highlightString": "eiusmod voluptate est" }, { "key": "qui sit sunt", "highlightString": "aliqua ex ut Lorem" }, { "key": "nulla quis", "highlightString": "incididunt ad amet" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "e28f", "workflow_end", "e28f", "workflow_end" ], "complete": [ "workflow_start" ], "error": [ "3a1f", "3a1f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "anim Lorem incididunt", "start_time": "2011-09-01T22:27:06.341Z", "end_time": -99382389.77574292, "finish_state": "error", "retrySettings": { "state": [ "success", "failure" ], "autoRetry": false, "limit": 66441992, "delay": 9210, "count": 54570828, "finishedRetrying": true }, "loop": { "atLeastOneComplete": true, "finishedCount": -95797830.05218956, "outgoing": [ "non" ] }, "childJobs": [ { "_id": "ipsum Ut", "name": "Duis quis sunt nostrud mollit", "iteration": -43826460.000844136 }, { "_id": "ipsum nostrud Lorem Excepteur", "name": "dolore dolor cupidatat eu", "iteration": 59934471.069159865 } ] }, "workflow_start": { "x": -17622217.29477851, "y": -74580024.91130298, "gridCoordinate": { "x": 34467383.376427025, "y": -46211870.03508251 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 50709121.0047915, "finish_state": "error", "user": null }, "groups": [ "default", "775c2bccbde916bb2fe0f1a9", "1452347ae60e1c5be9f6c2a8" ], "iterations": [] }, "workflow_end": { "x": 99875195.2926848, "y": -38369641.79042042, "gridCoordinate": { "x": 5133176.060434774, "y": -4285951.975202322 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler", "error_handler", "3a1f" ], "complete": [ "e28f" ], "error": [ "workflow_start", "e28f", "e28f" ] }, "metrics": { "end_time": 55199562.71687594, "run_time": -92417566.48594977 }, "groups": [ "default", "default" ], "iterations": [ "9CDBEeB3-4Ce0-bB10-0077-CcAb2b7e7230", "aFdceeB4-066c-34a5-999c-e57ef9f0755f", "50BddeD4-D6C0-AB2E-de1f-B3fA7da2eD8E", "4eDCb11d-e4C1-fbbf-CdEA-BAc82cFF69C3" ] }, "error_handler": { "x": -88508888.2502639, "y": 73603087.75625533, "gridCoordinate": { "x": -27465351.62128474, "y": -81981499.65567593 }, "name": "childJob", "location": "Broker", "locationType": "pariatur cupidatat anim", "app": "sunt", "canvasName": "tempor", "displayName": "in deserunt", "summary": "mollit incididunt non dolore amet", "description": "aliquip", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/gBta.4evUqk/~0/~0/pU1E2/~1/~0/MSWw/~0" }, { "type": "encryption", "pointer": "/~0/GSM/HImBqWMWcP/cj" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "dolore", "highlightString": "adipisicing ut mollit aute pariatur" }, { "key": "magna tempor laborum in", "highlightString": "sed sunt non veniam" }, { "key": "tempor commodo pariatur", "highlightString": "id dolor quis minim culpa" }, { "key": "irure in anim", "highlightString": "officia enim" }, { "key": "minim occaecat ad", "highlightString": "voluptate veniam qui dolor aliqua" } ], "status": "canceled", "previous": { "incomplete": [ "3a1f", "workflow_start", "e28f", "workflow_start" ], "complete": [ "workflow_end", "3a1f", "workflow_start" ], "error": [ "workflow_end", "error_handler" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "tempor culpa reprehenderit non", "start_time": "1979-08-28T20:05:28.794Z", "end_time": -81089723.14093491, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "02dc4a8006b16f2e14d487a6", { "_id": "2464e0347dd3b39226777b14", "provenance": "eiusmod aute nostrud", "name": "culpa non", "description": "nostrud sit occaecat eu", "memberOf": [ { "groupId": "9be769bab98cb8c108a511db", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliqua" }, { "roleId": "qui sed voluptate cillum" }, { "roleId": "quis nulla minim labore sunt" } ], "inactive": false, "_meta": { "created": "1958-01-10T19:51:36.899Z", "updated": "1949-04-25T12:57:14.539Z", "migrationVersion": 5982695 } }, "default", "default" ], "iterations": [ "2c2dF090-bB8d-Ed8E-449B-46ae560BA9Ee" ] } }, "parent": { "task": "elit eu anim dolore mollit", "iteration": 75759075.73842588, "element": 73768139.82088771 }, "errorHandler": { "actor": "Pronghorn", "groups": [ "default", "default", "default", "default" ], "iterations": [ "7A2153a6-C18f-A7aD-0Fec-64aD04b9fF63", "B3d1Da9A-Dd4e-cc58-aAFD-8CB8c52Ee2aD" ], "x": 17446599.038079083, "y": 38444552.5984987, "gridCoordinate": { "x": 30611188.020331025, "y": 9938116.488899902 }, "name": "laborum ullamco ad", "location": "Adapter", "locationType": null, "app": "nulla laborum in irure dolor", "canvasName": "childJob", "displayName": "dolore qui", "summary": "officia consectetur", "description": "culpa esse aliquip ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/Xo9tPMOS/d/pfxINx/~1/~0" }, { "type": "encryption", "pointer": "/L/~0/H/aymZvv1CExN/n7H/IK6/~0/Vy9DG/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "veniam deserunt aute occaecat voluptate", "highlightString": "Ut aliquip" }, { "key": "anim officia proident", "highlightString": "consectetur ut" }, { "key": "reprehenderit culpa elit in", "highlightString": "dolore ea eiusmod voluptate" }, { "key": "sit adipisicing", "highlightString": "sed magna" }, { "key": "ex amet adipisicing fugiat", "highlightString": "laboris sunt consequat fugiat" } ], "status": "complete", "previous": { "incomplete": [ "error_handler" ], "complete": [ "workflow_start", "error_handler" ], "error": [ "workflow_end", "workflow_start", "e28f", "e28f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "non id ipsum voluptate mollit", "start_time": "1967-06-09T03:05:09.645Z", "end_time": 94392371.95271254, "finish_state": "failure", "retrySettings": null, "loop": { "atLeastOneComplete": false, "finishedCount": -94331342.49737209, "outgoing": [ "exercitation enim pariatur non" ] }, "childJobs": [ { "_id": "officia aute enim culpa", "name": "id cupidatat Lorem", "iteration": -29990613.864071533 }, { "_id": "sed Excepteur commodo fugiat", "name": "et aliqua labore non", "iteration": 71162925.02448472 } ] }, "groups": [ "default", "default", "a3dfe188e11c21aacdc74d47", { "_id": "826418d5659706f0848e6c92", "provenance": "et irure Excepteur voluptate", "name": "in reprehenderit proident eiusmod quis", "description": "sint velit Ut ut aute", "memberOf": [ { "groupId": "37aca9eefba68528633ba826", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi ullamco dolor consequat cillum" } ], "inactive": true, "_meta": { "created": "1999-07-24T14:51:27.254Z", "updated": "1982-01-01T10:34:35.602Z", "migrationVersion": -71361182 } }, "7ce4f46b9e15fa37f2ab076a" ], "watchers": [ "Pronghorn", { "_id": "2ffa96452e1035ded6bfc225", "provenance": "amet culpa", "username": "Ut enim tempor ex sit", "firstname": "ea in et qui", "memberOf": [ { "groupId": "92190aeccd784412c5cc3d1a", "aaaManaged": true }, { "groupId": "0e4966c68be470d92516e992", "aaaManaged": false }, { "groupId": "484a82d7468dab0399471c03", "aaaManaged": false }, { "groupId": "c7626f44ab1bb976c474008b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut non aliquip" }, { "roleId": "sunt eu" }, { "roleId": "non" }, { "roleId": "do minim velit" }, { "roleId": "nulla Ut non" } ], "inactive": true, "lastLogin": "1981-07-28T16:38:40.588Z", "_meta": { "created": "1982-09-28T20:02:02.471Z", "updated": "1955-03-01T15:18:11.01Z", "migrationVersion": -65542256 }, "email": "sit elit commodo Excepteur velit" }, "Pronghorn", { "_id": "6e8ab0186122fcbe40d040a7", "provenance": "sed laborum", "username": "dolor sint Duis deserunt pariatur", "firstname": "nostrud laboris esse minim", "memberOf": [ { "groupId": "995a2bd7a052ffd78ba523a9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint" }, { "roleId": "consequat veniam ad pariatur" }, { "roleId": "nulla exercitation ipsum" } ], "inactive": false, "lastLogin": "2022-11-27T05:52:20.562Z", "_meta": { "created": "1965-08-02T15:05:00.602Z", "updated": "1956-06-22T01:38:21.106Z", "migrationVersion": 88090151 }, "email": "enim dolor in exercitation" } ], "metrics": { "start_time": -44655683.04668213, "progress": 0.35879259993097956, "end_time": 52221028.09786478, "user": "184efe531dc056738ee31f3b", "owner": "8c677fd01d62ca9edbd87779" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }