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 Duis", "options": { "description": "Example job description", "type": "automation", "groups": [ "77afa0efea4be3631844f0b6", "3bdc65f4949d7eff7b8a7662", "a9f02f4fa74156b516560632", "f6991c8906e2d272569b1925" ] } }
{ "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": "11520e290c709d08f08da1d0", "font_size": 41198218, "type": "resource:compliance", "created": "2018-11-07T14:59:40.394Z", "last_updated": "1994-07-12T23:29:38.778Z", "createdVersion": "3.75458.21-0807.49.5062244", "lastUpdatedVersion": "601803666.77373124309.751843603-7485.83.2131451.298", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -39980665, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -14806385.653817415, "sla": 13866690.163192883, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/cO/cjj/gLz/JK,OBUhpno/~0/~0/~1/ha9/CBje5J28/~0" }, { "type": "encryption", "pointer": "/jPZ5Dt4P/v/BDd0rv/RxO/Qaulh+Pxd/~0/~1/GzV" }, { "type": "encryption", "pointer": "/e/sXmzoviUn/Xv/k6FhcdGEFm/IR2/~0/fCH.v/FJ/~1" } ], "status": "incomplete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "deserunt" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "enim sint" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "et" } ], "ancestors": null, "validationErrors": [ { "keyword": "id quis consectetur voluptate proident", "instancePath": "sint incididunt minim in", "schemaPath": "culpa deserunt", "message": "sunt aliquip ipsum" }, { "keyword": "proident", "instancePath": "id ipsum laboris", "schemaPath": "qui labore anim eiusmod", "message": "aliqua esse" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -60405403.966074415, "y": 51947931.19627404, "gridCoordinate": { "x": -36227283.803789675, "y": 88166132.97153601 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 93696700.36781076, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "7eb73fa84c72389ee3b700ad" ], "iterations": [ "634B1656-5368-Ad17-b6c7-F8A22b99e01b", "AeFa7dAa-DB97-1cfC-fFC8-98904ee5cBDa", "28a0CD5C-633A-4Cf5-505D-2c4CfAB1fF9B" ] }, "workflow_end": { "x": 81241245.03618342, "y": 10998837.841961697, "gridCoordinate": { "x": -62002304.628203444, "y": -1305115.2310786545 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_start", "error_handler", "workflow_end" ], "complete": [ "workflow_start", "workflow_start", "3a1f", "workflow_end", "workflow_start" ], "error": [ "workflow_start", "e28f" ] }, "metrics": { "end_time": -98577020.61015336, "run_time": -56744422.75661278 }, "groups": [ "default", { "_id": "7a4b2a2adf324d6fd2477587", "provenance": "in", "name": "nostrud est", "description": "sunt Excepteur cupidatat", "memberOf": [ { "groupId": "27c6fde305dab1f570e4921b", "aaaManaged": true }, { "groupId": "93df750e62e8525580b6f6f9", "aaaManaged": true }, { "groupId": "d4389051b9dee3787d98d9ab", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi in sed labore in" }, { "roleId": "dolor ex qui" }, { "roleId": "occaecat incididunt laborum in deserunt" }, { "roleId": "in cillum" } ], "inactive": true, "_meta": { "created": "1986-10-31T20:25:54.424Z", "updated": "2012-01-24T07:48:45.727Z", "migrationVersion": 1167987 } }, { "_id": "413613ea7ca3ed4c6df1b10a", "provenance": "dolor", "name": "dolor velit", "description": "deserunt velit cillum in voluptate", "memberOf": [ { "groupId": "e534e36dd4e33f50fe614963", "aaaManaged": false }, { "groupId": "85435d7079cda79ff1523229", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi cupidatat veniam dolore" }, { "roleId": "commodo" }, { "roleId": "voluptate fugiat" } ], "inactive": true, "_meta": { "created": "2015-06-09T23:37:28.715Z", "updated": "1974-11-06T15:39:11.952Z", "migrationVersion": -28354444 } }, { "_id": "bb3523568263f1735d0037a1", "provenance": "dolor sunt mollit eiusmod sit", "name": "Ut commodo", "description": "fugiat ex ut adipisicing", "memberOf": [ { "groupId": "aa695b7f5f0e20c274c0d440", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "mollit esse" } ], "inactive": true, "_meta": { "created": "1982-03-14T02:37:40.524Z", "updated": "2021-01-29T01:49:40.302Z", "migrationVersion": 56274527 } } ], "iterations": [ "09735D4a-9eE3-1C6c-5e3c-Eb1A5A65B4EE", "3d0A1Fbf-c333-7c74-Fcb5-2Ad4AEd0FFf5", "cE4ad4Be-cCAf-15A7-d2c1-AD07d1fa6ac6" ] }, "error_handler": { "x": -78246105.43063772, "y": -8265429.621940166, "gridCoordinate": { "x": 22202906.688882783, "y": -83963758.57997511 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "nostrud voluptate magna proident", "canvasName": "velit eiusmod labore proident voluptate", "displayName": "exercitation mollit", "summary": "magna", "description": "minim proident", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/vQIC-8P3ay5/~1" }, { "type": "encryption", "pointer": "/DS1c" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "esse", "highlightString": "nostrud ut in" }, { "key": "commodo Excepteur ipsum", "highlightString": "eiusmod adipisicing" }, { "key": "aliqua Duis", "highlightString": "eiusmod deserunt eu consequat sed" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "e28f" ], "complete": [ "workflow_start", "error_handler" ], "error": [ "3a1f", "3a1f", "workflow_start", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "elit dolore nostrud tempor", "start_time": "2018-06-11T09:22:00.293Z", "end_time": 49562431.77432081, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "3a6d9dcd1b6cef30e3021fd7", "default" ], "iterations": [ "bD48DB7b-DCB6-0fC0-d5A6-ce6ef8B8d452", "25fC23ab-fF4A-bcC2-6E51-7CEe2a31fd10" ] }, "0b6": { "actor": null, "groups": [ "4145219f9d474e6ca12ff8fa" ], "iterations": [ "B21f593c-3e02-7Cd2-EbBE-B86E96CaCdaA", "8dAee876-c6AE-AFdb-BACA-E6DfebCDa8B8" ], "x": 71332444.20638722, "y": -77769271.61370826, "gridCoordinate": { "x": 26798368.268508896, "y": 72673269.84779641 }, "name": "sint voluptate consectetur cupidatat minim", "location": "Broker", "locationType": null, "app": "irure in", "canvasName": "childJob", "displayName": "ullamco", "summary": "proident", "description": "sint Ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/LVRx/ZeMci1Q/~0/edh9-3Q/Hdq/RRy" }, { "type": "encryption", "pointer": "/X9OHvzowb/~1/~0/~0/gx/OYpizK.V9bA/BQvIolC/XJe/~1/~1/PFF" }, { "type": "encryption", "pointer": "/~0/cqDf8N/~0/~0/~1/~1/m,WOw/~1/~1/~0" }, { "type": "encryption", "pointer": "/U-vD3n/~0" }, { "type": "encryption", "pointer": "/j/~0/d/ArF+H/~0/mV394yKn/~0/KtPn.VnlYN/~0/Qy" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "in incididunt", "highlightString": "Excepteur velit" }, { "key": "voluptate cupidatat sint eu", "highlightString": "quis esse consequat sunt enim" }, { "key": "pariatur elit non dolore", "highlightString": "nulla non est" }, { "key": "cupidatat", "highlightString": "cillum dolore quis nostrud" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "workflow_start", "workflow_end" ], "complete": [ "workflow_start", "error_handler", "3a1f", "e28f", "workflow_end" ], "error": [ "workflow_start", "e28f", "workflow_start", "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "qui sed", "start_time": "1983-06-18T01:52:26.325Z", "end_time": -35973093.27797573, "finish_state": "failure", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": 3151947.5514469445, "outgoing": [ null, "est eiusmod dolore reprehenderit", "dolore eu", "amet labore" ] }, "childJobs": [ { "_id": "Excepteur pariatur aliqua aliquip est", "name": "Ut eu ea", "iteration": -31142634.233411834 }, { "_id": "tempor velit nulla consequat exercitation", "name": "enim cillum in reprehenderit anim", "iteration": 81167457.11273032 }, { "_id": "incididunt cupidatat", "name": "ut", "iteration": 26795696.377343863 }, { "_id": "irure", "name": "id enim eiusmod Ut esse", "iteration": 67592625.33910158 }, { "_id": "ipsum", "name": "proident nostrud et", "iteration": 41462196.3695406 } ] } }, "parent": { "job": "in ut", "task": "ipsum incididunt non aute nisi", "iteration": 50860289.88812229, "element": 33928833.107304215 }, "errorHandler": null, "groups": [ "71741b41374548a5c65adc33", "b58747002e8afc3f43887daf" ], "watchers": [ null, { "_id": "47a628f1262c27995faf880d", "provenance": "cillum enim sint", "username": "ut esse dolore et nostrud", "firstname": "id anim", "memberOf": [ { "groupId": "dc4307ce6625fb48c38f859b", "aaaManaged": false }, { "groupId": "e8793792bb1e667402b77ae7", "aaaManaged": true }, { "groupId": "1872e02573517fa85e291427", "aaaManaged": true }, { "groupId": "ba040f69e43b370e747e84df", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "voluptate eiusmod sed" }, { "roleId": "Lorem in laborum exercitation" }, { "roleId": "ex laboris culpa" } ], "inactive": true, "lastLogin": "1995-06-14T03:52:21.805Z", "_meta": { "created": "1985-09-26T12:57:03.154Z", "updated": "1990-07-27T17:31:20.47Z", "migrationVersion": -79192456 }, "email": "occaecat eiusmod minim reprehenderit aute" }, "Pronghorn" ], "metrics": { "start_time": -27641586.805656403, "progress": 0.23213455696777774, "end_time": -17612517.302951545, "user": "fbf0cc782dfb7ffed5e17d78", "owner": "cceffb23c1ca7f1c0a1c791f" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }