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": "elit Ut reprehenderit deserunt sunt", "options": { "description": "Example job description", "type": "automation", "groups": [ "cda74fbb8485e942f0cd1308" ] } }
{ "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 created the requested item", "data": { "_id": "25e9222db26eef9674fee4e1", "uuid": "d7124ee9-250e-f285-1b9e-4c97c1eff6c5", "font_size": -49713019, "type": "resource:action", "created": "2003-02-20T06:40:16.71Z", "last_updated": "1959-08-29T01:48:13.76Z", "createdVersion": "740122868.1285.099903457", "lastUpdatedVersion": "098.03.88819075-3316.5119.36196225", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -24692547, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -63923052.103524245, "sla": -24111345.29653065, "decorators": [ { "type": "encryption", "pointer": "/~0/O/~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 } ], "warnings": [ { "task": "e28f", "name": "myCoolDocumentName", "message": "enim in proident Duis commodo" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "officia", "instancePath": "in amet in sed aliquip", "schemaPath": "minim est ullamco incididunt", "message": "id ut" } ], "created_by": { "_id": "c380114f44398c6c61afcde8", "provenance": "labore sint", "username": "voluptate ex nisi cupidatat irure", "firstname": "exercitation", "memberOf": [ { "groupId": "4ea54567865b706294b1ffb5", "aaaManaged": false }, { "groupId": "19b26564035dd97bba0df033", "aaaManaged": true }, { "groupId": "6dd6ffe9b4f9a009f324d772", "aaaManaged": true }, { "groupId": "f5a260c4c36de46684aae312", "aaaManaged": true }, { "groupId": "f316af2ea55322a779d5606d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris ullamco Excepteur" }, { "roleId": "Ut magna est dolore ut" }, { "roleId": "sit nisi mollit reprehenderit proident" } ], "inactive": false, "lastLogin": "1965-03-23T10:27:19.195Z", "_meta": { "created": "1982-06-30T03:53:40.968Z", "updated": "1987-09-11T16:28:59.763Z", "migrationVersion": 93483115 }, "email": "ut nisi mollit sint" }, "last_updated_by": "a1c578b606d394127f572e1f", "tasks": { "workflow_start": { "x": -67539859.25802004, "y": 40479788.53885406, "gridCoordinate": { "x": 48635022.01741299, "y": -92606499.35192649 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 75088435.29732552, "finish_state": "failure", "user": { "_id": "0a80be6e3708279e8e3414eb", "provenance": "Ut do sunt", "username": "Excepteur", "firstname": "officia voluptate ut est", "memberOf": [ { "groupId": "6f94bf4678e756f4eb286e78", "aaaManaged": false }, { "groupId": "9f687457ab6d4248f0658b6e", "aaaManaged": true }, { "groupId": "334ad15392440663ffa6eca7", "aaaManaged": false }, { "groupId": "ebd90dd42a4a816702be82ad", "aaaManaged": false }, { "groupId": "869189a76e4c50a81ae39634", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit do" }, { "roleId": "esse" }, { "roleId": "ullamco eiusmod" } ], "inactive": true, "lastLogin": "1948-02-09T18:59:43.807Z", "_meta": { "created": "1974-10-24T08:30:12.975Z", "updated": "2022-05-14T08:18:56.796Z", "migrationVersion": -58659754 }, "email": "in velit est commodo" } }, "groups": [ { "_id": "013bc67e8c3b512a19cce011", "provenance": "nulla cupidatat quis anim", "name": "consequat veniam enim laborum nulla", "description": "voluptate", "memberOf": [ { "groupId": "5c089613700f2aeb70518e64", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum nisi tempor in" }, { "roleId": "id in sunt" } ], "inactive": true, "_meta": { "created": "1983-09-27T22:26:51.634Z", "updated": "2000-10-09T16:41:44.061Z", "migrationVersion": -92846162 } }, "default" ], "iterations": [ "fb26AEb4-13E9-0dab-Ec73-004cf8C12a88", "3e4bEBAd-eCc7-5f64-dBbA-F3e6088631EC", "8fFa7D2B-dCC7-9A5D-69d5-1F1cfA609DA6" ] }, "workflow_end": { "x": 26469405.72420138, "y": 5043000.514236078, "gridCoordinate": { "x": 27449591.88631007, "y": -90708572.13896422 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "error_handler", "e28f", "workflow_start" ], "complete": [ "workflow_start", "e28f", "error_handler" ], "error": [ "e28f", "error_handler", "error_handler", "workflow_start" ] }, "metrics": { "end_time": -67538420.04691744, "run_time": 84830209.44501981 }, "groups": [ "65f0f56d2c6255f228d9d33f", "default", "default", "bc967c246658755ec4f3f234" ], "iterations": [ "58e9DA34-8dEF-2Ecf-Fa8E-CE8afF7ac7bE", "fD5c3C06-Efb0-3B08-cB7B-F482DC2aaEF5", "B1BEF6Cf-0Ce4-3b86-BA65-FFFDDD475b37" ] }, "error_handler": { "x": 91477555.15949681, "y": -65704790.83421441, "gridCoordinate": { "x": -83588241.75954908, "y": 86163184.24170166 }, "name": "childJob", "location": "Application", "locationType": "aute elit ullamco Duis", "app": "labore mollit reprehenderit", "canvasName": "sunt consectetur", "displayName": "reprehenderit non commodo", "summary": "aliquip dolor ipsum", "description": "fugiat velit incididunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/i/~0" }, { "type": "encryption", "pointer": "/~0/~1/GkRXlc/~0/euI/~1" }, { "type": "encryption", "pointer": "/~0/~0/A4/GEfc5" }, { "type": "encryption", "pointer": "/oC-" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "irure quis", "highlightString": "sint laboris" }, { "key": "Lorem", "highlightString": "eu aute deserunt" }, { "key": "in labore ut dolore qui", "highlightString": "nulla nisi" } ], "status": "paused", "previous": { "incomplete": [ "e28f", "e28f", "3a1f" ], "complete": [ "workflow_end", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "loop" } ] }, "serverId": "amet quis", "start_time": "1978-05-10T05:01:25.13Z", "end_time": -51900035.76250648, "finish_state": "error", "retrySettings": { "state": [ "error", "failure", "failure" ], "autoRetry": false, "limit": 99874121, "delay": 88284568, "count": 82776843, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "e6256c7ef559262208f530bc", "provenance": "aliqua eiusmod quis reprehenderit Lorem", "name": "incididunt ad", "description": "ut sed occaecat reprehenderit", "memberOf": [ { "groupId": "dae5e26885a8961373e5e593", "aaaManaged": true }, { "groupId": "0251b849219f68d14e48437f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation Excepteur et ex sed" }, { "roleId": "labore Ut" }, { "roleId": "aute" } ], "inactive": true, "_meta": { "created": "1960-01-29T14:18:58.916Z", "updated": "2009-04-29T10:42:18.333Z", "migrationVersion": -97286108 } }, "default", "default", "default" ], "iterations": [ "e2AAab7e-aD42-a566-4eE2-ABAB32ff4203", "B6Da8d13-8954-fCF8-1A8c-6d48322666c0" ] }, "b5a8": { "actor": "job", "groups": [ "0ca72a7e94fa06f993aca475", "default" ], "iterations": [ "b89B1dd0-e38a-827a-4324-E08ED5D91eDd" ], "x": -4779333.0968245715, "y": -34353743.72907618, "gridCoordinate": { "x": -84439009.48437442, "y": 39210781.81348586 }, "name": "labore dolore voluptate amet aliquip", "location": "Broker", "locationType": "aliqua dolore sunt minim voluptate", "app": "voluptate dolore ipsum", "canvasName": "childJob", "displayName": "qui adipisicing exercitation incididunt nulla", "summary": "do mollit qui consequat dolor", "description": "aliqua officia minim et", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/SgeM/~0/ZEv5O93/KM/EctzTt/~0/~0/f/h/~1/~0/F5hCljmxMq" }, { "type": "encryption", "pointer": "/e0gG9-9qusv/aV.l3/~0/~1/coC/MDQ4/Mpc7e/i5-uA/S/n/KDHREaZp/c6.KQTico6c" }, { "type": "encryption", "pointer": "/dQjTeV7Db8/nrmWw3ni/~0" }, { "type": "encryption", "pointer": "/~0/MJ80IRwd-//n.I.Cb-+g/A65kkXdixSk/~0/~1/~0/crsjY7Zh,ah/tz/~0/~0" }, { "type": "encryption", "pointer": "/j.SOXJhvX/d/~0/ziozr5Cfzv./hrVk+Kt-R/N-./tV2y" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "tempor", "highlightString": "pariatur qui aliquip" }, { "key": "in", "highlightString": "dolor" }, { "key": "dolore labore nostrud", "highlightString": "ut" }, { "key": "incididunt", "highlightString": "est Ut aliquip voluptate" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "workflow_start", "error_handler", "3a1f", "workflow_start" ], "complete": [ "error_handler", "e28f", "3a1f", "workflow_start" ], "error": [ "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "sint enim occaecat consequat velit", "start_time": "1967-11-09T00:42:49.383Z", "end_time": 12874548.394337282, "finish_state": "error", "retrySettings": { "state": [ "error", "failure" ], "autoRetry": false, "limit": 78985907, "delay": 71661561, "count": 75968811, "finishedRetrying": true }, "loop": { "atLeastOneComplete": false, "finishedCount": -39943885.96240892, "outgoing": [] }, "childJobs": [ { "_id": "labore aute non", "name": "ut elit", "iteration": 57035143.66213766 } ] } }, "parent": { "task": "ut", "iteration": 8188042.064722851, "element": -80016607.73346174 }, "errorHandler": null, "groups": [ "default" ], "watchers": [ "Pronghorn", "Pronghorn", { "_id": "4c79aa5d9e9a66362605eeb0", "provenance": "dolore nulla quis exercitation", "username": "sit proident", "firstname": "commodo", "memberOf": [ { "groupId": "7da11d305e34d040bc2b5103", "aaaManaged": false }, { "groupId": "ba909f1a31ab19a1f1033995", "aaaManaged": false }, { "groupId": "4042d794e45bf7515ec49048", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum" }, { "roleId": "sit laborum incididunt amet ex" }, { "roleId": "nostrud" } ], "inactive": true, "lastLogin": "2016-03-11T09:13:54.635Z", "_meta": { "created": "1967-06-07T07:24:15.206Z", "updated": "2002-12-03T05:46:41.571Z", "migrationVersion": -57232219 }, "email": "veniam sit in adipisicing" }, { "_id": "4d352676196f6d5bbfe33d02", "provenance": "ut dolore", "username": "consequat mollit dolor culpa magna", "firstname": "magna dolore ipsum", "memberOf": [ { "groupId": "121ec1d246af87c20686f615", "aaaManaged": false }, { "groupId": "46012754d117bca31467b32b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit sit Ut consequat quis" }, { "roleId": "do commodo dolore" }, { "roleId": "ea fugiat et" } ], "inactive": false, "lastLogin": "1946-06-13T06:06:35.039Z", "_meta": { "created": "1952-05-14T05:37:58.85Z", "updated": "1979-04-08T10:14:25.976Z", "migrationVersion": -49526350 }, "email": "pariatur in ullamco sed" } ], "metrics": { "start_time": -1365392.5697881132, "progress": 0.5012951581751222, "end_time": 37332995.40956271, "user": { "_id": "bda5f5cd57d41ec7e50a5039", "provenance": "consequat", "username": "ex", "firstname": "mollit consequat anim eiusmod", "memberOf": [ { "groupId": "fd00207ec1b98ee5dc4e2763", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt" }, { "roleId": "dolor aliqua incididunt" }, { "roleId": "dolor" } ], "inactive": true, "lastLogin": "1980-07-17T12:36:08.11Z", "_meta": { "created": "1953-06-06T16:49:53.56Z", "updated": "1975-10-01T03:13:52.068Z", "migrationVersion": -6187987 }, "email": "ut aliqua commodo ad" }, "owner": { "_id": "e43d9fb2c4b41c47740a81ad", "provenance": "Excepteur consequat dolor deserunt", "username": "in ut ea Duis", "firstname": "occaecat Ut", "memberOf": [ { "groupId": "995c8eeccc2fa61c2000a11a", "aaaManaged": true }, { "groupId": "f890075bdb042b944b715177", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum cupidatat non consectetur" } ], "inactive": true, "lastLogin": "1950-02-13T09:57:41.54Z", "_meta": { "created": "2015-09-18T14:02:44.721Z", "updated": "1965-10-13T20:12:55.088Z", "migrationVersion": 72295034 }, "email": "sit eu anim fugiat" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }