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": "mollit Duis", "options": { "description": "Example job description", "type": "automation", "groups": [ "b7d8909d2cf51a9f23dcae91", "d3bf7644ffb449241af337ae", "bf2714deef564fd3166af648" ] } }
{ "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": "dc8b88ddea663c92f1527792", "uuid": "ea2303f9-aff9-04f6-18bb-550101d13744", "font_size": 43013160, "type": "resource:action", "created": "2024-09-22T18:49:27.046Z", "last_updated": "1953-08-08T04:12:06.276Z", "createdVersion": "1890824.299657.184079-8775.86930403.32508", "lastUpdatedVersion": "304.30.34767286", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 14529578, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -32554357.886946276, "sla": 41027674.97926131, "decorators": [ { "type": "encryption", "pointer": "/~1/UPgPs/~1/~0" } ], "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": "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "elit aliqua" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "minim nostrud irure est sint" } ], "ancestors": null, "validationErrors": [ { "keyword": "occaecat aliqua", "instancePath": "in dolor elit ipsum", "schemaPath": "et esse", "message": "sint adipisicing proident velit" }, { "keyword": "anim culpa", "instancePath": "et cupidatat", "schemaPath": "anim voluptate velit quis", "message": "nostrud deserunt nisi" }, { "keyword": "culpa", "instancePath": "in aliqua dolore do", "schemaPath": "laborum commodo in eu", "message": "culpa" }, { "keyword": "laboris", "instancePath": "pariatur", "schemaPath": "amet nisi", "message": "enim magna" }, { "keyword": "dolore deserunt", "instancePath": "laborum enim quis in", "schemaPath": "Excepteur", "message": "fugiat in sed non dolor" } ], "created_by": { "_id": "f7460a6d2f71b4aa391a7c1e", "provenance": "non minim dolor", "username": "laboris nisi laborum sint", "firstname": "dolore", "memberOf": [ { "groupId": "46f02a3e5f9a283deaeeb2c9", "aaaManaged": false }, { "groupId": "98719245eff6f83676910f34", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure laboris occaecat est" }, { "roleId": "sint fugiat" } ], "inactive": false, "lastLogin": "1982-12-04T05:58:30.142Z", "_meta": { "created": "1972-09-14T02:44:55.074Z", "updated": "1986-10-16T15:51:21.196Z", "migrationVersion": -2885731 }, "email": "et ut eu velit minim" }, "last_updated_by": "Pronghorn", "tasks": { "0": { "actor": "job", "groups": [ "default", "default", "default" ], "iterations": [ "8C9DBb7c-D3ba-D3cd-AA76-85ccA1eD35bE" ], "x": -12043594.671327591, "y": 71864017.4091382, "gridCoordinate": { "x": 66183808.33717209, "y": 71679433.24129474 }, "name": "pending", "summary": "velit culpa", "description": "nostrud" }, "workflow_start": { "x": 85646425.36206862, "y": 87119849.44437706, "gridCoordinate": { "x": 96946811.6095416, "y": 90177075.92049408 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -46970331.28868071, "finish_state": "error", "user": { "_id": "7a46a786c99332c2e5f48f01", "provenance": "dolore adipisicing laboris", "username": "aliquip", "firstname": "mollit quis nulla sed adipisicing", "memberOf": [ { "groupId": "b3b8e0a2715c802b7d218145", "aaaManaged": true }, { "groupId": "0c97b80a62160c11f80f01db", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "minim ipsum dolor ad nostrud" }, { "roleId": "ullamco" }, { "roleId": "sunt voluptate anim mollit in" }, { "roleId": "incididunt cupidatat" }, { "roleId": "Lorem mollit in ullamco" } ], "inactive": false, "lastLogin": "1949-02-01T14:17:17.093Z", "_meta": { "created": "2003-03-08T09:46:43.579Z", "updated": "2005-02-17T11:17:31.128Z", "migrationVersion": -466574 }, "email": "in laboris labore amet" } }, "groups": [ "default", "default", { "_id": "da1b215074165ce87cbc75f1", "provenance": "Ut consequat ut ipsum", "name": "Lorem proident cupidatat quis ex", "description": "occaecat", "memberOf": [ { "groupId": "51649668c43ab64ca9442149", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "magna eiusmod cillum" } ], "inactive": true, "_meta": { "created": "1962-02-27T15:27:40.401Z", "updated": "1982-02-22T18:17:20.562Z", "migrationVersion": 54654373 } }, { "_id": "9a33c945893045704f90128a", "provenance": "nostrud aliqua mollit in", "name": "anim velit irure", "description": "magna non", "memberOf": [ { "groupId": "9793e0540d6715a414b288a5", "aaaManaged": false }, { "groupId": "76048d14aa607a98e75e4321", "aaaManaged": true }, { "groupId": "849ab37f2cef96562148907e", "aaaManaged": false }, { "groupId": "b400eb22210a639b6427f56c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "velit irure" } ], "inactive": true, "_meta": { "created": "1994-12-26T12:18:36.99Z", "updated": "2013-03-18T16:54:41.073Z", "migrationVersion": -25553439 } }, "2c9e06d06364e0edf3b64440" ], "iterations": [ "dB5FA2F9-D5a0-4caE-DBee-CE08c36d7C86", "df9ff9dC-Ba11-FFdc-Dd9f-cB604B15C5fE", "BEA4aDBE-476b-232D-3eb1-EE01FA4555a0" ] }, "workflow_end": { "x": 64157623.58950433, "y": 6497839.233505115, "gridCoordinate": { "x": -35775327.446654305, "y": -752532.1980472803 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end" ], "complete": [ "3a1f", "workflow_start" ], "error": [ "error_handler" ] }, "metrics": { "end_time": -83740641.1797339, "run_time": 70535394.20703262 }, "groups": [ "default", { "_id": "1f670bb16deee5e7d56a1cf2", "provenance": "magna fugiat pariatur esse ex", "name": "proident ut tempor non anim", "description": "aliquip laboris fugiat", "memberOf": [ { "groupId": "8079ab3e50a7f45e3ebc5875", "aaaManaged": true }, { "groupId": "0451518922c684cf66ae0291", "aaaManaged": false }, { "groupId": "1aa3e632b7c310481fe81f6d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia pariatur ipsum aute in" }, { "roleId": "nisi reprehenderit" }, { "roleId": "sunt" }, { "roleId": "aliqua ex nulla ea laborum" } ], "inactive": true, "_meta": { "created": "1963-07-27T01:39:36.508Z", "updated": "1998-01-29T05:08:50.816Z", "migrationVersion": 72080237 } }, "807b23f664b28cc922de3005", "default" ], "iterations": [ "Ec0d56E8-A5D4-2ff9-04cC-e1CABEAC3cbC", "E2614861-FdC3-3E6C-8DAD-E5aECeBFbcED", "E913A6C4-e44e-a2D9-c2e8-653accef3d1A" ] }, "error_handler": { "x": 36381763.67053366, "y": -57128986.0541949, "gridCoordinate": { "x": -63459040.36050163, "y": 83561995.52457285 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "Duis aliqua", "canvasName": "nisi", "displayName": "Ut pariatur", "summary": "consectetur", "description": "qui irure labore velit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Y/~0/~1/~1/~0/s1ArWCy/~1/~1/Ig0q" }, { "type": "encryption", "pointer": "/~0/b/J+PFnuE" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "pariatur nisi", "highlightString": "tempor et" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_end", "3a1f", "e28f" ], "complete": [ "workflow_end", "workflow_end", "error_handler" ], "error": [ "workflow_start", "e28f", "e28f", "e28f", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "ea eiusmod laborum incididunt proident", "start_time": "1998-11-06T12:28:57.417Z", "end_time": 54279326.62147966, "finish_state": "error", "retrySettings": { "state": [ "success", "error", "error", "success", "failure" ], "autoRetry": true, "limit": 61991309, "delay": 98682940, "count": 67865572, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "12dc07d1a0b9a7f7e1f08e1c", "default" ], "iterations": [ "A0D59CFD-Ba03-Bf2C-fFff-0fDFCbc1A87d", "E4a4daE4-dF23-403B-b190-A52a6Acae022", "eCcF4DEa-01D6-83cd-Bfe1-2C63d32f4124" ] } }, "parent": { "job": "aliquip", "task": "reprehenderit tempor pariatur dolor nostrud", "iteration": 72171113.36712807, "element": -19684042.03858523 }, "errorHandler": null, "groups": [ "default" ], "watchers": [ { "_id": "594a7cd4ca2c0226988c7eea", "provenance": "esse elit sint adipisicing", "username": "Excepteur", "firstname": "est minim dolor in ad", "memberOf": [ { "groupId": "055c742dd70c06f64d9dc607", "aaaManaged": true }, { "groupId": "8ff6efaeb5aa2e2478225fc5", "aaaManaged": true }, { "groupId": "d964e1dc6542fa8bb267cbcb", "aaaManaged": true }, { "groupId": "337a13d98011f287aa6d2c1e", "aaaManaged": true }, { "groupId": "8cab1cadde3e080a9373ca01", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore eiusmod" }, { "roleId": "non Duis consectetur ut" }, { "roleId": "fugiat minim non" }, { "roleId": "aute dolore officia aliquip id" } ], "inactive": true, "lastLogin": "1948-02-29T21:28:51.858Z", "_meta": { "created": "1950-11-06T17:14:34.599Z", "updated": "2001-04-23T16:35:54.001Z", "migrationVersion": 62343155 }, "email": "qui sed dolore Lorem velit" }, "5788d0d1a6b6c52b92867d70", { "_id": "d54197a58455798abe5fe7e8", "provenance": "pariatur adipisicing aliquip", "username": "nostrud ad Duis officia", "firstname": "non exercitation", "memberOf": [ { "groupId": "c5effffd197fa38f0ec30787", "aaaManaged": true }, { "groupId": "81745ba755e5b771e35066ef", "aaaManaged": true }, { "groupId": "4d8c6f196e71966b2521fa6e", "aaaManaged": true }, { "groupId": "022f2bdfca8cfafb8e5f54a0", "aaaManaged": true }, { "groupId": "f8ba578cdd0732083e5e72c1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et cillum reprehenderit in in" } ], "inactive": false, "lastLogin": "1964-02-23T21:32:21.063Z", "_meta": { "created": "2017-08-18T12:13:52.868Z", "updated": "1974-03-03T06:11:14.374Z", "migrationVersion": 12001042 }, "email": "nisi Lorem" }, { "_id": "45e86fb00200375214f56477", "provenance": "do laborum", "username": "pariatur est", "firstname": "pariatur mollit est", "memberOf": [ { "groupId": "65c9ded8c95a16e4c13ac88e", "aaaManaged": false }, { "groupId": "3379916222741f6131c97a43", "aaaManaged": true }, { "groupId": "20fb3b540ba97e2c7b7ef41b", "aaaManaged": true }, { "groupId": "45def9be0bb3dfc84dfe5e6a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "commodo mollit laborum pariatur" }, { "roleId": "in consectetur do" } ], "inactive": true, "lastLogin": "1996-08-07T13:24:51.362Z", "_meta": { "created": "1952-06-12T06:24:39.763Z", "updated": "2010-02-03T00:51:14.306Z", "migrationVersion": 65590860 }, "email": "officia dolore" }, { "_id": "f59b53b2ad5c269fd27daadb", "provenance": "dolore ad culpa", "username": "cillum laboris ipsum reprehenderit", "firstname": "in", "memberOf": [ { "groupId": "70b82072ecf77919f3f3d293", "aaaManaged": false }, { "groupId": "2a6aefe2cc49ddcbc91b99b7", "aaaManaged": true }, { "groupId": "48220de2f73f1505d384449e", "aaaManaged": false }, { "groupId": "968b62a0e59d52fedcecf723", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia esse eiusmod Duis" }, { "roleId": "consequat commodo nulla fugiat proident" }, { "roleId": "culpa labore" }, { "roleId": "amet exercitation consequat commodo" }, { "roleId": "exercitation cillum" } ], "inactive": false, "lastLogin": "2005-11-22T15:56:09.662Z", "_meta": { "created": "2011-07-30T14:06:43.652Z", "updated": "2006-10-24T14:49:32.299Z", "migrationVersion": -26953690 }, "email": "commodo ad eu Duis sint" } ], "metrics": { "start_time": -7951718.9845856875, "progress": 0.09126060660948876, "end_time": 14929197.876138598, "user": "b43fae21c5d1e34d65a66df0", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }