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": "laborum non irure", "options": { "description": "Example job description", "type": "automation", "groups": [ "3b626a1ed086e32dba98fd8b", "dab0a40861a7e3e866e0f2e8", "30a94e26e675669830c08440", "8a358f92eddc98e64ee88583" ] } }
{ "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": "18131a8253cfe230c90b5145", "font_size": 22711099, "type": "resource:action", "created": "1947-03-01T16:41:41.752Z", "last_updated": "1950-06-18T11:09:49.91Z", "createdVersion": "13.5535.961213532-2688.48519.614", "lastUpdatedVersion": "6.02544270872.1-2543.00230617890.5355205.5977", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 84408405, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 22113487.364557162, "sla": 15365006.135892361, "decorators": [ { "type": "encryption", "pointer": "/mTTh6MAYxk3/mmrRAO+/~0/~0/~1/nFtC4f,/S3o-m,/~1" }, { "type": "encryption", "pointer": "/~0/Ipvz.UNxbd/av0156.Q/~1/~1" } ], "status": "error", "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": "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "magna velit consequat id elit" } ], "ancestors": null, "validationErrors": [ { "keyword": "nisi", "dataPath": "tempor ut aliqua", "schemaPath": "ullamco laborum voluptate eu", "message": "qui adipisicing reprehenderit enim aute" }, { "keyword": "non sed dolore", "dataPath": "commodo amet nostrud et", "schemaPath": "ut ad", "message": "do Lorem aliquip consequat" }, { "keyword": "magna non", "dataPath": "nisi dolore Lorem", "schemaPath": "esse in", "message": "qui voluptate culpa" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "54": { "actor": { "_id": "b3e3cb3b3da94749eeb29228", "provenance": "nulla velit sunt", "username": "magna", "firstname": "ad Excepteur qui irure", "memberOf": [ { "groupId": "0157518d269078c3e16434bb", "aaaManaged": false }, { "groupId": "e5660d112f9a725084aa2498", "aaaManaged": true }, { "groupId": "db67ffc6ddafe3f6f9d3f0a5", "aaaManaged": true }, { "groupId": "39ca816c6b271deafff8a6a2", "aaaManaged": true }, { "groupId": "fd7f0bd7892a3526dd026bd7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "in sed minim" } ], "inactive": false, "lastLogin": "1968-12-16T15:13:24.436Z", "_meta": { "created": "2004-06-27T07:40:18.145Z", "updated": "2020-09-05T05:08:50.084Z", "migrationVersion": -28110956 }, "email": "dolor" }, "groups": [ "7e64509fd4795b922ffc7874", "default", { "_id": "98ed0b9c0eb51d38f24ae8ae", "provenance": "adipisicing minim voluptate est", "name": "est aliquip cupidatat occaecat", "description": "Duis tempor ad labore", "memberOf": [ { "groupId": "6b53c54e403da94e1b73ea0d", "aaaManaged": true }, { "groupId": "1bf060bf94c6e24c80535aea", "aaaManaged": false }, { "groupId": "4206f8f6b37ef5abec22a66f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad sint exercitation elit voluptate" }, { "roleId": "in" }, { "roleId": "magna qui" }, { "roleId": "non amet sit nisi ullamco" } ], "inactive": false, "_meta": { "created": "2002-12-20T19:55:20.509Z", "updated": "1949-11-12T20:52:55.629Z", "migrationVersion": -10597783 } }, { "_id": "040d6c2f807595b6b0bdd231", "provenance": "quis proident veniam nostrud tempor", "name": "consectetur dolore adipisicing Lorem", "description": "veniam laborum dolore", "memberOf": [ { "groupId": "3b8d239d858a84c05fb3d40c", "aaaManaged": true }, { "groupId": "1d6e684e4f7e905acad25e2b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "velit cupidatat Lorem nulla do" } ], "inactive": false, "_meta": { "created": "2002-02-01T19:39:05.981Z", "updated": "1993-01-01T09:51:43.357Z", "migrationVersion": -67017555 } } ], "iterations": [ "2AAF8D58-C8c6-e26A-fe5E-8dFe70A54220" ], "x": 72445225.38272965, "y": -16482336.361790136, "gridCoordinate": { "x": -44761092.7140369, "y": -3016214.553475693 }, "name": "anim ea labore dolor in", "location": "Application", "locationType": null, "app": "voluptate Lorem officia dolore", "canvasName": "elit do sint adipisicing", "displayName": "dolor sunt deserunt", "summary": "ut consectetur laboris", "description": "qui sed in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/DBOy4hMQRT/C-6x721Sh/~1" }, { "type": "encryption", "pointer": "/OvWo4KmpHx/lmKjKI1Td/ud2pto/bswN/~1/nZg908YH" }, { "type": "encryption", "pointer": "/~0/hkVVH8HDf,4/H/o0V780pH/~0" }, { "type": "encryption", "pointer": "/YZxF-kZ/~1/qhg.EdS/tJyTF" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "voluptate exercitation dolore qui", "highlightString": "anim ex pariatur nostrud" }, { "key": "exercitation", "highlightString": "commodo ullamco" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_end", "error_handler" ], "complete": [ "workflow_end", "3a1f", "workflow_end", "workflow_end" ], "error": [ "workflow_end", "e28f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "laborum", "start_time": "1994-07-13T11:06:30.62Z", "end_time": -33965982.211810976, "finish_state": "failure", "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 99898633, "delay": 95078949, "count": 95498371, "finishedRetrying": true }, "type": "manual", "view": "Lorem" }, "workflow_start": { "x": 44420945.73622581, "y": -50413878.83148061, "gridCoordinate": { "x": 1558736.3548484594, "y": -66606042.45485358 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -87410449.32760213, "finish_state": "error", "user": "Pronghorn" }, "groups": [ "8a7a848e22714c1d3a291bde", "default" ], "iterations": [ "95d1105E-B0a3-a48b-ED6a-5677Dbef9cef", "B979eFCd-daa1-E990-1F99-eE2BDBdF2d7A", "983DB562-9bCD-4bEe-3B4e-63d8E4cCb1A9" ] }, "workflow_end": { "x": 11892841.996182606, "y": 90343078.01382676, "gridCoordinate": { "x": 57560401.58249155, "y": -28042947.758999854 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_end", "e28f", "workflow_end" ], "complete": [ "error_handler" ], "error": [ "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 40273091.586117536, "run_time": -5277700.691261351 }, "groups": [ "default", "default", { "_id": "8c1f8fe2583552c55233df2f", "provenance": "officia", "name": "voluptate nostrud officia eu pariatur", "description": "magna Excepteur consectetur cupidatat nulla", "memberOf": [ { "groupId": "f64b9b619c1fccc7740e4f18", "aaaManaged": false }, { "groupId": "cc5523f1663af2c777a010dc", "aaaManaged": false }, { "groupId": "e690feb00b67cf2af642cc80", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "cupidatat ut dolore Lorem" }, { "roleId": "Duis nulla ea nostrud" }, { "roleId": "qui non dolor ad amet" } ], "inactive": true, "_meta": { "created": "1986-10-07T02:50:25.386Z", "updated": "1976-10-01T15:51:44.475Z", "migrationVersion": 25327045 } }, "86c8c4f9917fbaf5ba092d79" ], "iterations": [ "B6baA589-DBDe-eD59-Df10-eD4C0Ab23b67", "07FeFDdF-abc1-257B-db64-Ad7Ae695AFe1" ] }, "error_handler": { "x": 10231633.642193705, "y": -78429186.97093171, "gridCoordinate": { "x": 98063571.76691014, "y": -11500075.506363317 }, "name": "childJob", "location": "Broker", "locationType": "laboris laborum qui", "app": "est", "canvasName": "proident ea aliquip", "displayName": "nulla laboris", "summary": "mollit tempor cupidatat dolore", "description": "Lorem elit nulla laboris", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/vZTM/VPfn/S5Bk/fTey/TQFeEb9" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~1/~1/hkVf7/m6k/~1/gFBfgqwzf/iVDqS/~1/z0ib18CB803/ia3/o8" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "fugiat qui", "highlightString": "dolore esse minim ipsum" }, { "key": "amet est", "highlightString": "cillum sint irure ut" }, { "key": "voluptate velit est", "highlightString": "adipisicing" }, { "key": "labore Duis dolor", "highlightString": "cupidatat" } ], "status": "scheduled", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "e28f", "workflow_start" ], "error": [ "error_handler", "3a1f", "workflow_start", "3a1f", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "revert" } ] }, "serverId": "et labore ut", "start_time": "1995-07-03T10:02:19.204Z", "end_time": -24994915.609906524, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "fc4dcdb5ac02f37870e1690b", "provenance": "officia", "name": "eu do in culpa", "description": "occaecat do in", "memberOf": [ { "groupId": "85f64826af645c3114321bce", "aaaManaged": false }, { "groupId": "b9bb7aae71a3acabffc0e060", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt in do" }, { "roleId": "Lorem aliqua velit dolor minim" }, { "roleId": "ut do" }, { "roleId": "est Duis mollit cillum" } ], "inactive": false, "_meta": { "created": "2003-06-30T02:43:15.306Z", "updated": "1975-04-25T02:10:52.904Z", "migrationVersion": 98373774 } }, { "_id": "89466208b97f448233d5edcd", "provenance": "Lorem Ut culpa aliqua", "name": "sed esse", "description": "Excepteur velit", "memberOf": [ { "groupId": "01d8e915d8d01de34a9e6a72", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis dolore et in ad" }, { "roleId": "laboris Duis" } ], "inactive": false, "_meta": { "created": "1991-08-30T12:57:30.55Z", "updated": "1956-12-13T11:08:40.465Z", "migrationVersion": 12788633 } }, { "_id": "cccf9bcee70a3f4fb77ca5ed", "provenance": "dolore anim in tempor occaecat", "name": "dolore", "description": "Duis reprehenderit", "memberOf": [ { "groupId": "7599116f43d22492a426c32a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt velit commodo" }, { "roleId": "deserunt aliqua consequat sit" }, { "roleId": "do" } ], "inactive": false, "_meta": { "created": "2024-03-26T17:10:09.122Z", "updated": "1989-02-20T07:15:10.185Z", "migrationVersion": 12101054 } }, "8b8e8e082d60bc79decaf523" ], "iterations": [ "bb6eb545-b14c-d4BA-2Fc1-ddEcd290aBCA", "6E7bec8A-d972-392F-740c-F4CA0db6B96e", "44AF5cde-17a2-207E-90BE-cf1C36B3b2C3" ] } }, "parent": { "task": "sit quis laboris adipisicing", "iteration": -39588567.82651434, "element": 27914197.515102 }, "errorHandler": null, "groups": [ { "_id": "5360a3ad088ef2896c3c3cea", "provenance": "velit", "name": "cupidatat deserunt incididunt", "description": "Excepteur Lorem ut in deserunt", "memberOf": [ { "groupId": "92ae07cd94efa0866db13ea1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa in eu" }, { "roleId": "dolor ex ut laboris" }, { "roleId": "sint Lorem ea" }, { "roleId": "laboris quis Lorem enim dolor" }, { "roleId": "do elit anim fugiat" } ], "inactive": true, "_meta": { "created": "1983-07-12T10:15:01.687Z", "updated": "2022-10-21T04:17:05.997Z", "migrationVersion": 34228615 } }, "default", "0b5820ecaa434cf261cac748", "f4c7fd9b07a854bff74b6540", "default" ], "watchers": [ null, "9909de1c792512393fce2665", null ], "metrics": { "start_time": 56566639.830753684, "progress": 0.3729699797226025, "end_time": -51487096.303829774, "user": { "_id": "c53be8d802a91b91f0c67b09", "provenance": "dolore dolor elit Lorem", "username": "cupidatat ut sint tempor", "firstname": "officia do magna irure", "memberOf": [ { "groupId": "246a155629dae7c278e7ddeb", "aaaManaged": true }, { "groupId": "2a6ba9d9b5f61b1465579a38", "aaaManaged": true }, { "groupId": "5a4ed805c99ca4d235c99902", "aaaManaged": false }, { "groupId": "49f59544c5a1d087549e3063", "aaaManaged": true }, { "groupId": "6be896eec456952981611e6b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris" }, { "roleId": "incididunt laboris" }, { "roleId": "reprehenderit ad proident" } ], "inactive": true, "lastLogin": "1959-05-04T05:19:39.995Z", "_meta": { "created": "1972-06-13T00:11:25.052Z", "updated": "2000-02-06T12:25:07.176Z", "migrationVersion": 45351392 }, "email": "in mollit" }, "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }