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": "minim consectetur", "options": { "description": "Example job description", "type": "automation", "groups": [ "4b5efdad51e0f20554727b30", "747e88d8f7bb467ae98cfc69", "c4e21310b21cebeb2eb928e9", "77db08dd1c003e95ccb0e490" ] } }
{ "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": "0a98de9e49b168b466295f40", "font_size": 22227380, "type": "resource:action", "created": "1972-06-13T01:49:17.309Z", "last_updated": "1989-11-23T03:31:54.681Z", "createdVersion": "729.9463977369.7793117", "lastUpdatedVersion": "5.35742573.335-3946.18463690.43404550.0777192", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -24732234, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 98160644.4799098, "sla": 28453110.888226524, "decorators": [ { "type": "encryption", "pointer": "/Ml2,WP/y5eu/sFKxpaEF/X6yS1/F8NR/~1/~1/~1/msdS/~0" } ], "status": "paused", "tags": [], "error": [ { "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": "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", "message": "irure cupidatat esse dolor" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "ullamco" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "eiusmod nostrud dolor", "dataPath": "culpa", "schemaPath": "non fugiat enim sit", "message": "laboris" }, { "keyword": "do veniam ut quis", "dataPath": "occaecat dolore nulla nostrud sit", "schemaPath": "nostrud voluptate in sit eu", "message": "enim in esse" } ], "created_by": "Pronghorn", "last_updated_by": "073268c76378979a25bb983c", "tasks": { "33": { "x": -80854265.63379006, "y": -71824349.65731442, "gridCoordinate": { "x": -8339379.822521135, "y": -91377649.90856794 }, "name": "labore magna qui", "location": "Broker", "locationType": null, "app": "cupidatat ex do tempor qui", "canvasName": "ea fugiat sed consectetur", "displayName": "enim labore", "summary": "ut elit Ut irure", "description": "sed eiusmod ipsum in deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Nf/~1/~1/zlYX1-fO/BjV/~1/~1/~1/~1/zSbVsIkw8W" }, { "type": "encryption", "pointer": "/~1/~1/~1/~1/~0/~0/~0/~1/M8nRWOE1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ut quis id pariatur sit", "highlightString": "nostrud sit commodo magna veniam" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "e28f", "error_handler" ], "complete": [ "3a1f", "error_handler" ], "error": [ "workflow_end", "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "magna in anim", "start_time": "1979-10-03T04:30:31.644Z", "end_time": 24880303.305232182, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": { "_id": "8654883aafc6d1e6ca530cc0", "provenance": "sint", "username": "mollit ea aliquip ut deserunt", "firstname": "qui", "memberOf": [ { "groupId": "412fcf2e04ad41d0719034ec", "aaaManaged": false }, { "groupId": "4a8ec3e0fda8035abdbf8b9a", "aaaManaged": false }, { "groupId": "f32acd3717d41e0f0f3bfd24", "aaaManaged": true }, { "groupId": "5e37a970f96e52f73544e463", "aaaManaged": false }, { "groupId": "d4266ef5c725aa542a92c65c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eu Duis ut irure" }, { "roleId": "et eiusmod consequat" }, { "roleId": "adipisicing occaecat in" } ], "inactive": false, "lastLogin": "1972-06-20T12:58:30.574Z", "_meta": { "created": "1947-01-17T19:19:59.803Z", "updated": "1946-12-21T17:37:41.022Z", "migrationVersion": -45377797 }, "email": "dolore adipisicing sunt commodo nostrud" }, "groups": [ "default", "default", "f4866ce60ac07b1d65990763", { "_id": "e7cfaaef2cb0063362853fd3", "provenance": "eu", "name": "magna", "description": "elit est", "memberOf": [ { "groupId": "f2b64deed4bdc0bf5465f70a", "aaaManaged": false }, { "groupId": "238dee8e63a1c92d1e4ef26b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt ex cillum" }, { "roleId": "Duis amet culpa" }, { "roleId": "culpa" }, { "roleId": "sit" }, { "roleId": "labore incididunt et qui" } ], "inactive": false, "_meta": { "created": "2004-11-24T14:30:59.17Z", "updated": "2006-06-18T10:48:08.841Z", "migrationVersion": 37426778 } } ], "iterations": [ "cb0BB3c8-14AB-4d6f-4e61-F6aecE3cB8C7" ] }, "workflow_start": { "x": 84821308.62574944, "y": -42850076.550447725, "gridCoordinate": { "x": -53359758.56027675, "y": -59607953.55562993 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -47277287.5490254, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "default", { "_id": "c8cd4117f7c48667d72382d1", "provenance": "in minim quis nostrud aute", "name": "occaecat aliquip ad laborum", "description": "ex qui", "memberOf": [ { "groupId": "8a497a17b660121164c90f07", "aaaManaged": false }, { "groupId": "7586f93ef36cf6eb37747655", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa" }, { "roleId": "et" } ], "inactive": false, "_meta": { "created": "2001-09-19T00:42:16.146Z", "updated": "1950-11-08T01:36:05.664Z", "migrationVersion": 53013909 } } ], "iterations": [ "bD1A0d7F-D409-fDf5-97Ec-8b7fCDA0A486" ] }, "workflow_end": { "x": 93759147.80991352, "y": -31475270.009326234, "gridCoordinate": { "x": 61616820.11168009, "y": 81521031.14420116 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_end", "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "3a1f", "workflow_start" ], "error": [ "error_handler", "error_handler", "error_handler", "3a1f" ] }, "metrics": { "end_time": 58403994.04185343, "run_time": -23551752.24993737 }, "groups": [ "default", "default", "default", { "_id": "6dcc44ecef3ea1072c11ef0a", "provenance": "qui in et id", "name": "occaecat ipsum", "description": "dolor", "memberOf": [ { "groupId": "d4a0571050bf352f1ffc6874", "aaaManaged": false }, { "groupId": "2c815e70eef99fe54abbad9a", "aaaManaged": true }, { "groupId": "2e9fe3ce1b9da486e1ffcffa", "aaaManaged": false }, { "groupId": "f6417f65a902a10e33f4b67e", "aaaManaged": true }, { "groupId": "49d36fa66af1d77f0f546de2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "occaecat ut minim" }, { "roleId": "sunt adipisicing sint nisi" }, { "roleId": "aliqua amet incididunt" }, { "roleId": "tempor sit enim" } ], "inactive": false, "_meta": { "created": "1988-10-06T07:33:13.107Z", "updated": "1995-06-17T18:17:57.701Z", "migrationVersion": 61459347 } }, { "_id": "4a86fb95edc5a4b8e205e530", "provenance": "dolor consectetur Excepteur cillum", "name": "labore ut", "description": "pariatur ut nisi", "memberOf": [ { "groupId": "575d4316f08816031241f057", "aaaManaged": false }, { "groupId": "7a30311491c68b2bc3772f30", "aaaManaged": true }, { "groupId": "43cec85d3a1541f594c665ee", "aaaManaged": false }, { "groupId": "a118011c5dce86f71d3845f3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum mollit est id do" }, { "roleId": "sunt veniam dolor ut" }, { "roleId": "non Duis labore" } ], "inactive": true, "_meta": { "created": "1951-04-27T18:39:31.633Z", "updated": "2020-07-24T09:31:46.589Z", "migrationVersion": 14791403 } } ], "iterations": [ "bEEE23E1-CB3C-1AFD-cdff-567Ea2Eb7bF5" ] }, "error_handler": { "x": 18759174.31459278, "y": -23472171.12226954, "gridCoordinate": { "x": 35915168.39030647, "y": 78405820.51038295 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "pariatur sint ullamco culpa", "canvasName": "proident", "displayName": "consectetur amet", "summary": "officia ipsum est cillum", "description": "consectetur ullamco incididunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/Qs/~0/~1/~1/~1/ZEo1wtX4" }, { "type": "encryption", "pointer": "/iZ/~1/~0/SN7VU6y/~0/NZ/zC-p" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "occaecat", "highlightString": "aliquip sit anim eu" }, { "key": "nisi", "highlightString": "labore ea pariatur velit" }, { "key": "velit incididunt in aute", "highlightString": "non consectetur" }, { "key": "ad magna incididunt", "highlightString": "sunt eiusmod ut proident" } ], "status": "running", "previous": { "incomplete": [ "workflow_end", "workflow_end", "e28f", "error_handler" ], "complete": [ "e28f" ], "error": [ "workflow_end", "workflow_end", "workflow_start", "workflow_end", "error_handler" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "est Ut laboris eu anim", "start_time": "1987-02-01T21:59:36.21Z", "end_time": -77514323.44622415, "finish_state": "success", "retrySettings": { "state": [ "success", "success", "error" ], "autoRetry": false, "limit": 43981281, "delay": 52438613, "count": 74199382, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "659322955e366d779990f8f9" ], "iterations": [] } }, "parent": { "task": "nisi aliquip tempor Excepteur cupidatat", "iteration": -39771588.90389618, "element": -95491510.7489792 }, "errorHandler": { "x": -84336986.81956017, "y": -84400347.78381124, "gridCoordinate": { "x": -93911770.9754521, "y": 32516813.26416947 }, "name": "reprehenderit enim", "location": "Broker", "locationType": null, "app": "ad fugiat eiusmod ut quis", "canvasName": "eu non sed", "displayName": "ea qui sit minim", "summary": "consequat deserunt Excepteur veniam ut", "description": "eu culpa est Excepteur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/r/~1/~1/~0/~0/~0/O//~0/e5/~0" }, { "type": "encryption", "pointer": "/~0/qHDOps/I,7u/~0/Rb/pc.+OZsiHG/y4bhYD5lIH/~0" }, { "type": "encryption", "pointer": "/~0/lqR/uS/~0/~0/~1/~0/A0HwrfJp" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "do cillum Duis", "highlightString": "nostrud dolor sed" }, { "key": "sit voluptate", "highlightString": "aliquip aliqua anim" } ], "status": "paused", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_end", "workflow_start", "3a1f", "workflow_start", "workflow_end" ], "error": [ "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ] }, "serverId": "voluptate aliquip quis", "start_time": "2013-09-13T15:17:35.173Z", "end_time": 3690735.5580501705, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ { "_id": "0ea5c5c35f19f9a805784821", "provenance": "et", "name": "ipsum mollit quis voluptate", "description": "Ut ea", "memberOf": [ { "groupId": "596efa897a52ee28b0b9e3f1", "aaaManaged": false }, { "groupId": "c43d471a5c3d7a5a68a89c25", "aaaManaged": false }, { "groupId": "dfa7f3166c02f2a4a90e42b1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad dolore" }, { "roleId": "quis id nisi occaecat deserunt" }, { "roleId": "consectetur Duis" }, { "roleId": "Lorem reprehenderit" }, { "roleId": "sit esse commodo anim elit" } ], "inactive": false, "_meta": { "created": "1993-01-23T14:29:12.744Z", "updated": "2005-09-22T21:27:31.911Z", "migrationVersion": -88409421 } }, "aafb735663841c65c00e7417", { "_id": "212138f05ba9499fb4ca39d2", "provenance": "ullamco", "name": "in in", "description": "ut cupidatat velit id", "memberOf": [ { "groupId": "2185bc9fff45721d2127606d", "aaaManaged": false }, { "groupId": "57df0d2fa5d3deed44f300cb", "aaaManaged": false }, { "groupId": "781989c80b21d6f478bf2fab", "aaaManaged": true }, { "groupId": "64254640f22bf710f0cc89bd", "aaaManaged": false }, { "groupId": "d77333a10e35526cda85f469", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla" }, { "roleId": "minim mollit Excepteur" } ], "inactive": false, "_meta": { "created": "2000-04-20T16:11:49.824Z", "updated": "1979-05-17T11:26:46.731Z", "migrationVersion": -99997884 } } ], "iterations": [] }, "groups": [ "b6cc9f64bcc0ff9c52efede0", { "_id": "5453c4b903dc4aef78df55ec", "provenance": "sit", "name": "ea cillum", "description": "pariatur velit Ut voluptate magna", "memberOf": [ { "groupId": "bb08d9c8f75fbb3650237d8c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat Lorem minim et enim" }, { "roleId": "aute consectetur" }, { "roleId": "cillum" } ], "inactive": false, "_meta": { "created": "2007-07-31T21:01:00.952Z", "updated": "1965-03-22T00:39:58.845Z", "migrationVersion": 63618617 } }, "default", "7b5be2c160ed8e1256e72475", { "_id": "d3d88229947e728835eea814", "provenance": "do reprehenderit aliquip quis", "name": "nostrud", "description": "officia sed velit consectetur", "memberOf": [ { "groupId": "a40fa067293e45d03c94e07e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "minim" } ], "inactive": true, "_meta": { "created": "2014-11-23T04:15:05.743Z", "updated": "2021-07-02T20:14:48.634Z", "migrationVersion": 29844083 } } ], "watchers": [ "Pronghorn", { "_id": "c41c797b4b4e88bd005eb1b4", "provenance": "magna", "username": "consectetur irure", "firstname": "cillum ipsum ullamco", "memberOf": [ { "groupId": "ae492f95c7d9a339ae16518e", "aaaManaged": true }, { "groupId": "034fc7f53dbd644300019e41", "aaaManaged": true }, { "groupId": "62245817d64d5cb7b59ff090", "aaaManaged": false }, { "groupId": "aacc6ae96c616a3a065ee850", "aaaManaged": false }, { "groupId": "83f37a99fb6b5452f1d834b0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure sint eiusmod Excepteur sed" }, { "roleId": "dolore non incididunt" }, { "roleId": "mollit irure elit est enim" } ], "inactive": true, "lastLogin": "1990-09-06T12:44:03.389Z", "_meta": { "created": "2015-03-12T02:55:54.088Z", "updated": "2024-10-18T09:46:01.245Z", "migrationVersion": 47449747 }, "email": "ullamco incididunt sed" }, { "_id": "be68b96c4d1143c222c60a0a", "provenance": "exercitation quis", "username": "cillum enim sunt Excepteur", "firstname": "in laboris est", "memberOf": [ { "groupId": "1bb6aa52a4461e0c197e46d4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum do sed sunt" }, { "roleId": "id" } ], "inactive": true, "lastLogin": "2008-09-01T15:55:50.832Z", "_meta": { "created": "1977-04-02T22:31:17.749Z", "updated": "2004-03-30T00:48:04.457Z", "migrationVersion": 20234830 }, "email": "ut reprehenderit sit" }, "Pronghorn", null ], "metrics": { "start_time": -1430995.7830896676, "progress": 0.971374293974012, "end_time": -28373268.50929323, "user": null, "owner": { "_id": "b07cf1266700d66bb821ffd9", "provenance": "ex pariatur ullamco adipisicing deserunt", "username": "dolor Ut", "firstname": "consectetur", "memberOf": [ { "groupId": "5e21f2f87474ab4464ea4a2d", "aaaManaged": false }, { "groupId": "759cf47b82513333ffa15cfe", "aaaManaged": false }, { "groupId": "882c4e84895699298732976f", "aaaManaged": true }, { "groupId": "25090acb0f814c536d062f3c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod amet" } ], "inactive": false, "lastLogin": "1955-12-20T08:50:09.331Z", "_meta": { "created": "2019-07-23T11:56:47.344Z", "updated": "2012-01-05T19:57:39.281Z", "migrationVersion": -85155650 }, "email": "tempor Duis qui incididunt consectetur" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }