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 non Duis", "options": { "description": "Example job description", "type": "automation", "groups": [ "92a8f1d984da93b46eb1f0ec", "5f8729e07fc44aed670ff593", "aef1ef1565e8f4be8d0a2af7", "e8ba0ad8063df7ea64f6aaf5", "237f17478420ba3221a58160" ] } }
{ "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": "e367395027ca38f90e4ffb15", "uuid": "4d3fe522-e31f-faaa-264e-853273065186", "font_size": 93948224, "type": "resource:action", "created": "1998-04-24T08:08:09.588Z", "last_updated": "2000-01-02T21:52:44.377Z", "createdVersion": "09227592.48.9452988054-3775.2279228.57091", "lastUpdatedVersion": "8655.628429757.441769173-7013.1382371623.7924624", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 27457940, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 42512694.5498946, "sla": -95622542.62612608, "decorators": [ { "type": "encryption", "pointer": "/FC2/~0" }, { "type": "encryption", "pointer": "/~1/~0/eV1/~1/~0/~1/~0/~0/~0" }, { "type": "encryption", "pointer": "/nltd+l/KUQFY3/~0/~0/~0/GEM/~1/U022EsR,,0B" }, { "type": "encryption", "pointer": "/~0/HkW6lcL/JD/XU8B11ds2/ixj/~1/~0/EMuy/nmnSZJFwTh6/~1/h2cPrSZ,N7W/aBDmSAq" }, { "type": "encryption", "pointer": "/M+NbnZq" } ], "status": "paused", "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 }, { "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 }, { "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "amet Excepteur consectetur" } ], "ancestors": [ "0f5632ba444b5ee928f2fa62", "d33aff199ec7e624cb94c437", "33b997f22912ce6f3bc349d7", "58812f68123994b0fac4f1b6", "0147e9fcf999d5373b2f416d" ], "validationErrors": [ { "keyword": "elit", "instancePath": "dolor sit veniam ad", "schemaPath": "non nulla in cupidatat aliquip", "message": "non adipisicing culpa ut tempor" }, { "keyword": "ut", "instancePath": "Excepteur tempor non", "schemaPath": "culpa deserunt Excepteur dolor", "message": "officia enim" } ], "created_by": "fc3ea2855f59baae80d19164", "last_updated_by": null, "tasks": { "workflow_start": { "x": -99902899.04751885, "y": -70379088.37934755, "gridCoordinate": { "x": -38024396.95217314, "y": -15565997.549016237 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -92908485.15662788, "finish_state": "error", "user": null }, "groups": [ "801384023b9a20e710811bf4", "default", "098773d5100ffdf0edc6e4a9", "a853e71400d6375e4c2dfb95" ], "iterations": [ "bdAbe8Ad-FE8d-DA50-fb8a-D4fCAAE33e6B", "b9b14E5b-B4Cd-bDa2-644D-c761bbaeEC65" ] }, "workflow_end": { "x": -56611694.119937, "y": 65700551.56147352, "gridCoordinate": { "x": 29169464.04816705, "y": -23465172.839930266 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "e28f" ], "complete": [ "workflow_start", "workflow_start" ], "error": [ "e28f", "workflow_start", "workflow_end", "e28f", "workflow_start" ] }, "metrics": { "end_time": 78280749.34397823, "run_time": -84633582.87561235 }, "groups": [ { "_id": "3eab0f4f588e5b3cda03f6ea", "provenance": "exercitation", "name": "veniam sunt", "description": "Excepteur nisi minim ut", "memberOf": [ { "groupId": "300860f8d678312e3aa61c21", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do commodo aliquip" } ], "inactive": false, "_meta": { "created": "2017-02-28T13:12:35.615Z", "updated": "2005-05-21T18:48:48.997Z", "migrationVersion": -56931462 } }, "default", "default", "69e647da75da4e3683c0eb12", "default" ], "iterations": [] }, "error_handler": { "x": -59501684.21533961, "y": -87574666.07366, "gridCoordinate": { "x": 29405331.287131056, "y": -42035062.26539089 }, "name": "childJob", "location": "Application", "locationType": null, "app": "dolore quis", "canvasName": "cillum nulla commodo voluptate enim", "displayName": "ipsum enim", "summary": "officia irure ipsum aliquip", "description": "id ullamco esse exercitation", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/K,8KJ0j/OZ/EALjkRpht9" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ex", "highlightString": "incididunt" }, { "key": "et adipisicing nostrud", "highlightString": "amet quis ut laboris" }, { "key": "Excepteur in Lorem labore in", "highlightString": "veniam" }, { "key": "minim sed", "highlightString": "eiusmod Duis" } ], "status": "scheduled", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_end", "error_handler", "e28f", "3a1f" ], "error": [ "workflow_start", "error_handler", "workflow_start", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ] }, "serverId": "Excepteur ad anim in", "start_time": "2014-03-08T20:36:56.848Z", "end_time": 94325748.791531, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ { "_id": "de04dcd397d9602977babba4", "provenance": "et dolore sunt tempor", "name": "consequat ut", "description": "consectetur do aliqua ullamco mollit", "memberOf": [ { "groupId": "02ef171cdb7e99ee02c9572d", "aaaManaged": false }, { "groupId": "65186d05acff8c7f01e59144", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" } ], "inactive": false, "_meta": { "created": "2021-01-01T05:32:16.506Z", "updated": "1980-11-29T20:55:15.336Z", "migrationVersion": 4148341 } }, "default", { "_id": "62a134524580da4edac45e89", "provenance": "enim", "name": "ad", "description": "minim id veniam", "memberOf": [ { "groupId": "7cbc03c6b5fd913c977e91fa", "aaaManaged": true }, { "groupId": "f7f97a9d4a9d5bb4122269d2", "aaaManaged": false }, { "groupId": "b5d06fe54df8fa536167a1e5", "aaaManaged": false }, { "groupId": "92b1b381b1dc2785a0b77179", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in veniam non" }, { "roleId": "aliqua" } ], "inactive": false, "_meta": { "created": "1973-10-30T23:42:18.382Z", "updated": "1954-10-12T02:22:13.991Z", "migrationVersion": 53901304 } } ], "iterations": [ "b5Ae41F0-f25E-FbA5-4d23-62Ebb9C2Ec56", "AFD59b44-3638-ad48-804b-67899AcFEF09" ] }, "1a1": { "x": 90105342.44397315, "y": 35202140.42784673, "gridCoordinate": { "x": 14845443.935940057, "y": -64812807.1345702 }, "name": "cillum veniam tempor fugiat", "location": "Application", "locationType": "fugiat anim Duis dolore", "app": "eiusmod Ut", "canvasName": "voluptate Excepteur esse sed in", "displayName": "cupidatat consequat nulla ea proident", "summary": "culpa", "description": "labore laboris ea reprehenderit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/w/~0/ym6OU2N/cnsw3/~1" }, { "type": "encryption", "pointer": "/IGkgvYbDR/~0/~1" }, { "type": "encryption", "pointer": "/ZcDQK6pAkGl/sKN/k/~0/o" }, { "type": "encryption", "pointer": "/~0/~1/l/hsd/~1/~0/~1/RaSy06B3pe/~0/~0/~0" }, { "type": "encryption", "pointer": "/~0/~0/~0/z/+UsOX/~0/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ullamco", "highlightString": "commodo sed" } ], "status": "error", "previous": { "incomplete": [ "e28f", "error_handler", "e28f", "workflow_start" ], "complete": [ "3a1f" ], "error": [ "workflow_start", "workflow_start", "workflow_end", "error_handler", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ] }, "serverId": "voluptate ad exercitation aliquip nisi", "start_time": "1991-07-06T03:56:59.361Z", "end_time": -16629177.97735463, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "b2db54bea1571a28fd2c9f7f" ], "iterations": [ "dDAaeD66-FDF5-FAab-ffAa-faBc0b0F3Aa9" ] } }, "parent": { "job": "in ex", "task": "dolor", "iteration": 69837948.44266069, "element": -68340482.29178165 }, "errorHandler": { "x": -65458987.58823041, "y": -43740666.397590466, "gridCoordinate": { "x": -81793128.74091625, "y": -38244957.8178385 }, "name": "qui fugiat", "location": "Application", "locationType": "consectetur ipsum Duis reprehenderit elit", "app": "ut ex aliqua", "canvasName": "ipsum consectetur sit", "displayName": "velit officia", "summary": "elit aliquip id proident esse", "description": "cupidatat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/nLkC+/~1/nOYWK/~1/wt" }, { "type": "encryption", "pointer": "/BIzIl/whkq-0/dYTr0b/~0/~1/Sn,ZGMNW./heIVA0tC/t," }, { "type": "encryption", "pointer": "/g/txC/Y7GaC/~0/W6R/~0" }, { "type": "encryption", "pointer": "/Ej" }, { "type": "encryption", "pointer": "/FP-4MoiQzC/dic9/OvxP" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "culpa velit dolore", "highlightString": "occaecat" }, { "key": "in esse ut elit eiusmod", "highlightString": "exercitation" }, { "key": "id", "highlightString": "exercitation dolore amet Lorem velit" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start", "e28f", "e28f" ], "complete": [ "workflow_end", "error_handler", "workflow_end" ], "error": [ "workflow_start", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ex Lorem dolore in sit", "start_time": "2019-08-26T22:56:36.529Z", "end_time": -91140203.8199757, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "551e146a5e1a5ef5dac160c4", "provenance": "sunt nisi", "name": "ut eu Duis", "description": "magna", "memberOf": [ { "groupId": "25d533bfb676ff5d82ffe9ac", "aaaManaged": false }, { "groupId": "fc2ea3913a7417f8efc9311e", "aaaManaged": true }, { "groupId": "8d345342452e4a8641e5fe29", "aaaManaged": true }, { "groupId": "837269140f61f9a97acdaaf5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor nostrud ut labore" } ], "inactive": true, "_meta": { "created": "1976-02-09T12:41:48.215Z", "updated": "2020-04-16T14:42:42.701Z", "migrationVersion": -56736476 } } ], "iterations": [ "86EBac2E-403b-dbFA-e2FE-0B3D81a85DcC" ] }, "groups": [ { "_id": "1203e88723b7e8c736470f4f", "provenance": "occaecat tempor sit Ut in", "name": "Lorem do enim", "description": "elit enim", "memberOf": [ { "groupId": "78648f8e52b2f798438b8965", "aaaManaged": false }, { "groupId": "ba8750b6ecf40e7261c0d172", "aaaManaged": true }, { "groupId": "e4f835ed25c1e0d342e7fafd", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu est non Lorem Duis" }, { "roleId": "laborum incididunt tempor commodo magna" }, { "roleId": "reprehenderit ut" }, { "roleId": "consequat" }, { "roleId": "occaecat laboris culpa irure laborum" } ], "inactive": true, "_meta": { "created": "2003-09-05T04:53:18.575Z", "updated": "2019-03-25T11:22:32.457Z", "migrationVersion": 70765818 } }, "79676f8f3c41cf3c9199542f", "default", { "_id": "c9c78a828391d5ba010887c8", "provenance": "sunt dolor elit culpa", "name": "qui irure Duis veniam proident", "description": "esse non elit cupidatat", "memberOf": [ { "groupId": "a54276a17ba5311c4431976d", "aaaManaged": true }, { "groupId": "4f5d69e7d4b69588c4a41e68", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla voluptate eiusmod enim" }, { "roleId": "ipsum" }, { "roleId": "sed" } ], "inactive": false, "_meta": { "created": "1987-11-26T19:53:51.134Z", "updated": "1972-06-24T19:18:26.808Z", "migrationVersion": 18215782 } } ], "watchers": [ "Pronghorn", "bba4dd5ac4d533da9ab76d18", { "_id": "306762383a1b9c56899658bb", "provenance": "magna laboris ullamco", "username": "Lorem culpa aliquip in", "firstname": "ut tempor adipisicing", "memberOf": [ { "groupId": "8421a71f6046d0aff1d498ce", "aaaManaged": false }, { "groupId": "bb354ee5c2fee4a3be93a249", "aaaManaged": false }, { "groupId": "26c6beb5e554a09342e8a664", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt" } ], "inactive": true, "lastLogin": "1980-08-16T06:01:40.601Z", "_meta": { "created": "1948-04-03T01:47:55.071Z", "updated": "2025-11-09T18:17:07.193Z", "migrationVersion": 73232702 }, "email": "dolore non" } ], "metrics": { "start_time": -35948361.97518974, "progress": 0.8734826158576745, "end_time": -40354662.92692034, "user": { "_id": "e3ae9da86592c499920e6184", "provenance": "esse exercitation amet dolore", "username": "Lorem sit in sint eiusmod", "firstname": "minim aliquip fugiat consequat adipisicing", "memberOf": [ { "groupId": "e6eaa8df141cc9ab262b4bf6", "aaaManaged": true }, { "groupId": "3e00b9f1c928309372621579", "aaaManaged": true }, { "groupId": "ce797a927c64e687239e3036", "aaaManaged": true }, { "groupId": "7d1797bc26f6ba7caa40f7ac", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint sit dolore" }, { "roleId": "pariatur dolor" } ], "inactive": true, "lastLogin": "1948-02-23T09:14:43.144Z", "_meta": { "created": "1957-04-20T14:22:08.35Z", "updated": "1995-10-18T01:54:50.226Z", "migrationVersion": -10083441 }, "email": "aute adipisicing consectetur esse" }, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }