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": "id", "options": { "description": "Example job description", "type": "automation", "groups": [ "dc654bd0a6121cfdaa8e669a", "a8dc8e2f5e8b95dae827e2c8" ] } }
{ "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 retrieved search results", "data": { "_id": "b25eb3690161b3b5751fd457", "font_size": -10243908, "type": "automation", "created": "1982-04-02T06:52:34.655Z", "last_updated": "1971-06-09T21:44:48.818Z", "createdVersion": "4713030197.493.32688-1496.14.026844.08809", "lastUpdatedVersion": "2611046192.28873.494-0727.41527567.4645", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -57483590, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 4198707.779661775, "sla": 47527610.115302056, "decorators": [ { "type": "encryption", "pointer": "/y/OJ66bTC/~0/oYa5/sukshWz-zPW" }, { "type": "encryption", "pointer": "/~1/~0/Wg2/~1/~0/~1/KqdflV/~0" }, { "type": "encryption", "pointer": "/~1/v.ARm/~1" }, { "type": "encryption", "pointer": "/MFCBY/GHcqH7/CTOt45b-lP/~0/~1" } ], "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": "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": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "sit Duis minim" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "minim cupidatat labore", "instancePath": "aliquip pariatur laboris ipsum", "schemaPath": "qui amet sit Ut enim", "message": "anim adipisicing ut" }, { "keyword": "enim laborum consequat dolor", "instancePath": "occaecat adipisicing ex in", "schemaPath": "mollit tempor", "message": "tempor sed veniam laborum" }, { "keyword": "nisi", "instancePath": "dolore dolor", "schemaPath": "sint ut consectetur", "message": "est" }, { "keyword": "velit tempor cupidatat Duis do", "instancePath": "dolor veniam occaecat", "schemaPath": "dolore enim Excepteur", "message": "cupidatat" }, { "keyword": "reprehenderit", "instancePath": "do ut minim veniam", "schemaPath": "reprehenderit est", "message": "aliqua magna" } ], "created_by": null, "last_updated_by": null, "tasks": { "workflow_start": { "x": 64960312.174527556, "y": 95384671.31014726, "gridCoordinate": { "x": -19788098.548631087, "y": -75163785.8794067 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 85353494.64810461, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "default", "cf508153fc443ecabdf1ebb3", { "_id": "8f781a5404f607a0930a688b", "provenance": "nostrud dolor est", "name": "ex ipsum dolore veniam", "description": "labore", "memberOf": [ { "groupId": "17f112b054b6bdf82bef815e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis aute ut" }, { "roleId": "aliqua occaecat" }, { "roleId": "labore" } ], "inactive": false, "_meta": { "created": "1970-07-18T09:11:34.524Z", "updated": "1996-06-10T02:24:27.888Z", "migrationVersion": -11453479 } } ], "iterations": [ "AB74bD15-3b6B-3e66-1dA0-567FbDc2b9BA", "cc2ad3Cc-bA35-D0AC-9C83-d3E31Daa8cEB", "C5F32dd4-046b-D08C-e55e-d9D802EfE0dD" ] }, "workflow_end": { "x": -42592161.21815084, "y": -89374692.13241793, "gridCoordinate": { "x": -62814240.52636409, "y": 87459151.7945244 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f" ], "complete": [ "workflow_end" ], "error": [ "workflow_start" ] }, "metrics": { "end_time": 46342586.37242815, "run_time": -85431610.79137343 }, "groups": [ "default" ], "iterations": [ "679f6C60-8f98-3C07-22d4-af2b0ABB5e5F" ] }, "error_handler": { "x": 45215871.10456866, "y": -53422177.78992513, "gridCoordinate": { "x": 92666237.86355364, "y": 27399696.108431116 }, "name": "childJob", "location": "Broker", "locationType": "Lorem nisi eiusmod cupidatat sit", "app": "aute in ipsum pariatur cillum", "canvasName": "ipsum eiusmod sed commodo laboris", "displayName": "sed Lorem", "summary": "anim dolor in minim occaecat", "description": "quis aliquip", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/CeZZPz/~0/~0" }, { "type": "encryption", "pointer": "/uR/Aa9rcA" }, { "type": "encryption", "pointer": "/HRN/~1/Y6sv2fmh/ZP/~1/tGE.uSO4b,/~1/~0/Hz-" }, { "type": "encryption", "pointer": "/ya4/t-ap/~1/~0/Zw,oGMSzE/YYOrjb/~1/~0" }, { "type": "encryption", "pointer": "/~0/~1/~1/Z4" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "sit", "highlightString": "esse occaecat incididunt sed" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "workflow_end", "error_handler", "workflow_start", "workflow_end" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_start" ], "error": [ "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "revert" } ] }, "serverId": "elit aliqua nisi", "start_time": "2006-09-03T20:35:10.153Z", "end_time": -48251866.0870058, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": null, "groups": [ "default" ], "iterations": [] }, "b3f0": { "actor": "job", "groups": [ { "_id": "391e9d482ede3e0af70dff86", "provenance": "laboris", "name": "cupidatat ipsum", "description": "do quis in", "memberOf": [ { "groupId": "c2925e13f6f484704cd0a599", "aaaManaged": false }, { "groupId": "6296351ec566ae46ed895143", "aaaManaged": true }, { "groupId": "34dacf709d0a70eed0e791cb", "aaaManaged": true }, { "groupId": "28555c0b77e0856cc0aa8d9e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "et proident" } ], "inactive": false, "_meta": { "created": "1946-01-18T14:40:51.453Z", "updated": "1978-05-19T05:31:18.09Z", "migrationVersion": 31991430 } }, "default", "fdc05f13bcb9a596e547b8a8" ], "iterations": [ "DAcF1FC2-FCa1-FFAA-7ebB-7Bd81FC6e902" ], "x": -10500899.00836815, "y": 44267168.99944082, "gridCoordinate": { "x": 8001071.087057322, "y": 72940282.4254719 }, "name": "sit ut aute aliquip velit", "location": "Application", "locationType": "occaecat dolor ipsum", "app": "cillum", "canvasName": "childJob", "displayName": "id consectetur", "summary": "deserunt non aliquip", "description": "dolore amet ut nulla aliqua", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ShSi,JyxN/HUZ/a/CahnHMg/~1/~1" }, { "type": "encryption", "pointer": "/~0/b2yt3jy7H/~0/~1/~1/~1/u82,D/~1/FyOlYew/PMPEcwgV./~1" }, { "type": "encryption", "pointer": "/~0/oO4,C/~1/~1/axObG/~0/~1/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "nulla", "highlightString": "fugiat deserunt dolore ut ex" }, { "key": "nisi adipisicing reprehenderit enim", "highlightString": "aliquip aute ex sint" }, { "key": "veniam minim pariatur consectetur", "highlightString": "labore do ipsum" }, { "key": "fugiat ut eu labore", "highlightString": "fugiat Ut culpa" } ], "status": "scheduled", "previous": { "incomplete": [ "3a1f", "error_handler" ], "complete": [ "e28f", "workflow_end", "workflow_start", "workflow_end", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "3a1f", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "incididunt fugiat", "start_time": "1996-07-26T12:47:27.841Z", "end_time": -58799886.075877294, "finish_state": "error", "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 20445267, "delay": 82163078, "count": 65100193, "finishedRetrying": true }, "loop": { "atLeastOneComplete": false, "finishedCount": -98288873.1153647, "outgoing": [ "Duis mollit", null, null, "Duis dolore ipsum", null ] }, "childJobs": [ { "_id": "aute velit cillum", "name": "esse", "iteration": -77955034.75572997 }, { "_id": "cillum nostrud ea irure", "name": "id incididunt", "iteration": -25978298.91240573 } ] } }, "parent": { "job": "velit voluptate in ex sit", "task": "ullamco in", "iteration": 42775710.771117866, "element": 65161007.25669381 }, "errorHandler": null, "groups": [ { "_id": "8fa01e2c215a00c2789b0c37", "provenance": "anim", "name": "amet culpa in officia consectetur", "description": "velit laborum non", "memberOf": [ { "groupId": "528a076293469b7677d24d50", "aaaManaged": false }, { "groupId": "00b3fce772ac11859a30fc28", "aaaManaged": true }, { "groupId": "f04e6fa1eec914f53cd830b0", "aaaManaged": false }, { "groupId": "aeb7bff336fc914d12ac4577", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do ullamco Excepteur" }, { "roleId": "occaecat" }, { "roleId": "voluptate sed anim in ea" }, { "roleId": "irure amet" } ], "inactive": true, "_meta": { "created": "1973-08-29T13:51:21.142Z", "updated": "2014-03-31T09:15:47.479Z", "migrationVersion": -5382299 } } ], "watchers": [ { "_id": "7cfb432a8b6be2de1e3d8195", "provenance": "aliquip sed pariatur", "username": "eu in ea", "firstname": "aliquip", "memberOf": [ { "groupId": "b2d70f94371acccaf10b2c40", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu ut consequat" }, { "roleId": "sint occaecat consequat ex" }, { "roleId": "consectetur nisi deserunt reprehenderit" }, { "roleId": "ut" }, { "roleId": "aliqua commodo" } ], "inactive": false, "lastLogin": "2014-09-02T12:39:32.04Z", "_meta": { "created": "1976-01-07T12:44:34.317Z", "updated": "1969-06-19T23:25:02.399Z", "migrationVersion": 2301798 }, "email": "aliquip" }, "Pronghorn", null, "Pronghorn", null ], "metrics": { "start_time": -57995748.07603642, "progress": 0.048329736125604095, "end_time": 80630470.87938401, "user": { "_id": "245868ece16206abaf893c30", "provenance": "ut sit aute sint", "username": "occaecat elit pariatur in", "firstname": "dolor", "memberOf": [ { "groupId": "f7ec07e5d675ba64753e9381", "aaaManaged": true }, { "groupId": "18c99c7549b5348c98b6c02e", "aaaManaged": true }, { "groupId": "ac20a97c61c9d262aa0660ca", "aaaManaged": true }, { "groupId": "2464fc02f9908fb5bbfb0683", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam qui ex" }, { "roleId": "nulla" } ], "inactive": true, "lastLogin": "1976-03-24T02:06:37.102Z", "_meta": { "created": "2022-10-16T02:39:01.824Z", "updated": "1970-04-19T04:06:37.913Z", "migrationVersion": -19970947 }, "email": "ullamco eu irure cillum mollit" }, "owner": { "_id": "33d393a7f081d6438d93eb74", "provenance": "nisi dolore amet", "username": "ut est aliqua magna", "firstname": "laborum mollit officia sed", "memberOf": [ { "groupId": "b42551dbc6b59f92eee88871", "aaaManaged": false }, { "groupId": "cb1c49a0e7f8ba21e5c92e78", "aaaManaged": true }, { "groupId": "f8e16e59ba179642eca81fc8", "aaaManaged": false }, { "groupId": "78fe5071176ecfe50a97d589", "aaaManaged": false }, { "groupId": "e6b7c7d5f0e19490ccc2a57a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur" }, { "roleId": "eu ad exercitation dolor" }, { "roleId": "pariatur dolore" }, { "roleId": "incididunt Lorem elit pariatur" } ], "inactive": true, "lastLogin": "1958-09-04T05:48:40.231Z", "_meta": { "created": "1976-05-28T19:05:57.811Z", "updated": "2010-08-13T06:33:57.0Z", "migrationVersion": 57660346 }, "email": "incididunt est" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }