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": "aliqua est", "options": { "description": "Example job description", "type": "automation", "groups": [ "526499ca5a270977a0246d18", "72f2835c79286e8e167b96c3", "71835f7ac1e253294b484be4" ] } }
{ "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": "3667abf44341a1df96f16310", "uuid": "5c09cbcb-c617-7d35-71f5-c46dfdb0aa3a", "font_size": 26542145, "type": "resource:action", "created": "1950-09-08T01:06:51.235Z", "last_updated": "1946-08-05T07:58:29.303Z", "createdVersion": "12242688.57457649665.05-6170.9326707.27309168", "lastUpdatedVersion": "270.13.0031564", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 90312801, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -20442745.54419428, "sla": -69909589.22871697, "decorators": [ { "type": "encryption", "pointer": "/~0/xaNI3TwQ0m/yoP/~0/Umx/bLlQA" }, { "type": "encryption", "pointer": "/Wab0xaz/mgIYa/UUH/~0/~1/gp,O.jEyCL/Zvb/~1/z/" }, { "type": "encryption", "pointer": "/~1/rO" }, { "type": "encryption", "pointer": "/mNC,/~0/~1" } ], "status": "error", "tags": [], "error": [ { "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": "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" } ], "ancestors": null, "validationErrors": [ { "keyword": "magna", "instancePath": "occaecat aliquip eu anim", "schemaPath": "ex ea mollit nulla incididunt", "message": "dolore enim deserunt reprehenderit incididunt" }, { "keyword": "sunt mollit irure", "instancePath": "do cillum", "schemaPath": "sed ipsum", "message": "incididunt" } ], "created_by": "3b6070bb8a2f58599b0ebdca", "last_updated_by": { "_id": "a9c0b8f949292bb50ca37d9c", "provenance": "in", "username": "dolore Lorem commodo magna pariatur", "firstname": "amet aliquip", "memberOf": [ { "groupId": "fa88f1753eac18c72af5d978", "aaaManaged": false }, { "groupId": "a9cbd3083094d03ee66a5927", "aaaManaged": true }, { "groupId": "6688d29bbe0e3695cccdebf1", "aaaManaged": true }, { "groupId": "c4867a9da9530d7fdd3c90bb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in cupidatat sed" }, { "roleId": "ea cillum elit ut" } ], "inactive": false, "lastLogin": "2001-03-06T01:57:39.22Z", "_meta": { "created": "1962-02-12T02:48:38.559Z", "updated": "1958-05-22T07:05:26.447Z", "migrationVersion": -94121931 }, "email": "Excepteur" }, "tasks": { "workflow_start": { "x": 71612888.73066059, "y": -949642.6901105046, "gridCoordinate": { "x": 1068889.9651064277, "y": 57050362.198328346 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 33036766.16063735, "finish_state": "failure", "user": { "_id": "c69a9fd095a301b8cb2b574c", "provenance": "deserunt incididunt ut in", "username": "dolor esse", "firstname": "aliquip consectetur aute ex", "memberOf": [ { "groupId": "7fe32c1b79b324eb09b70621", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed tempor" }, { "roleId": "ipsum" }, { "roleId": "officia deserunt ex dolore" } ], "inactive": false, "lastLogin": "1973-05-09T21:27:22.273Z", "_meta": { "created": "1967-03-25T10:21:53.594Z", "updated": "2003-05-01T09:47:32.958Z", "migrationVersion": -6921612 }, "email": "veniam Lorem Excepteur nostrud in" } }, "groups": [ "6ea6823248d34acdd5910371", { "_id": "3b6eb2887af19e685ff77ae1", "provenance": "ullamco laborum culpa", "name": "mollit est ea", "description": "sunt tempor culpa exercitation ex", "memberOf": [ { "groupId": "78314c5ad4e86e86d307975a", "aaaManaged": true }, { "groupId": "450b770c95a54eb8f191f116", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit eu nostrud" }, { "roleId": "anim fugiat enim" }, { "roleId": "id pariatur" }, { "roleId": "irure Ut" } ], "inactive": true, "_meta": { "created": "2003-05-19T04:24:32.026Z", "updated": "2009-05-13T07:42:46.204Z", "migrationVersion": 16183850 } }, { "_id": "59b42d93758a75e663c4093a", "provenance": "enim", "name": "ad exercitation nulla voluptate", "description": "Duis ipsum id amet", "memberOf": [ { "groupId": "12fbf200b61d8aa02f063ef4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam incididunt Ut in Excepteur" }, { "roleId": "quis" }, { "roleId": "aute amet dolor sunt" }, { "roleId": "deserunt anim nulla" }, { "roleId": "consectetur do voluptate adipisicing" } ], "inactive": true, "_meta": { "created": "1967-04-10T10:13:08.303Z", "updated": "1966-07-10T05:22:31.27Z", "migrationVersion": -54666490 } }, "054bb15bcc61858da8d93dac", "default" ], "iterations": [ "148D8fC8-8F71-D5bB-B0D5-a0Fb21EA1aa4", "b1b5B329-Cddd-35c3-67dC-9462FC8ded91", "a3e586B6-7d4b-2F91-BfD6-Ff8d5fb506C1", "1b09a019-dF6B-2C70-5202-C1593FFb38D8" ] }, "workflow_end": { "x": -81364458.15568197, "y": 67367101.26519006, "gridCoordinate": { "x": -89264431.39758953, "y": -55044826.925170384 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_end" ], "complete": [ "3a1f", "workflow_start" ], "error": [ "e28f", "workflow_start", "3a1f", "e28f", "e28f" ] }, "metrics": { "end_time": -86367681.49213299, "run_time": 17223293.42949967 }, "groups": [ { "_id": "f75b3b1c60e2e036ce55c451", "provenance": "sed in eiusmod consectetur", "name": "laborum", "description": "adipisicing deserunt velit Ut", "memberOf": [ { "groupId": "14cdc75e7f807646d59fcea6", "aaaManaged": true }, { "groupId": "40b96e765a85835b8553aaae", "aaaManaged": true }, { "groupId": "1b41101625e81412b24e2e8b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident cupidatat" }, { "roleId": "ex" }, { "roleId": "dolor dolore ut" }, { "roleId": "sunt" } ], "inactive": true, "_meta": { "created": "1978-07-28T07:29:18.156Z", "updated": "1972-03-07T16:35:40.226Z", "migrationVersion": 50724316 } }, "f12a4540b9a83c1bab78080e" ], "iterations": [ "1EA1DF8D-E081-dEdD-aF2d-C1bF7D2E0d22" ] }, "error_handler": { "x": 68807740.21019086, "y": 70916121.99599263, "gridCoordinate": { "x": -21396900.722212568, "y": -81236497.97028318 }, "name": "childJob", "location": "Application", "locationType": "quis velit sed", "app": "veniam consequat irure aliqua ipsum", "canvasName": "occaecat", "displayName": "nulla deserunt Duis qui occaecat", "summary": "id", "description": "consectetur dolor consequat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/HSophhB.W-d" }, { "type": "encryption", "pointer": "/~1/E/~0/~0/s4UaCJUKe/v/lhqk" }, { "type": "encryption", "pointer": "/~0/~1/xx,y5OH0PpH" }, { "type": "encryption", "pointer": "/IMzEjqYW+O/mr00-p.3M/~1" }, { "type": "encryption", "pointer": "/pRMEur/~0/~0/PWpkGsuja8V/~1/~1/SUyS" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "sed proident aliqua", "highlightString": "cupidatat" }, { "key": "elit", "highlightString": "ullamco" }, { "key": "nulla reprehenderit", "highlightString": "minim eu est pariatur irure" }, { "key": "irure eiusmod dolor aute dolore", "highlightString": "sint commodo consectetur elit" } ], "status": "scheduled", "previous": { "incomplete": [ "3a1f", "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "workflow_end", "workflow_end", "workflow_start", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "veniam", "start_time": "1955-10-24T12:27:14.944Z", "end_time": 17447118.54470618, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": { "_id": "ff400353b5e5aea8f227940f", "provenance": "esse voluptate", "username": "ullamco aliquip", "firstname": "minim officia", "memberOf": [ { "groupId": "d0608811290fa39a8e0012d6", "aaaManaged": true }, { "groupId": "7c63e183403a6d74716b48e4", "aaaManaged": false }, { "groupId": "d6cdb95a7d02e97dda3e9216", "aaaManaged": false }, { "groupId": "30255a6bd259046f30dcc9d3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa sint" }, { "roleId": "irure" }, { "roleId": "quis Lorem aliquip cillum" }, { "roleId": "dolore labore consequat consectetur mollit" }, { "roleId": "in quis adipisicing" } ], "inactive": false, "lastLogin": "2011-04-06T01:23:51.229Z", "_meta": { "created": "2001-11-09T12:07:40.589Z", "updated": "1966-01-05T06:09:44.791Z", "migrationVersion": 66861514 }, "email": "Lorem do Excepteur" }, "groups": [ "default", "default", "default", "default" ], "iterations": [ "C37dAbf7-a939-83fB-a351-D51F952ebebC", "c3A2eE4a-2a79-835F-9536-f6FCEB6C0ce7", "5e76e77f-BAc8-e6DC-6058-4EfEE8eCc43F", "1f99AB32-ED98-FEB9-dF3B-09C6fff8dcfC" ] }, "f470": { "actor": null, "groups": [ "default" ], "iterations": [ "D2E29EB0-9eC6-F7FB-72fd-C9f5C13ff225", "31eA4DbD-11b2-DCcD-f1e7-C2789dE572E8" ], "x": -47682075.397627786, "y": 93875166.68823892, "gridCoordinate": { "x": -88627152.8032582, "y": -87626241.84769212 }, "name": "adipisicing do quis", "location": "Broker", "locationType": "eiusmod pariatur id", "app": "eu", "canvasName": "cillum voluptate commodo", "displayName": "aliqua reprehenderit exercitation nostrud in", "summary": "Duis do Ut nostrud", "description": "exercitation voluptate labore in aliqua", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/PeF/~1/~0/eiKRFmLtEv/~0/~0/W61Fw.,Bc" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "enim anim dolor ex velit", "highlightString": "elit ea ipsum pariatur" }, { "key": "sit deserunt nostrud id", "highlightString": "occaecat est dolore consectetur" }, { "key": "Excepteur nostrud reprehenderit", "highlightString": "Excepteur irure" } ], "status": "canceled", "previous": { "incomplete": [ "e28f", "workflow_start" ], "complete": [ "3a1f", "error_handler", "3a1f", "e28f" ], "error": [ "workflow_end", "workflow_end", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "voluptate non nulla elit", "start_time": "1985-02-16T14:21:44.825Z", "end_time": 95125263.7127335, "finish_state": "success", "retrySettings": { "state": [ "success", "error", "failure", "error" ], "autoRetry": false, "limit": 63054277, "delay": 28163670, "count": 93196977, "finishedRetrying": true }, "type": "manual", "view": "labore do" } }, "parent": { "job": "ipsum", "task": "quis", "iteration": 34209487.36192684, "element": 67458252.76002106 }, "errorHandler": null, "groups": [ { "_id": "6bd9458566f0ea388d798abf", "provenance": "incididunt do in enim Ut", "name": "consequat enim proident in laboris", "description": "cupidatat ad occaecat", "memberOf": [ { "groupId": "6799524bd67788df9da5551c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore Excepteur proident ea" } ], "inactive": true, "_meta": { "created": "2001-06-01T23:37:09.26Z", "updated": "1978-11-15T20:37:31.86Z", "migrationVersion": -20730383 } }, "c6643af63482fc1002f0dbb4", "default", "83896489964900b86e95ad38", "default" ], "watchers": [ null, { "_id": "b9e21efa5cd3f26ec8e43bf3", "provenance": "et laborum eiusmod", "username": "ut", "firstname": "sunt irure", "memberOf": [ { "groupId": "b50d991dcab807d22b192034", "aaaManaged": true }, { "groupId": "625df1f9c84f6dd8af230e8e", "aaaManaged": true }, { "groupId": "2d26a29ae0a4f5cb46d6a3c8", "aaaManaged": false }, { "groupId": "ff0b0360eafd8ba22402d785", "aaaManaged": false }, { "groupId": "6833398681964a2699c86026", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco sit" }, { "roleId": "qui" } ], "inactive": false, "lastLogin": "2002-01-02T16:30:22.458Z", "_meta": { "created": "2001-04-15T11:17:38.847Z", "updated": "2009-01-05T13:07:19.442Z", "migrationVersion": 42554684 }, "email": "irure officia ex" }, { "_id": "5374f59e04a89eabc0803950", "provenance": "proident ullamco", "username": "labore pariatur laborum anim", "firstname": "dolor consectetur veniam cillum do", "memberOf": [ { "groupId": "b995b0d9de079e8a0dacfdbd", "aaaManaged": false }, { "groupId": "d912b55c5aecd07be5bfda81", "aaaManaged": false }, { "groupId": "dbcc0a657e32dc5464a9fa6d", "aaaManaged": true }, { "groupId": "c85d65e8d2431038cc4b398b", "aaaManaged": false }, { "groupId": "c8584995cb311399e1ab4379", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Lorem ut officia exercitation" } ], "inactive": true, "lastLogin": "1956-10-12T02:53:38.42Z", "_meta": { "created": "1971-03-26T03:04:40.477Z", "updated": "1984-10-14T20:22:55.799Z", "migrationVersion": -41898671 }, "email": "Excepteur" }, null, null ], "metrics": { "start_time": 35434588.08631477, "progress": 0.2652627826994043, "end_time": 53214434.783988416, "user": "Pronghorn", "owner": "2a14205aac514ffb71aa8df5" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }