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": "sint ea incididunt", "options": { "description": "Example job description", "type": "automation", "groups": [ "ce1323cbc451591f74908919", "896b1aba39e0ffff9cc1fa7e", "b59cb725b7a53f49893da640", "1f226f3a0923c031f99922c1" ] } }
{ "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": "7a3714c2028dd46689130635", "font_size": 55001482, "type": "resource:action", "created": "1949-01-28T17:01:56.431Z", "last_updated": "1984-10-17T05:16:24.469Z", "createdVersion": "986.28388.1", "lastUpdatedVersion": "0798555120.640785545.409255349-7875.1834673533.87212502342.15859", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -42304547, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -95008702.3470854, "sla": 80007346.77325177, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/Ch3zi.m5/~0/LyHR8Orv.7/WYDCYJJBR8M/BxXtG/~1/~1/p4cU" }, { "type": "encryption", "pointer": "/p/~0/~1/~0/h,gU3ZO7/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/iiK" } ], "status": "running", "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" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "deserunt" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "ea" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "adipisicing qui minim irure dolore" } ], "ancestors": [ "7de2a99ef02c977d9c53d933", "21ef86bb263df3ed5d0c48e8", "8f1ef9a72396afa537b21013" ], "validationErrors": [ { "keyword": "fugiat eiusmod minim dolor commodo", "dataPath": "Ut proident sunt dolore adipisicing", "schemaPath": "aliquip tempor reprehenderit quis", "message": "enim esse ullamco" }, { "keyword": "ex", "dataPath": "aliqua sed Excepteur", "schemaPath": "quis exercitation", "message": "velit dolor sed" } ], "created_by": "750d047f3f0f8efdb86a712d", "last_updated_by": null, "tasks": { "workflow_start": { "x": -43977389.5458611, "y": -46130109.37953556, "gridCoordinate": { "x": 21178961.533682287, "y": 29451569.59548326 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 62709776.655818224, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "2bb2bcf683c16c0eb571bc18", "default" ], "iterations": [ "25416A4b-7D34-a42f-37e8-2e681dFa86A4", "fc80DD08-fc4D-0A6B-f3dd-Ae2d3C4DeA5d", "93185e1f-ADd1-Fb2E-0fC2-bA1a98C5043E" ] }, "workflow_end": { "x": 41428272.23247716, "y": 70225838.75408533, "gridCoordinate": { "x": -28830586.266731203, "y": -52075101.02137567 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler", "workflow_start", "3a1f" ], "complete": [ "3a1f", "workflow_start", "e28f", "workflow_end" ], "error": [ "3a1f", "workflow_end", "e28f", "e28f", "3a1f" ] }, "metrics": { "end_time": 17338269.400317818, "run_time": -35357791.8667233 }, "groups": [ { "_id": "c0371d6ee685a80b8d3ca1a6", "provenance": "labore ut reprehenderit", "name": "pariatur dolore ut et aliquip", "description": "ipsum eiusmod", "memberOf": [ { "groupId": "e7b8366e4e0ee3c42e73c564", "aaaManaged": true }, { "groupId": "165aba04ea893848bbb0c402", "aaaManaged": true }, { "groupId": "7d945bea810b6d24eaf317e3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis nisi sed ipsum" }, { "roleId": "occaecat Duis cillum" }, { "roleId": "enim pariatur" } ], "inactive": false, "_meta": { "created": "1974-12-22T16:53:55.895Z", "updated": "1982-07-18T02:32:42.15Z", "migrationVersion": -33258401 } }, "d098bba0c42cff62fd057a38", { "_id": "ddad08aa5fb381693f94cfe0", "provenance": "cupidatat", "name": "Excepteur amet minim eiusmod aliqua", "description": "eiusmod sunt aute", "memberOf": [ { "groupId": "f7bada49e83e5d4e16a15998", "aaaManaged": false }, { "groupId": "549f6291495c25c5831c73f8", "aaaManaged": false }, { "groupId": "f1750bef1e39e6ca7d3e1afd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea" }, { "roleId": "voluptate Duis magna incididunt" }, { "roleId": "nostrud sunt" } ], "inactive": false, "_meta": { "created": "2023-05-05T07:39:06.51Z", "updated": "2003-06-12T18:14:52.945Z", "migrationVersion": -90720351 } }, { "_id": "c02e51f1b55b49c6f1b8a426", "provenance": "minim ipsum pariatur Lorem incididunt", "name": "commodo est", "description": "pariatur ut amet mollit sed", "memberOf": [ { "groupId": "ba41856c58808793aa420da2", "aaaManaged": true }, { "groupId": "7c097efeeaedd8ce2b4ae64d", "aaaManaged": false }, { "groupId": "887a60d11d1c5f67a3bdd24b", "aaaManaged": false }, { "groupId": "7be0b7d844ffd16e23fb7ae1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad aliqua" }, { "roleId": "in occaecat" }, { "roleId": "laboris nostrud non commodo pariatur" }, { "roleId": "aliqua non Lorem ea consequat" } ], "inactive": false, "_meta": { "created": "1999-03-05T06:24:16.449Z", "updated": "1971-07-11T19:14:18.069Z", "migrationVersion": -6098863 } }, { "_id": "8d8e6f935c681806940fbbc7", "provenance": "proident enim", "name": "reprehenderit", "description": "magna elit labore culpa", "memberOf": [ { "groupId": "da8816d92e91153feff705da", "aaaManaged": false }, { "groupId": "fb9323c9d873f2b5e5010b3c", "aaaManaged": false }, { "groupId": "c68025624749f7849cd583a4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt velit dolore officia" }, { "roleId": "occaecat et ex reprehenderit" } ], "inactive": false, "_meta": { "created": "2010-08-26T21:18:15.983Z", "updated": "2003-06-01T17:27:17.294Z", "migrationVersion": 40707133 } } ], "iterations": [ "d0Bf59cC-a470-08C8-ebc7-4Ce0EbCf9d5A", "711FB9eb-Aeb6-CA6C-Ab74-3f8074CEDAfF", "fCeAFADf-bFFB-4E50-dcDd-7A1526a7D0cF" ] }, "error_handler": { "x": 32586384.848285913, "y": -93012044.3669125, "gridCoordinate": { "x": 75677377.14424586, "y": -46017493.11242815 }, "name": "childJob", "location": "Application", "locationType": "sunt", "app": "proident ut", "canvasName": "sed", "displayName": "ut non pariatur voluptate cupidatat", "summary": "proident aliquip sunt", "description": "pariatur cillum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/EqhQtedzI,a" }, { "type": "encryption", "pointer": "/~1/~0/~0/ymcDv/~0/IwdOZ/dR4/jn1hu8W" }, { "type": "encryption", "pointer": "/dMDy10/kpU+9K.Nm/~0" }, { "type": "encryption", "pointer": "/~1/~0/~0/EO3.F./z/nN/~1/A/~0/tp2BFOTx-Q" }, { "type": "encryption", "pointer": "/Yif9/bKBU//n/xStg" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "labore eiusmod ex fugiat ipsum", "highlightString": "ex nostrud labore" }, { "key": "minim Excepteur aute", "highlightString": "ut elit in exercitation" }, { "key": "do consectetur sit", "highlightString": "sed" }, { "key": "cillum sed aliquip deserunt fugiat", "highlightString": "eu quis officia consectetur" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_end" ], "complete": [ "3a1f" ], "error": [ "workflow_start", "workflow_start", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "velit voluptate eiusmod est et", "start_time": "2000-09-13T08:55:06.178Z", "end_time": 21687974.175903738, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "92c9da913929438c8dcc55ea", "groups": [ "default", { "_id": "34fd48e60252df6cfb7e7703", "provenance": "in consectetur nulla", "name": "minim amet exercitation officia cupidatat", "description": "nulla labore", "memberOf": [ { "groupId": "ec164d29e9e91fcf7290c19f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure et" } ], "inactive": false, "_meta": { "created": "1991-10-10T13:44:49.007Z", "updated": "2006-04-25T05:01:54.518Z", "migrationVersion": -48057378 } }, "default", "default" ], "iterations": [ "4505bA2F-458A-D7bB-0Ea8-85F131a00405" ] }, "7f59": { "actor": "job", "groups": [ { "_id": "6b3fe7e3796d791921f0cb80", "provenance": "fugiat cillum ipsum", "name": "Ut et tempor dolor", "description": "sit culpa quis", "memberOf": [ { "groupId": "d9bc85777d0037d5836590c9", "aaaManaged": false }, { "groupId": "fea3d2b1a0fda694a04701a0", "aaaManaged": true }, { "groupId": "f71d9558c85e35c9a4c0b5d1", "aaaManaged": true }, { "groupId": "5581150a4611b407151a03d6", "aaaManaged": true }, { "groupId": "6e342067683f904c8b7542a7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa ea veniam" }, { "roleId": "commodo sed laboris" } ], "inactive": false, "_meta": { "created": "2000-10-15T07:15:45.933Z", "updated": "1987-03-12T05:59:21.942Z", "migrationVersion": 99218112 } } ], "iterations": [ "0249D9Dc-111C-5B7A-e423-fdBeCd12F4B3" ], "x": 72844255.38077763, "y": -60704762.731001385, "gridCoordinate": { "x": 9593649.058865234, "y": 66891666.88244933 }, "name": "laborum ipsum tempor nisi velit", "location": "Application", "locationType": "veniam", "app": "anim", "canvasName": "sunt enim anim", "displayName": "fugiat", "summary": "veniam Duis", "description": "ex in consequat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/E0MBaUu/~0/Jr.NqDma/p40EMF2EtlO/q,6/~0/PJRyJ2x382/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "non sunt reprehenderit minim enim", "highlightString": "esse" }, { "key": "laborum anim Ut aliqua dolore", "highlightString": "voluptate et" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "error_handler", "3a1f", "workflow_start" ], "complete": [ "3a1f" ], "error": [ "workflow_start", "workflow_start", "workflow_start", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "nisi", "start_time": "1966-07-10T15:30:46.261Z", "end_time": -54750742.14988167, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "ut Duis magna velit" } }, "parent": { "task": "quis Lorem", "iteration": -54612874.88912494, "element": -11431059.309079126 }, "errorHandler": null, "groups": [ "e88f367708a909ecc70bc586", "20d961f2f122d73eb9c62d82", { "_id": "270f1b5b5d92fd685ee60362", "provenance": "ex irure", "name": "eu minim", "description": "aliqua pariatur deserunt sit adipisicing", "memberOf": [ { "groupId": "2b42da52d15aa027eac93bc2", "aaaManaged": false }, { "groupId": "f7d647fb0b715442c48248e1", "aaaManaged": true }, { "groupId": "13c8544c97a448af66ec42a7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum" }, { "roleId": "deserunt occaecat eu aliqua quis" }, { "roleId": "qui mollit cillum dolore non" }, { "roleId": "reprehenderit ad" }, { "roleId": "ex sit nulla magna reprehenderit" } ], "inactive": false, "_meta": { "created": "1974-08-23T09:35:34.743Z", "updated": "1966-11-23T04:43:44.723Z", "migrationVersion": -38612811 } }, "265a17463a752f17a9cc587e" ], "watchers": [ "Pronghorn", "Pronghorn", { "_id": "9455ebc6ed95a6902a2a70f4", "provenance": "veniam ut ipsum dolore", "username": "culpa", "firstname": "do consequat", "memberOf": [ { "groupId": "f5477fbb69bb6756f135a367", "aaaManaged": false }, { "groupId": "0c959b9fdc42ae89865dd37b", "aaaManaged": false }, { "groupId": "a066478954de712978c83d53", "aaaManaged": false }, { "groupId": "c2faa6610454211598355bbc", "aaaManaged": true }, { "groupId": "e66bb6c3e359c801a4a70235", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa in ullamco" }, { "roleId": "magna officia voluptate cillum" } ], "inactive": false, "lastLogin": "1975-02-17T16:47:15.113Z", "_meta": { "created": "2002-10-03T14:17:25.141Z", "updated": "1992-05-18T21:25:36.999Z", "migrationVersion": 69637662 }, "email": "velit" }, "Pronghorn", "182d6ce26751dde8a61ee446" ], "metrics": { "start_time": 64910587.66770527, "progress": 0.2593742563415169, "end_time": -83485571.2471262, "user": null, "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }