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": "irure sed non elit consectetur", "options": { "description": "Example job description", "type": "automation", "groups": [ "57d3320965cdb2b71bd7f426", "e76d575ea05d1ec20aa94c5f", "1c26743944883d79d790a435", "1c906abbfa6baca501be5ab6" ] } }
{ "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": "7bed0781c3b3bc6bf9d96184", "font_size": -93436523, "type": "resource:compliance", "created": "1966-11-20T23:25:29.082Z", "last_updated": "2008-06-13T06:30:07.135Z", "createdVersion": "60700595.8452946720.303", "lastUpdatedVersion": "517261257.85779415.107975-4971.1.2964", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 36575304, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -77472979.06853202, "sla": 97373419.57684195, "decorators": [ { "type": "encryption", "pointer": "/~0/u.mkTrjp/~1/~0/~0/~1/Fi2oMPXVFE/~1/~0" }, { "type": "encryption", "pointer": "/~1/MgA/~1/eDPi1qz6T+/~0/AqH1pT.Pb/LJZ./gI9liFKcl2e/~0/~0" } ], "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 }, { "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", "message": "labore dolore in" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "Lorem non ipsum esse sint" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "consequat", "instancePath": "tempor incididunt", "schemaPath": "dolore ut velit ea", "message": "Duis" }, { "keyword": "aute consequat ut non do", "instancePath": "sunt aute eu", "schemaPath": "aliqua Lorem et ea commodo", "message": "dolor irure" } ], "created_by": "Pronghorn", "last_updated_by": "a68aa1d7eac5f5efd9afa0d5", "tasks": { "51": { "x": -34681636.238679655, "y": 32113943.35897903, "gridCoordinate": { "x": 16167233.716191292, "y": 48960584.49564543 }, "name": "dolore", "location": "Broker", "locationType": "incididunt ullamco sunt", "app": "nulla aliqua ex voluptate in", "canvasName": "aute et voluptate", "displayName": "elit voluptate in", "summary": "laborum in ut eiusmod magna", "description": "enim ad nulla", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/V/UavpTuU/~0/~1/D2VE.GLeZi7/f" }, { "type": "encryption", "pointer": "/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ipsum eu Ut", "highlightString": "nostrud pariatur enim sunt" }, { "key": "labore dolor", "highlightString": "magna dolor dolore in" }, { "key": "quis nulla", "highlightString": "eiusmod aliquip nulla dolor velit" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "error_handler" ], "complete": [ "3a1f" ], "error": [ "workflow_start", "workflow_end", "workflow_start", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "ea dolore ex sit", "start_time": "1948-08-02T02:57:24.838Z", "end_time": 48295787.73710051, "finish_state": "error", "retrySettings": { "state": [ "success", "failure", "success" ], "autoRetry": false, "limit": 47964594, "delay": 43045621, "count": 62614612, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "default" ], "iterations": [ "Ee35adDB-1baf-d8AD-b9ff-91aCa956aFa2", "eEFa79a5-0cB9-2033-cDC9-4A6edFebcab5" ] }, "workflow_start": { "x": 80008802.4174484, "y": 51037265.882885516, "gridCoordinate": { "x": -27595950.159288302, "y": 24303926.259366855 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 1314871.6546680331, "finish_state": "success", "user": { "_id": "9b494fa181c0a76447d35d17", "provenance": "magna qui in", "username": "ad", "firstname": "minim Lorem", "memberOf": [ { "groupId": "2809cedc2d75e551ebd22b3d", "aaaManaged": true }, { "groupId": "a3ff1b30f2062ec24efff067", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem dolore" } ], "inactive": true, "lastLogin": "1957-04-13T02:33:33.24Z", "_meta": { "created": "1993-05-27T12:43:29.522Z", "updated": "2012-04-10T09:09:55.555Z", "migrationVersion": -81135338 }, "email": "adipisicing" } }, "groups": [ { "_id": "4d6a45b37e66c569a4d72b3b", "provenance": "dolore ullamco ex laborum mollit", "name": "fugiat veniam tempor dolore", "description": "aliqua", "memberOf": [ { "groupId": "ccfaa10d4a073d53f3b822fe", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "et est proident" }, { "roleId": "consectetur dolore commodo cillum" } ], "inactive": true, "_meta": { "created": "2020-07-26T06:50:34.549Z", "updated": "2018-06-09T16:42:58.211Z", "migrationVersion": -1120890 } }, "default", "default", "3a3f1473b66530ed2cc356e5" ], "iterations": [] }, "workflow_end": { "x": 34202655.65513171, "y": 34209592.09206252, "gridCoordinate": { "x": -2018995.2889738083, "y": -84128442.08960171 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "e28f", "workflow_end", "workflow_start", "error_handler" ], "complete": [ "workflow_end", "workflow_end", "e28f", "workflow_end" ], "error": [ "e28f", "3a1f", "workflow_start", "error_handler", "e28f" ] }, "metrics": { "end_time": 71606148.97638702, "run_time": -81340058.96895684 }, "groups": [ { "_id": "84e79d5f7667a41d4d29c925", "provenance": "velit voluptate non", "name": "nisi labore elit dolore ipsum", "description": "id irure consectetur fugiat", "memberOf": [ { "groupId": "f246b04827ead8d9dcb67d04", "aaaManaged": false }, { "groupId": "8b2d4fc27a238a40f2e37bec", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum non consectetur" }, { "roleId": "officia aliquip dolore nostrud et" } ], "inactive": false, "_meta": { "created": "1961-02-19T23:51:18.349Z", "updated": "2007-08-07T19:19:30.098Z", "migrationVersion": -71475464 } }, "91d50a1c91df4fe2f26187b8", "default" ], "iterations": [ "19E7d051-BadB-8799-d4d8-dA2db8FeA37C" ] }, "error_handler": { "x": 73714872.71333179, "y": -41402330.59188474, "gridCoordinate": { "x": 20119523.869157344, "y": 41583313.90736252 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "eu deserunt", "canvasName": "occaecat nostrud", "displayName": "in Excepteur consectetur", "summary": "aute ut dolore anim quis", "description": "in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~0/U7dCu/bO/~0/F5D7Wbmk" }, { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "ex commodo proident pariatur", "highlightString": "sed Lorem" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_start", "workflow_start" ], "complete": [ "e28f", "3a1f", "workflow_start", "error_handler" ], "error": [ "workflow_start", "e28f", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "revert" } ] }, "serverId": "eu", "start_time": "1999-10-12T15:12:06.609Z", "end_time": -43948296.357033275, "finish_state": "success", "retrySettings": { "state": [ "success", "failure", "error", "error" ], "autoRetry": false, "limit": 83347086, "delay": 39904920, "count": 19751073, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "d89931275f14da1a5dfe50f8", "provenance": "ad", "name": "aliquip amet sunt", "description": "commodo Duis mollit", "memberOf": [ { "groupId": "05580822b2b7bebf4e23e0f1", "aaaManaged": true }, { "groupId": "b48192f5d595d0b75fb035b5", "aaaManaged": false }, { "groupId": "fb46fbcf3de194a757af761a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse et sit in nulla" } ], "inactive": true, "_meta": { "created": "2008-07-29T10:20:37.867Z", "updated": "1972-01-06T00:16:35.139Z", "migrationVersion": -87678638 } }, { "_id": "fa276ec4ae4ea9ea75fe7096", "provenance": "sunt eiusmod", "name": "reprehenderit proident", "description": "cillum ex dolore", "memberOf": [ { "groupId": "9183c5fa9f76399fab1e1487", "aaaManaged": false }, { "groupId": "caf5197f8c592992342c15b6", "aaaManaged": false }, { "groupId": "48be8dcae75b9249b75c25bd", "aaaManaged": false }, { "groupId": "4b4d962a0113e8915fa03480", "aaaManaged": false }, { "groupId": "2761335047d09eb0ea82c244", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu" } ], "inactive": false, "_meta": { "created": "2020-07-05T06:25:28.145Z", "updated": "1972-12-04T10:14:10.954Z", "migrationVersion": -66840705 } } ], "iterations": [] } }, "parent": { "job": "quis Ut et", "task": "consequat eu dolor", "iteration": -44456359.38508983, "element": -25032930.870719343 }, "errorHandler": null, "groups": [ { "_id": "fdbc20dbfe9577ec864da20d", "provenance": "non", "name": "id dolore sint in", "description": "eiusmod", "memberOf": [ { "groupId": "8b5435c8291595b800ded03c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore" } ], "inactive": false, "_meta": { "created": "2017-01-18T05:13:20.301Z", "updated": "1995-04-16T07:18:08.103Z", "migrationVersion": -14928881 } }, "default" ], "watchers": [ "83a66a4b2000a50705bcd0f9", "Pronghorn", { "_id": "2f6258b49fd1a376589730b9", "provenance": "aliqua", "username": "ullamco in ad", "firstname": "anim dolor labore aute mollit", "memberOf": [ { "groupId": "6b6e3a7efee41106d975b8ef", "aaaManaged": true }, { "groupId": "7b08f878cd76618909696b13", "aaaManaged": false }, { "groupId": "884a75444919831061db63e0", "aaaManaged": false }, { "groupId": "48727f8f941adc025f5c9f92", "aaaManaged": true }, { "groupId": "cf11d1e92b69b71cd1071dfb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do Excepteur" } ], "inactive": true, "lastLogin": "2018-11-04T07:22:55.204Z", "_meta": { "created": "1985-06-11T23:57:50.878Z", "updated": "2018-05-10T01:41:50.384Z", "migrationVersion": 3468632 }, "email": "minim exercitation sit incididunt laborum" } ], "metrics": { "start_time": 15120392.03570339, "progress": 0.36432469956969027, "end_time": -7671861.738041356, "user": { "_id": "fc59ee2773b85c8c1ee4158c", "provenance": "laborum in et aliqua", "username": "nulla incididunt nisi culpa", "firstname": "eu", "memberOf": [ { "groupId": "0543757abe0496d39d3cb808", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis voluptate qui velit laborum" }, { "roleId": "pariatur officia" }, { "roleId": "velit esse id laboris" } ], "inactive": false, "lastLogin": "2007-11-09T06:28:21.365Z", "_meta": { "created": "1973-01-22T01:16:37.488Z", "updated": "1967-05-13T05:26:16.346Z", "migrationVersion": 83295646 }, "email": "Ut id nulla irure" }, "owner": { "_id": "37dee63d3ce732bda13f9a05", "provenance": "nostrud", "username": "nostrud nisi non irure", "firstname": "exercitation", "memberOf": [ { "groupId": "8b85bfe44c7b19e67e27c92f", "aaaManaged": true }, { "groupId": "682618aa4bb4013c8d9d264e", "aaaManaged": true }, { "groupId": "5a3527726181f9b2e93594d9", "aaaManaged": true }, { "groupId": "f1f2cf8e223284cfb0fe50d8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui in" }, { "roleId": "qui labore eiusmod" }, { "roleId": "velit qui minim in magna" } ], "inactive": true, "lastLogin": "2008-08-16T19:44:29.443Z", "_meta": { "created": "2006-12-25T22:32:15.996Z", "updated": "2012-06-04T07:08:46.444Z", "migrationVersion": 47972150 }, "email": "cillum" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }