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": "non est incididunt id", "options": { "description": "Example job description", "type": "automation", "groups": [ "f25772eda2ad7221f334d4aa", "36409bcb56c952519309a7f7", "b9424f2bf881462ca4c8ba4e", "082fa12208fb9b71979cec20", "bcb8b928c52364d54842c0ee" ] } }
{ "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": "209e59456d85f70b48f11c57", "font_size": -33135420, "type": "resource:action", "created": "1944-05-04T02:04:04.649Z", "last_updated": "2004-11-19T19:06:14.304Z", "createdVersion": "38979219327.42.35987451", "lastUpdatedVersion": "76.501.7372547382", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -94601140, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 29121507.136218175, "sla": -62776231.0440001, "decorators": [ { "type": "encryption", "pointer": "/q.c/nH/Nd5gO/k/D-PKHf/joOqdZ4" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/eYJeDQ/U.dl,1e1/W/Q/M7VdMzzn/xeQuLQBdR" }, { "type": "encryption", "pointer": "/j.,Bcy2z9F/~1/~1" } ], "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": "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": "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": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "laborum" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "in ullamco in et aliquip" } ], "ancestors": [ "b2055e8b9818a542c19b2125" ], "validationErrors": [ { "keyword": "officia commodo consequat", "dataPath": "aute culpa", "schemaPath": "magna", "message": "commodo veniam ullamco labore eu" }, { "keyword": "dolor ad magna sint veniam", "dataPath": "quis sit", "schemaPath": "mollit", "message": "esse dolore elit ut" }, { "keyword": "ex tempor commodo veniam", "dataPath": "ut", "schemaPath": "sunt", "message": "sit mollit ipsum" } ], "created_by": "8ce1aa2d0e0d96a4ce6630b6", "last_updated_by": { "_id": "c953ae15d88bdba352126d33", "provenance": "in nulla commodo dolore qui", "username": "irure commodo amet ipsum consectetur", "firstname": "eiusmod elit dolor nostrud", "memberOf": [ { "groupId": "245e7d1dd4b8d9aeb753a5f0", "aaaManaged": false }, { "groupId": "733b13e081ff4ba81f2a6c37", "aaaManaged": true }, { "groupId": "0bec89d0545c2d8d64738d5a", "aaaManaged": true }, { "groupId": "fbb6fc162d64b8471c7450bf", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat deserunt sunt" }, { "roleId": "et dolor est" } ], "inactive": false, "lastLogin": "1963-03-29T00:13:43.314Z", "_meta": { "created": "2010-01-02T04:37:55.514Z", "updated": "2023-06-20T13:35:23.47Z", "migrationVersion": -16253290 }, "email": "reprehenderit ut commodo incididunt" }, "tasks": { "workflow_start": { "x": -73146256.64791983, "y": -35370782.28876074, "gridCoordinate": { "x": -89119150.75126112, "y": -62728399.812297605 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -33120998.878030106, "finish_state": "success", "user": { "_id": "d4d31e4b8be42b97af92d9d5", "provenance": "voluptate", "username": "fugiat dolore ea in", "firstname": "sed", "memberOf": [ { "groupId": "002ce1449469f8b5da28c0b8", "aaaManaged": true }, { "groupId": "73d6d53bbdd10fb2034b8f41", "aaaManaged": true }, { "groupId": "0358b10cce21db388d01fb33", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut cupidatat ut reprehenderit" } ], "inactive": false, "lastLogin": "2019-09-16T09:30:47.88Z", "_meta": { "created": "1979-05-25T16:50:48.846Z", "updated": "1954-07-14T16:23:53.182Z", "migrationVersion": -36081481 }, "email": "Duis ut" } }, "groups": [ "b38a76a07eaef227a9fae11b", "default" ], "iterations": [ "4959FeE9-578C-13D7-b07a-Cb90b29cc0c2", "99CC517F-005d-ebb8-Df2F-2EEeafEa7F6B", "AFc847FA-41A9-eDcD-0FC5-2C5520D982C6", "2849AECe-faAc-8DE7-C528-a7DF6f9BB8aA" ] }, "workflow_end": { "x": 8286583.559441045, "y": -20147482.079390362, "gridCoordinate": { "x": -56570736.55190299, "y": 73037741.55987442 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_end", "error_handler" ], "complete": [ "workflow_start" ], "error": [ "e28f", "3a1f" ] }, "metrics": { "end_time": 54662612.5209105, "run_time": -21944620.86569704 }, "groups": [ "default" ], "iterations": [] }, "error_handler": { "x": 81667418.2820479, "y": -34157003.02148523, "gridCoordinate": { "x": -44783415.508562595, "y": 50033695.736875445 }, "name": "childJob", "location": "Application", "locationType": null, "app": "sint", "canvasName": "dolore nostrud Duis cillum", "displayName": "qui pariatur in", "summary": "dolor nostrud", "description": "cupidatat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/m/~0/~0/~1/V/fl+/4" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "quis et", "highlightString": "in aliquip sint commodo" }, { "key": "officia laboris in minim do", "highlightString": "in ut" }, { "key": "in", "highlightString": "dolore Lorem" }, { "key": "dolore nulla consequat", "highlightString": "in eu id" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "error_handler", "workflow_start", "workflow_end" ], "error": [ "workflow_end", "error_handler", "3a1f", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "et Lorem", "start_time": "1951-07-18T00:09:56.875Z", "end_time": -88551118.74380177, "finish_state": "success", "retrySettings": { "state": [ "success", "failure", "failure", "failure" ], "autoRetry": false, "limit": 28419892, "delay": 93747713, "count": 63574982, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ { "_id": "64098df9594a8ef1b26ded93", "provenance": "eu consectetur anim proident qui", "name": "ut", "description": "Duis mollit", "memberOf": [ { "groupId": "2d6b05cd30f423fbc73c0afa", "aaaManaged": false }, { "groupId": "eb749b9ac120032e287ef4d0", "aaaManaged": false }, { "groupId": "102b5343a5eeb5f3f584c5e0", "aaaManaged": false }, { "groupId": "48c4c753738c5baf5f91b0a6", "aaaManaged": false }, { "groupId": "23de0e031f336414bf904d80", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in est cillum pariatur" } ], "inactive": false, "_meta": { "created": "1993-12-12T03:07:02.653Z", "updated": "1964-08-13T14:39:31.77Z", "migrationVersion": -11291864 } }, "default", "default", { "_id": "116380e6eb3e1a7aa3e52677", "provenance": "in cupidatat enim incididunt", "name": "labore culpa", "description": "deserunt consequat", "memberOf": [ { "groupId": "7adb8b2c13567b57e11e63d4", "aaaManaged": false }, { "groupId": "cbb3fce33630984614b1d459", "aaaManaged": false }, { "groupId": "3552f963ad65a2bad8a4e2e6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate" } ], "inactive": true, "_meta": { "created": "1966-01-24T21:23:20.193Z", "updated": "1950-11-13T12:16:53.548Z", "migrationVersion": -81717422 } } ], "iterations": [] }, "3f": { "actor": "job", "groups": [ { "_id": "2d87d77bee80ced64ed3aaa8", "provenance": "fugiat quis amet commodo", "name": "non ex adipisicing", "description": "ex", "memberOf": [ { "groupId": "f25eafe94e8520fa9affd05d", "aaaManaged": false }, { "groupId": "e7e2a16798375d715676e1e6", "aaaManaged": false }, { "groupId": "00b46808b0cad4bf86b04de9", "aaaManaged": false }, { "groupId": "f13f6228da4b85aec86d418e", "aaaManaged": false }, { "groupId": "628d29d417f0657b4f9c1e5b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat" }, { "roleId": "nostrud proident et" }, { "roleId": "et ex" }, { "roleId": "cupidatat quis commodo exercitation" }, { "roleId": "Lorem in culpa" } ], "inactive": false, "_meta": { "created": "1988-11-22T14:55:05.473Z", "updated": "1969-07-09T16:31:01.221Z", "migrationVersion": -75205502 } }, "default", "4342bb48e7797f3b5e005fea" ], "iterations": [ "f6784Dfd-edfC-d96B-b7A2-f0D5bF9B81fA" ], "x": 48135493.19996327, "y": 55395097.85178974, "gridCoordinate": { "x": 35535204.19932422, "y": -86704354.03302234 }, "name": "aute cillum culpa", "location": "Adapter", "locationType": "aliqua aliquip et", "app": "ullamco", "canvasName": "ex nostrud", "displayName": "ullamco", "summary": "in Excepteur ut", "description": "culpa Lorem consequat exercitation", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/K2h./~0/ry/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0/KYVF/~1/y/CzrZ/~0/hPA/~1/~1/~0" }, { "type": "encryption", "pointer": "/J/NKh7BSp1b/eEyLCpo,/YyPhdJ67iT/mf,gJN/fw/~0/~1/X/~0" }, { "type": "encryption", "pointer": "/~0/~0/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "sit proident", "highlightString": "est dolore adipisicing sunt consectetur" }, { "key": "ad do ex ut qui", "highlightString": "cillum in et" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "workflow_end", "error_handler" ], "complete": [ "3a1f", "error_handler", "e28f", "workflow_start" ], "error": [ "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "sunt quis pariatur", "start_time": "1985-12-18T03:57:00.954Z", "end_time": 52811734.22678903, "finish_state": "success", "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 26232606, "delay": 51173749, "count": 20604647, "finishedRetrying": false }, "type": "manual", "view": "aliquip anim in fugiat enim" } }, "parent": { "job": "aute", "task": "id nostrud Excepteur fugiat quis", "iteration": 68962638.70796743, "element": -46613508.15456666 }, "errorHandler": { "actor": "5896c00888982c0867cfdba6", "groups": [ { "_id": "c21885873d5bde541d59f09b", "provenance": "deserunt", "name": "cupidatat tempor Ut reprehenderit", "description": "laborum commodo", "memberOf": [ { "groupId": "18d4d35cae4e667d6b8edb87", "aaaManaged": true }, { "groupId": "ee8b7b1bf3256d5ef41a1860", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "id" }, { "roleId": "occaecat et" }, { "roleId": "in commodo tempor laboris" }, { "roleId": "laborum" }, { "roleId": "cupidatat aliquip" } ], "inactive": false, "_meta": { "created": "1995-08-16T05:11:32.27Z", "updated": "2016-03-06T20:58:59.846Z", "migrationVersion": -32403573 } }, "default", "default", { "_id": "c5b6d86cf1e8dd6cf63f2540", "provenance": "Excepteur", "name": "sit enim", "description": "in minim eu incididunt", "memberOf": [ { "groupId": "233baf78c8651843eeab4e58", "aaaManaged": true }, { "groupId": "2eb25d71cefb4d664e8ff438", "aaaManaged": true }, { "groupId": "9df8bf27a03adab1db14150a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex dolore id in in" }, { "roleId": "magna ipsum ex" } ], "inactive": true, "_meta": { "created": "1955-10-17T05:00:25.212Z", "updated": "2021-01-03T00:28:04.26Z", "migrationVersion": 65518508 } }, "346d967bd3a021c19b8a2ea6" ], "iterations": [ "DBCddfaa-5748-bdbF-be58-E4EF5Abf6fAa", "5D17BCF0-10A0-5AcF-258f-b381Cbb33d79", "4EffC5ae-0A5d-5CBb-8E0b-F724eD08a19b" ], "x": 36985170.27093881, "y": -30796394.17078033, "gridCoordinate": { "x": -27661712.542265788, "y": -54689428.15799336 }, "name": "enim", "location": "Application", "locationType": "cupidatat in mollit ea", "app": "ex consectetur anim in", "canvasName": "sed ea id", "displayName": "ut dolor consequat", "summary": "culpa", "description": "mollit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/Ko,sLO4" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/ute4BCH/F,T/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "eu ullamco", "highlightString": "Lorem adipisicing" }, { "key": "et veniam", "highlightString": "enim" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "e28f", "3a1f" ], "complete": [ "e28f", "workflow_end" ], "error": [ "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "consectetur in nulla ea aliquip", "start_time": "2000-03-23T07:39:12.645Z", "end_time": 97963444.02163544, "finish_state": "error", "retrySettings": null, "type": "manual", "view": "est nulla officia" }, "groups": [ { "_id": "532dda5daf97f4808658b405", "provenance": "commodo", "name": "sed minim qui tempor", "description": "ex Ut labore", "memberOf": [ { "groupId": "d1104098a7e0342a35b70dd2", "aaaManaged": true }, { "groupId": "39fc063022b8d358c75961c8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex" }, { "roleId": "commodo sit velit" }, { "roleId": "Lorem ut in in reprehenderit" }, { "roleId": "officia eu" }, { "roleId": "do" } ], "inactive": false, "_meta": { "created": "2022-12-29T17:14:36.315Z", "updated": "2017-04-25T07:17:19.251Z", "migrationVersion": -23855747 } }, { "_id": "181810a3fea3091cbb23a7e0", "provenance": "ad ullamco aliquip irure", "name": "Lorem sint aute cupidatat", "description": "nostrud tempor", "memberOf": [ { "groupId": "74fd89e628c3435c3a400e1a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation labore adipisicing pariatur" } ], "inactive": false, "_meta": { "created": "2013-03-06T19:35:55.85Z", "updated": "1960-06-10T03:37:23.15Z", "migrationVersion": -61612001 } } ], "watchers": [ "c89eee620bbc648b9526d253", "Pronghorn", "07e278b520b09eaca3273729", "4e280a779067dba487abfcad", "Pronghorn" ], "metrics": { "start_time": -91515734.02235882, "progress": 0.8655521538808799, "end_time": -72850032.33701977, "user": "Pronghorn", "owner": "39791f7ba16af1937996e320" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }