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": "fugiat dolor commodo", "options": { "description": "Example job description", "type": "automation", "groups": [ "0e0df98ed80ebc92d211dbb3", "a2334153045030612f1aeabe", "e119fabc5e40105ff2187fc1" ] } }
{ "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": "e7b2185f7343a72323fc659a", "font_size": -37796649, "type": "automation", "created": "1966-02-15T18:35:03.533Z", "last_updated": "2010-06-19T14:24:19.813Z", "createdVersion": "6.9684598982.326687630-9793.91409.817859756", "lastUpdatedVersion": "2534.62.637583410", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -71285304, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -11679370.262308761, "sla": 55825447.31978479, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/E7KjzD/~0/~0" } ], "status": "paused", "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "cillum in" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "id" } ], "ancestors": [ "68ae1674c5521063a15fef48", "81483e62c2d4a131a28f0154", "5d8cec2dc9b31440fc142d0b", "c765a423f107f225f364b591" ], "validationErrors": [ { "keyword": "Duis fugiat", "dataPath": "sed ullamco eiusmod", "schemaPath": "cupidatat ut", "message": "ullamco minim dolore sit" } ], "created_by": null, "last_updated_by": "8cbe11f4870d7426fd806888", "tasks": { "workflow_start": { "x": -17705004.963182926, "y": -64266284.00469459, "gridCoordinate": { "x": 32104162.314769357, "y": -84235845.67643951 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -91710524.54531865, "finish_state": "failure", "user": { "_id": "e8829369095475687f939441", "provenance": "irure nisi Duis eu", "username": "irure", "firstname": "consectetur sunt magna qui esse", "memberOf": [ { "groupId": "0f41136189f0f00a3600e4fb", "aaaManaged": false }, { "groupId": "10a48649e059f8817eedd5b7", "aaaManaged": true }, { "groupId": "51d14c7e85c2932cafec8ad6", "aaaManaged": true }, { "groupId": "856161bd15209c3759f37118", "aaaManaged": true }, { "groupId": "623cb82616affc5af48b5f29", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur Duis" }, { "roleId": "pariatur sint" }, { "roleId": "aute" }, { "roleId": "velit anim elit ipsum laboris" }, { "roleId": "ipsum sed elit sint" } ], "inactive": false, "lastLogin": "1954-03-22T05:26:15.182Z", "_meta": { "created": "1983-04-04T06:26:47.404Z", "updated": "1978-12-12T08:01:28.34Z", "migrationVersion": -6690091 }, "email": "consequat aliquip eiusmod voluptate" } }, "groups": [ { "_id": "94ef4f4f04c5645372587a29", "provenance": "Lorem laboris ut anim", "name": "in Duis ad veniam", "description": "commodo Excepteur elit in tempor", "memberOf": [ { "groupId": "5f2f8ddb33c5ba4ca7199326", "aaaManaged": false }, { "groupId": "0ecf3e224660d85f49612373", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam" } ], "inactive": false, "_meta": { "created": "1964-02-12T17:28:05.644Z", "updated": "2006-05-30T02:32:32.605Z", "migrationVersion": -77461448 } }, { "_id": "a028120394b94aefb0706a9f", "provenance": "laboris", "name": "ex pariatur laborum", "description": "officia amet proident in", "memberOf": [ { "groupId": "bcca48deb06552ab3f8d66c8", "aaaManaged": true }, { "groupId": "bb8264a0a3b89d9f27717a7c", "aaaManaged": true }, { "groupId": "7647ad080bc958363fc05646", "aaaManaged": true }, { "groupId": "5ac3dd7a67707c149f024906", "aaaManaged": false }, { "groupId": "5b6f5053a7b2469d2b77c322", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim sed dolor" }, { "roleId": "commodo est irure" } ], "inactive": true, "_meta": { "created": "1991-01-20T11:13:36.836Z", "updated": "2001-02-21T14:03:06.226Z", "migrationVersion": 57984321 } }, "default" ], "iterations": [ "CefE5cF4-5F9D-aA79-d042-5AF94c1bDdF9", "38a4cDf5-ecA6-Ef4C-6baD-b2a50C90Da66", "7aB9EfBB-3371-FE8E-C02e-B8EC313D7F09" ] }, "workflow_end": { "x": 74582526.75723699, "y": -29136195.909681067, "gridCoordinate": { "x": 66295152.59618452, "y": -23815495.884340614 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "e28f", "e28f" ], "error": [ "e28f", "3a1f", "workflow_start", "e28f" ] }, "metrics": { "end_time": -88408787.58631976, "run_time": -73615281.64409146 }, "groups": [ "default" ], "iterations": [] }, "error_handler": { "x": 49494546.27111542, "y": 57074977.699416995, "gridCoordinate": { "x": 82444486.68399301, "y": 20923346.42619665 }, "name": "childJob", "location": "Application", "locationType": "reprehenderit", "app": "elit", "canvasName": "amet anim", "displayName": "Ut laborum adipisicing", "summary": "nostrud quis amet", "description": "et proident minim ea dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~1/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "deserunt ad", "highlightString": "officia aliquip ipsum esse" }, { "key": "do eiusmod Duis laboris qui", "highlightString": "nisi magna" }, { "key": "in labore esse", "highlightString": "in enim eiusmod esse" } ], "status": "running", "previous": { "incomplete": [ "error_handler", "3a1f", "workflow_end", "error_handler" ], "complete": [ "workflow_start", "3a1f", "workflow_end" ], "error": [ "workflow_start", "3a1f", "3a1f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "anim aute et reprehenderit", "start_time": "1975-12-02T19:24:52.658Z", "end_time": -49767384.019222714, "finish_state": "success", "retrySettings": { "state": [ "failure", "success" ], "autoRetry": false, "limit": 36633486, "delay": 26491774, "count": 32289845, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ "default", { "_id": "4e7e9ca2005abc3dfff78a14", "provenance": "tempor adipisicing Lorem commodo sed", "name": "anim ex in consectetur", "description": "do", "memberOf": [ { "groupId": "b75ae740fe5f597dd20cd8b0", "aaaManaged": false }, { "groupId": "4b8cde9ed5a72bfd1a324645", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum elit veniam Excepteur ipsum" }, { "roleId": "Ut" }, { "roleId": "deserunt in officia id" } ], "inactive": true, "_meta": { "created": "2013-01-13T04:31:49.307Z", "updated": "2011-05-28T21:16:26.4Z", "migrationVersion": 100765 } }, "default", "default", { "_id": "0ac86c778aae08a189ed4853", "provenance": "esse exercitation dolor sunt pariatur", "name": "officia reprehenderit aliqua sit", "description": "qui cupidatat deserunt sint culpa", "memberOf": [ { "groupId": "3a6f1f337d59ab706f44b058", "aaaManaged": true }, { "groupId": "c6af601e5c68e1d60ae3cdac", "aaaManaged": true }, { "groupId": "9ac73e6d321983d53e706ced", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sit" }, { "roleId": "velit consectetur amet dolore" }, { "roleId": "dolor laboris mollit non sunt" }, { "roleId": "irure in" } ], "inactive": true, "_meta": { "created": "2014-01-02T23:44:36.45Z", "updated": "2011-03-10T16:18:06.081Z", "migrationVersion": 22190394 } } ], "iterations": [ "fcF437de-eB0f-7c6c-5F29-4dCfDcCAaeA0" ] }, "9b": { "x": -37851309.20436681, "y": 13219749.835992992, "gridCoordinate": { "x": 49559298.5509215, "y": 42423015.20422909 }, "name": "qui nostrud irure dolor", "location": "Application", "locationType": "ipsum ullamco id", "app": "laborum qui ex ut", "canvasName": "nisi", "displayName": "eu", "summary": "amet non eu voluptate", "description": "laboris quis dolor sunt et", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/gmMY/~1/~0/TYyyVWshSoM/lnUHZi52/Dv5JSQ/GOnv/17OX72" }, { "type": "encryption", "pointer": "/~0/~1/~1/F8/mQmSIr/eahlZT/~1/RplLp/W/uSkXZwXY," }, { "type": "encryption", "pointer": "/~1/EXfGhl2R.W" }, { "type": "encryption", "pointer": "/VCcKAF7/ggwF/~0/mhgbCzGu/l1mQibefR/~0/Q.,/u" }, { "type": "encryption", "pointer": "/~1/~0/~0/~1/~0/JErngvd/~0/dCP8EvX" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "cillum quis anim sed laboris", "highlightString": "incididunt dolor adipisicing" }, { "key": "non laborum enim quis cupidatat", "highlightString": "deserunt nisi ex voluptate proident" }, { "key": "occaecat proident sint", "highlightString": "reprehenderit incididunt" } ], "status": "running", "previous": { "incomplete": [ "3a1f" ], "complete": [ "3a1f", "3a1f" ], "error": [ "workflow_start", "workflow_start", "3a1f", "e28f", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "anim sint mollit", "start_time": "1984-09-01T13:08:39.962Z", "end_time": 43521043.47712138, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "7c595189be09d757993eda37", "default", { "_id": "9968026ffe7d0175dc2d8acf", "provenance": "ullamco", "name": "ullamco laborum", "description": "aute minim", "memberOf": [ { "groupId": "a0cba451d671fb8e0413906c", "aaaManaged": true }, { "groupId": "9176c35384a0d2c865119728", "aaaManaged": true }, { "groupId": "91eee1e2cc076ff7b0e5a071", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore velit veniam ex" }, { "roleId": "occaecat aliquip velit" }, { "roleId": "nulla ipsum anim" }, { "roleId": "sint esse velit magna consectetur" } ], "inactive": false, "_meta": { "created": "1987-10-23T14:47:20.544Z", "updated": "2002-07-25T05:46:09.335Z", "migrationVersion": 64128471 } }, "default", { "_id": "7a8db95b2e17211b1d47179f", "provenance": "irure", "name": "anim", "description": "Ut dolor laboris", "memberOf": [ { "groupId": "d841c12bed1483a7b0a7f7c3", "aaaManaged": true }, { "groupId": "8ed7e378ea3ce57cb2fc79b8", "aaaManaged": true }, { "groupId": "9d85ef1746e8515dfe0764b7", "aaaManaged": false }, { "groupId": "b42e3036d58ec76d1f64007c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco enim in dolor" } ], "inactive": false, "_meta": { "created": "1945-10-01T11:31:57.595Z", "updated": "1986-03-30T00:29:05.79Z", "migrationVersion": -85681693 } } ], "iterations": [ "ceFed31e-819b-FBd0-bdAa-CF2cbB5f9fB8", "Fdb39dAB-7fD1-e63C-0baB-Ff0B734e1aEF", "929dDbcE-2BEb-C5a9-aBF8-6D1cF947aE3C" ] } }, "parent": { "job": "deserunt dolore ipsum sed", "task": "tempor adipisicing pariatur non", "iteration": 81539819.78162208, "element": 77483673.67275253 }, "errorHandler": { "x": -78825815.20371401, "y": -29648600.788788393, "gridCoordinate": { "x": -20632112.55483158, "y": -55888398.30390153 }, "name": "fugiat cupidatat", "location": "Application", "locationType": "est ad in", "app": "dolor commodo officia", "canvasName": "voluptate dolor Lorem elit", "displayName": "in mollit dolor non", "summary": "voluptate", "description": "qui fugiat laborum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/~1/~1/gEIUHJ/xZDB/Jx" }, { "type": "encryption", "pointer": "/Weiav/PybCgAMz/x1cY/~1/Gw5vJ/z.EMKEJ" }, { "type": "encryption", "pointer": "/BSfTDK5m.J/ePcL2B9c/Xrh.zACE/~0/~0/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "veniam", "highlightString": "ullamco" }, { "key": "qui nostrud", "highlightString": "nisi sit eu irure id" }, { "key": "anim est irure", "highlightString": "dolore ut ut sed commodo" }, { "key": "amet sunt Excepteur qui", "highlightString": "enim sunt proident qui et" }, { "key": "sit dolor", "highlightString": "est eu" } ], "status": "error", "previous": { "incomplete": [ "error_handler" ], "complete": [ "workflow_end" ], "error": [ "error_handler" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" } ] }, "serverId": "ullamco", "start_time": "1983-12-16T23:24:51.219Z", "end_time": 30922003.836690187, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "default" ], "iterations": [ "0aE6EDe3-5aFD-BbC8-CCdA-69F2458F6944", "f84C0a2C-Ff11-63BA-ec45-982a4Db3dAbB" ] }, "groups": [ "9dce53dae6ed7ab871d39a1b", { "_id": "dcc81f7002dd67029cc1bb64", "provenance": "tempor elit", "name": "veniam", "description": "aliquip ut in", "memberOf": [ { "groupId": "a86c3af22159bfc07e8d5cb8", "aaaManaged": false }, { "groupId": "e4d34d628314bb98bd4c8191", "aaaManaged": false }, { "groupId": "a8cade4d9988156383c43988", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non ipsum labore" }, { "roleId": "enim deserunt" }, { "roleId": "nisi reprehenderit in deserunt" }, { "roleId": "sunt non dolore occaecat" }, { "roleId": "ut tempor" } ], "inactive": true, "_meta": { "created": "2010-07-03T20:29:58.534Z", "updated": "2006-12-11T22:16:09.806Z", "migrationVersion": 12737361 } }, "344c5ebe20d9a74819af996f", "default" ], "watchers": [ null, { "_id": "4eff277a7611e18cc8ac6cdc", "provenance": "sit ut id", "username": "irure consectetur", "firstname": "elit", "memberOf": [ { "groupId": "0a1cb1fe441edfab4561e85b", "aaaManaged": false }, { "groupId": "5cf61427554d0cce6b311f87", "aaaManaged": false }, { "groupId": "0911a9c36adc99447456d93b", "aaaManaged": false }, { "groupId": "40c2011dc38618551325bff3", "aaaManaged": false }, { "groupId": "736264e66b1366c9eaedda26", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore" }, { "roleId": "occaecat ut mollit minim" }, { "roleId": "do" }, { "roleId": "mollit aliquip irure eiusmod nostrud" }, { "roleId": "Duis deserunt anim voluptate" } ], "inactive": false, "lastLogin": "2022-03-19T05:18:04.727Z", "_meta": { "created": "2022-07-21T08:23:11.768Z", "updated": "1996-05-10T02:08:53.227Z", "migrationVersion": -74447387 }, "email": "qui" }, { "_id": "69b914f0125e11ea71216865", "provenance": "esse culpa ipsum amet id", "username": "pariatur", "firstname": "officia dolore consectetur", "memberOf": [ { "groupId": "bce68394408909103e65af66", "aaaManaged": false }, { "groupId": "1914ab87ef658c87eadfd916", "aaaManaged": true }, { "groupId": "564e2908198c0c53f058d1f8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla in Duis culpa" }, { "roleId": "sint anim sunt culpa reprehenderit" } ], "inactive": true, "lastLogin": "1949-06-18T13:35:27.221Z", "_meta": { "created": "1974-12-18T17:59:52.419Z", "updated": "1979-06-25T08:43:21.153Z", "migrationVersion": 85565043 }, "email": "magna" }, { "_id": "1e2ce59f99eb70b4b402fcbc", "provenance": "magna", "username": "dolore pariatur minim", "firstname": "ut Lorem fugiat", "memberOf": [ { "groupId": "50243e911a34fae266b7cc42", "aaaManaged": false }, { "groupId": "a086f39ec295e35f49fe1fb2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui et" } ], "inactive": true, "lastLogin": "2017-08-03T08:54:06.994Z", "_meta": { "created": "1957-10-10T07:36:22.677Z", "updated": "2000-09-06T11:23:43.684Z", "migrationVersion": 71489370 }, "email": "amet id reprehenderit" } ], "metrics": { "start_time": 12504147.822416648, "progress": 0.6554518012272392, "end_time": -17993484.499206096, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }