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": "nostrud ex sed id", "options": { "description": "Example job description", "type": "automation", "groups": [ "8fdb57db8166d923f39db131", "61a4db8a88e62f1856b46ff5", "8a0523fcaf689e30cb6aaf53" ] } }
{ "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 created the requested item", "data": { "_id": "ac67571f540edfe4aeedc055", "font_size": 3397595, "type": "automation", "created": "2019-01-01T03:21:01.136Z", "last_updated": "2000-02-02T13:46:17.045Z", "createdVersion": "28155161915.4838696.7289233055", "lastUpdatedVersion": "92813.6883815130.51457746303", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -49399219, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 30080605.65296237, "sla": -45183291.75674007, "decorators": [ { "type": "encryption", "pointer": "/~0/f/ETIvHmV/sbR/~0/q-fu8uCH8q/~1/VMn.jNmTv8/~1/l00UXaSFRd/S" }, { "type": "encryption", "pointer": "/ik+.b+o/~0/I4MmDh99v/xllNT/vukdyP/~1/tN/mbwv9U/~1" }, { "type": "encryption", "pointer": "/~1/~0/~0/~1/CN0UB/UP/~0" }, { "type": "encryption", "pointer": "/tE5/~1/jiGCf/~0/vRUAP2u.v5L/iSo/da" } ], "status": "incomplete", "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName", "message": "cillum sunt fugiat velit" } ], "ancestors": [ "b87c5b4e454fe217dff8d46e", "defc499e00e73012b03a6129" ], "validationErrors": [ { "keyword": "ut incididunt ullamco occaecat reprehenderit", "instancePath": "in Ut consectetur ea", "schemaPath": "ex consequat sint", "message": "id qui" }, { "keyword": "do amet sed Excepteur minim", "instancePath": "aliqua consectetur laboris", "schemaPath": "anim consequat exercitation ut ad", "message": "enim irure" }, { "keyword": "anim et reprehenderit velit ex", "instancePath": "consequat", "schemaPath": "velit Lorem", "message": "veniam magna" }, { "keyword": "aute", "instancePath": "tempor ut officia sit sed", "schemaPath": "commodo ea", "message": "culpa eu adipisicing commodo" } ], "created_by": "Pronghorn", "last_updated_by": "17595fe118de7265dad62a7a", "tasks": { "workflow_start": { "x": 8590878.056981444, "y": 92523060.77095792, "gridCoordinate": { "x": -91636177.28234836, "y": 30015062.27898045 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -93632153.90007183, "finish_state": "error", "user": "Pronghorn" }, "groups": [ { "_id": "506b28767bc20a218e725e74", "provenance": "eiusmod et cupidatat esse mollit", "name": "Duis aliquip", "description": "dolor Duis elit", "memberOf": [ { "groupId": "618e5f5d328d923b8c2f6599", "aaaManaged": false }, { "groupId": "883bf60e2be4a2c54020ac4f", "aaaManaged": false }, { "groupId": "938582e61b3cc2df38e755d7", "aaaManaged": true }, { "groupId": "8f5c4963a5c64127ad6c6930", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur labore aliqua" }, { "roleId": "Duis" } ], "inactive": true, "_meta": { "created": "1972-07-29T10:12:52.743Z", "updated": "1958-08-30T08:03:49.124Z", "migrationVersion": 79779199 } }, "default", { "_id": "dbbdfd78f498a952b52398fc", "provenance": "voluptate do", "name": "cupidatat in laborum", "description": "amet magna incididunt mollit voluptate", "memberOf": [ { "groupId": "27d53538826a8268286e55a9", "aaaManaged": false }, { "groupId": "1d7e5a3213321c0307818018", "aaaManaged": false }, { "groupId": "d8996887c7f50891a8aaa093", "aaaManaged": false }, { "groupId": "9c95cd053cd57d1b59ca83da", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Excepteur esse officia aliqua" }, { "roleId": "laborum" } ], "inactive": false, "_meta": { "created": "2018-03-25T05:14:40.9Z", "updated": "2012-12-12T19:10:30.184Z", "migrationVersion": 21454089 } } ], "iterations": [ "Ec2aDCD0-a196-0Da6-1De5-Fbfe2BECC83e", "5D9D7BeF-f549-546A-4B8B-a0c1F7029c17", "DF19110b-58CD-F5fF-4dbE-57bc0e9FDE0D" ] }, "workflow_end": { "x": 8448137.768162712, "y": 58130943.049693316, "gridCoordinate": { "x": 29643931.502820656, "y": -36201377.117402434 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler" ], "complete": [ "3a1f", "3a1f", "e28f", "workflow_start" ], "error": [ "error_handler", "e28f", "workflow_end", "error_handler" ] }, "metrics": { "end_time": 57478766.9443562, "run_time": 28397571.306072637 }, "groups": [ "c891b971cd31dcf497cb332a", "cf4187946180235475bd475e" ], "iterations": [] }, "error_handler": { "x": 24712828.777299568, "y": 38268122.30356485, "gridCoordinate": { "x": 71355026.33362347, "y": -4909510.456802353 }, "name": "childJob", "location": "Application", "locationType": null, "app": "reprehenderit veniam ullamco Lorem", "canvasName": "sunt eiusmod", "displayName": "ut tempor eu elit ex", "summary": "reprehenderit Duis esse", "description": "voluptate", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/DtCrrd" }, { "type": "encryption", "pointer": "/fpCqXOBV.9/~1/L6.-/~0/~0" }, { "type": "encryption", "pointer": "/~1/C/~1/zZ3x/b" }, { "type": "encryption", "pointer": "/U3BXFN0F0W/cEmZ/vbq/e4" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "minim eiusmod cillum sunt ex", "highlightString": "in ut dolor" }, { "key": "amet ut", "highlightString": "voluptate" }, { "key": "dolore", "highlightString": "non Duis" }, { "key": "enim Ut consequat deserunt", "highlightString": "cillum exercitation" } ], "status": "error", "previous": { "incomplete": [ "3a1f", "3a1f" ], "complete": [ "workflow_start", "error_handler", "workflow_start", "error_handler", "workflow_start" ], "error": [ "error_handler", "workflow_start", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" } ] }, "serverId": "esse ullamco officia labore deserunt", "start_time": "1971-01-03T09:58:36.073Z", "end_time": 39117635.71796104, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": { "_id": "a73ca7b5733b9fab87b0465f", "provenance": "ut anim in proident adipisicing", "username": "cupidatat", "firstname": "quis aliquip", "memberOf": [ { "groupId": "a5c59b29ad1b085bf2660f10", "aaaManaged": false }, { "groupId": "14a2da4bd01a0e172408a3b4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem proident qui labore nulla" }, { "roleId": "aliquip dolor" }, { "roleId": "sit" }, { "roleId": "ipsum sunt laborum" } ], "inactive": true, "lastLogin": "1945-01-14T03:40:38.462Z", "_meta": { "created": "2000-07-21T07:11:51.619Z", "updated": "1965-12-05T00:22:21.903Z", "migrationVersion": -31497715 }, "email": "laborum velit Ut in laboris" }, "groups": [ { "_id": "53a8d791a1ac88b18aa73fca", "provenance": "culpa consequat", "name": "officia Excepteur irure Ut cillum", "description": "Ut", "memberOf": [ { "groupId": "d6d1f57d4d4f7742110b9797", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod enim cupidatat nostrud" }, { "roleId": "deserunt velit voluptate" }, { "roleId": "dolore labore aliquip" }, { "roleId": "consectetur in est incididunt velit" } ], "inactive": true, "_meta": { "created": "1970-07-25T02:28:47.584Z", "updated": "1968-12-04T13:38:55.571Z", "migrationVersion": -48991816 } }, "82555e56eee69b0ddfa2d13f", "17bb520117de993b0e023c7e", { "_id": "e617ae4ab7907ce024f36845", "provenance": "ea aliquip Ut qui", "name": "laborum ad fugiat quis veniam", "description": "ea officia", "memberOf": [ { "groupId": "c48c8da6a6956fb6a620e06a", "aaaManaged": false }, { "groupId": "a0564887b06d0ba982a65bb2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla aliquip ipsum Ut" }, { "roleId": "ipsum fugiat occaecat eiusmod" }, { "roleId": "ut in veniam consectetur Duis" } ], "inactive": false, "_meta": { "created": "2010-11-30T04:50:44.114Z", "updated": "1963-10-24T20:00:08.447Z", "migrationVersion": -43556647 } }, "default" ], "iterations": [ "afF5C72E-bDCB-a7Bb-314f-c9b1EfAe9D1D", "FC59c880-149a-4CE7-FDa1-fCc3844AFD49", "a5dd2C62-AAD5-06eF-7067-97f3cF1ff07D" ] }, "d": { "actor": "job", "groups": [ "default", "default", { "_id": "b711ae8867a9e92e1435448d", "provenance": "sed culpa quis in", "name": "do ullamco consequat officia", "description": "magna", "memberOf": [ { "groupId": "160be8fea2825c96a5edc8a9", "aaaManaged": false }, { "groupId": "2fe9495de208d8213818f66d", "aaaManaged": true }, { "groupId": "886ff1513f774248f0dfac34", "aaaManaged": true }, { "groupId": "bd272fb09fb70fb757570199", "aaaManaged": true }, { "groupId": "031b0f0acae504f40f33b0f4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sed voluptate ex ad" }, { "roleId": "Lorem nostrud in officia" } ], "inactive": false, "_meta": { "created": "2007-09-03T00:35:25.452Z", "updated": "2002-08-02T23:47:16.21Z", "migrationVersion": 47412573 } }, "a2f605165b40f6c08a174aec" ], "iterations": [ "E3E7646d-DcE4-8491-Fa1b-44cBdbcb9E34" ], "x": 80715724.82808849, "y": 84515275.6460053, "gridCoordinate": { "x": -95103812.80202687, "y": 24685971.24421002 }, "name": "mollit voluptate", "location": "Application", "locationType": null, "app": "fugiat sint officia non ea", "canvasName": "childJob", "displayName": "consectetur qui", "summary": "mollit qui in culpa", "description": "Duis fugiat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/F6/AV0Z9M-y/~0/~1/~0/fggA8mf/~1" }, { "type": "encryption", "pointer": "/eTkq8/gwSVyuom/IEK/In3HoFFYx/~0/~1/t,h2LP/~0/V" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in", "highlightString": "deserunt cupidatat" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "3a1f", "e28f" ], "complete": [ "workflow_end", "workflow_start", "workflow_start", "workflow_start", "3a1f" ], "error": [ "workflow_end", "3a1f", "workflow_end", "workflow_end", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" } ] }, "serverId": "culpa Lorem in occaecat", "start_time": "1973-09-08T21:58:58.932Z", "end_time": -35648106.85099071, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": false, "finishedCount": 83690820.20101967, "outgoing": [ null, "ad", "minim sunt ea laboris", "Ut eu laboris", null ] }, "childJobs": [ { "_id": "laboris cupidatat adipisicing eiusmod tempor", "name": "ut", "iteration": -19874065.24602467 }, { "_id": "commodo dolor Lorem Duis fugiat", "name": "nostrud cillum", "iteration": 40996943.46881738 } ] } }, "parent": { "task": "dolor laboris", "iteration": -47289534.429202676, "element": 95028923.0907594 }, "errorHandler": null, "groups": [ { "_id": "73d1789c62b328a2f90aff64", "provenance": "Lorem occaecat consectetur", "name": "adipisicing dolore amet occaecat irure", "description": "aliqua aute ex Ut", "memberOf": [ { "groupId": "5c8ca0e6d966752b2937030c", "aaaManaged": false }, { "groupId": "7ee17a453649f536ae66f07c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est quis enim in adipisicing" }, { "roleId": "non quis" }, { "roleId": "laboris elit dolor aute" } ], "inactive": false, "_meta": { "created": "1995-11-08T01:58:25.361Z", "updated": "1979-05-27T17:34:18.052Z", "migrationVersion": -19183279 } } ], "watchers": [ null, { "_id": "d5f377e8c111402e107ea7e6", "provenance": "exercitation sit officia", "username": "ex anim quis esse nisi", "firstname": "ut", "memberOf": [ { "groupId": "010fb13539301844720b0ed3", "aaaManaged": false }, { "groupId": "15206c2b249b88386fbc40f9", "aaaManaged": true }, { "groupId": "0d7e0eb6d3a45c4fcda39740", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat in anim Ut sed" }, { "roleId": "esse minim" } ], "inactive": true, "lastLogin": "1970-06-04T15:20:21.877Z", "_meta": { "created": "2015-01-28T06:51:33.818Z", "updated": "1947-04-21T09:01:49.057Z", "migrationVersion": -77235943 }, "email": "aliqua minim veniam commodo ad" }, { "_id": "b197632f4c9ebee7090bbd39", "provenance": "velit sit cupidatat eu", "username": "laborum quis", "firstname": "sint tempor", "memberOf": [ { "groupId": "f741b3740e445532b3f00362", "aaaManaged": true }, { "groupId": "d82b97128389a58f8df6f52e", "aaaManaged": false }, { "groupId": "b0f0a8f062c6aa861001c4cf", "aaaManaged": true }, { "groupId": "367ece4af182bbb9c54ca571", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt eiusmod in" }, { "roleId": "sint ut" }, { "roleId": "qui commodo velit proident" }, { "roleId": "proident ad" }, { "roleId": "nostrud Duis officia" } ], "inactive": true, "lastLogin": "1985-07-07T01:24:45.993Z", "_meta": { "created": "2022-07-24T20:52:39.921Z", "updated": "1999-06-11T21:33:40.53Z", "migrationVersion": 30377046 }, "email": "laborum fugiat velit" } ], "metrics": { "start_time": -41866265.07643272, "progress": 0.6109252068041928, "end_time": -82155802.34800681, "user": "91cd7bb05b007ebaf7a4cb1e", "owner": { "_id": "6d39ba03c40feaffcb8ce35a", "provenance": "commodo sed", "username": "officia ut laborum dolore", "firstname": "elit minim anim non veniam", "memberOf": [ { "groupId": "50efd51f4072b5c7816dd0d5", "aaaManaged": false }, { "groupId": "017bea5003a515634b9a8161", "aaaManaged": true }, { "groupId": "c792acdbf0182da326f64916", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do laborum" }, { "roleId": "enim amet dolore culpa reprehenderit" }, { "roleId": "velit reprehenderit cillum" } ], "inactive": true, "lastLogin": "1995-03-24T03:30:18.863Z", "_meta": { "created": "2014-02-07T10:35:35.777Z", "updated": "2021-02-16T15:27:58.608Z", "migrationVersion": -91618183 }, "email": "cupidatat eu Duis aliqua" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }