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": "aliqua et reprehenderit in esse", "options": { "description": "Example job description", "type": "automation", "groups": [ "9f07cb92f08327856f37a03a", "72728a0636263e483c9d5555" ] } }
{ "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": "acb48582b7b0f383e6163537", "uuid": "ac753612-fbd2-6f40-4f89-9e2ce30c400d", "font_size": 65967943, "type": "resource:compliance", "created": "2006-12-12T14:59:11.535Z", "last_updated": "1966-05-02T13:17:56.409Z", "createdVersion": "864.3422980.61120209414", "lastUpdatedVersion": "00276975.701555.4", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -49400738, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 97217605.59243187, "sla": -66327645.84687245, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/a9/~0/~1/CoSe-yCUc/~0/CRLHX1-N/~1/~1" }, { "type": "encryption", "pointer": "/He8yI/bVf" }, { "type": "encryption", "pointer": "/AZf1MElvWIs/n/jf5b7lJ/ykTM.CveBDF/~0/H/XjEMgA+vG/Q/Oj2XE/v4ZcG9s/QwoK8ko/~0/~0" } ], "status": "canceled", "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": "3a1f", "name": "myCoolDocumentName", "message": "nulla veniam" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "Lorem ex quis" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "labore eiusmod in" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "dolore cupidatat labore" } ], "ancestors": null, "validationErrors": [ { "keyword": "veniam", "instancePath": "occaecat ea id veniam", "schemaPath": "sed", "message": "in ex culpa" }, { "keyword": "eiusmod", "instancePath": "est consectetur sint quis", "schemaPath": "veniam commodo sint", "message": "qui" } ], "created_by": { "_id": "ce08c14c009524c506014222", "provenance": "Duis ea", "username": "amet magna", "firstname": "non", "memberOf": [ { "groupId": "b62671fcb3a05380c0c11cec", "aaaManaged": true }, { "groupId": "c64d4331bc8fb9194d01af4f", "aaaManaged": true }, { "groupId": "b75e84de3eedc9b15ea90a66", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis et" }, { "roleId": "cupidatat deserunt" }, { "roleId": "irure" }, { "roleId": "eu sint" } ], "inactive": true, "lastLogin": "1979-06-12T08:05:40.534Z", "_meta": { "created": "1993-08-11T15:01:40.983Z", "updated": "2000-02-15T03:58:45.808Z", "migrationVersion": 20206301 }, "email": "non ullamco ex" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 83931907.8440643, "y": 64634095.357553214, "gridCoordinate": { "x": 75384817.87957427, "y": 99367970.34451383 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -99539915.06647544, "finish_state": "success", "user": null }, "groups": [ "f0db2c2577abaec4a8671440", "cb4ba7ef07dfe488c5f1034d", { "_id": "e5a45d5bd3afa3436d8dd624", "provenance": "minim eu dolor nulla", "name": "ut", "description": "nulla ipsum ea esse", "memberOf": [ { "groupId": "506b472fabf32abd4519c0ec", "aaaManaged": false }, { "groupId": "5c4bad65693b084ff66ae708", "aaaManaged": true }, { "groupId": "db4a647550b365bda49640d5", "aaaManaged": false }, { "groupId": "23d7565fe2d98c1558822511", "aaaManaged": true }, { "groupId": "6a2d793f33eb4267be449370", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation" }, { "roleId": "in" } ], "inactive": false, "_meta": { "created": "1946-11-11T22:30:51.655Z", "updated": "1961-10-21T13:15:21.177Z", "migrationVersion": -42717636 } } ], "iterations": [ "8DBe56EE-3cb8-FD13-c8D9-1cbf5EDdeeca" ] }, "workflow_end": { "x": -54147233.0187796, "y": 81919802.74545574, "gridCoordinate": { "x": 44236800.36020583, "y": 63880183.5025931 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler" ], "complete": [ "workflow_start", "workflow_end", "error_handler", "3a1f", "e28f" ], "error": [ "3a1f" ] }, "metrics": { "end_time": 60361632.22618702, "run_time": 98251048.63882667 }, "groups": [ { "_id": "dd95f22158ad53c24e46d783", "provenance": "nulla cillum", "name": "eiusmod occaecat fugiat cillum laboris", "description": "nulla exercitation anim", "memberOf": [ { "groupId": "752b6b55dbe18f85ec9b7ccf", "aaaManaged": false }, { "groupId": "1a71d0b2eda7b1a7409c0d4a", "aaaManaged": true }, { "groupId": "2656f13b161fe39930760359", "aaaManaged": false }, { "groupId": "10dccb13f0682b4dd7a69402", "aaaManaged": true }, { "groupId": "a402985726a0d98fa04bd33a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit ipsum" }, { "roleId": "fugiat in consectetur" } ], "inactive": false, "_meta": { "created": "2008-02-25T03:32:21.539Z", "updated": "2024-02-01T19:12:29.778Z", "migrationVersion": 16065900 } }, "default" ], "iterations": [ "Fe85CAEF-dcbF-72CB-80dB-5fE65faB9Ce5" ] }, "error_handler": { "x": -81711982.56527714, "y": -19168311.921639174, "gridCoordinate": { "x": -86167403.45062634, "y": 68832824.99163324 }, "name": "childJob", "location": "Adapter", "locationType": "reprehenderit consequat sed Excepteur minim", "app": "fugiat Duis dolor eiusmod exercitation", "canvasName": "consequat id irure anim ex", "displayName": "commodo enim consequat quis", "summary": "qui commodo Lorem", "description": "in ipsum Ut est sit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/Hbz" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~0/gM,8xQsq2/~1/~0/~0/C7Hvawj" }, { "type": "encryption", "pointer": "/~0/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in cupidatat", "highlightString": "deserunt sed minim amet eu" }, { "key": "magna", "highlightString": "consequat aliqua sunt" }, { "key": "dolor", "highlightString": "officia eu est" } ], "status": "running", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "workflow_end" ], "error": [ "3a1f", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" } ] }, "serverId": "sunt eu id est", "start_time": "2013-09-01T15:51:06.334Z", "end_time": 14042469.760329634, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "caeb5da830f503d74f27fe1e", "provenance": "dolor", "name": "reprehenderit ipsum qui do", "description": "et eiusmod ea", "memberOf": [ { "groupId": "50dcc1c574a76fb9a6bab635", "aaaManaged": false }, { "groupId": "a7fe883bc01e7c95dd6c4a05", "aaaManaged": false }, { "groupId": "4a881826e8562605c250f863", "aaaManaged": true }, { "groupId": "89deaed5689ccadd7a428032", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat ea dolore eu officia" }, { "roleId": "eu nostrud non irure in" } ], "inactive": true, "_meta": { "created": "1990-01-21T12:13:10.666Z", "updated": "1948-01-26T16:12:22.739Z", "migrationVersion": 56767470 } }, "default" ], "iterations": [ "FCFa0FAe-7bEd-A7f8-C85f-CCf9be9BFaBd" ] }, "0064": { "x": 23790702.840133935, "y": 34252249.95562339, "gridCoordinate": { "x": -33280624.66525834, "y": -85056105.92356883 }, "name": "incididunt consequat eiusmod", "location": "Broker", "locationType": null, "app": "culpa", "canvasName": "do commodo sunt voluptate dolore", "displayName": "officia magna proident", "summary": "qui pariatur eiusmod sint aliquip", "description": "fugiat voluptate quis reprehenderit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/zT1/~0/~1/F/~1/~0/~1/~0/Imy-hH/~0/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/cNq7XFYLNU/~0/~1/~1/iW/~0" }, { "type": "encryption", "pointer": "/Tu+pfHT/x/fb7V/XoLI/AzbfCt4F/c.KfU2cmlYo/je1QoM" }, { "type": "encryption", "pointer": "/~0/~1/~1/f/oqGklumZ/~1" }, { "type": "encryption", "pointer": "/KEXN,PN/y3/IKfO/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "nulla deserunt ad tempor ea", "highlightString": "ullamco fugiat voluptate commodo" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "e28f" ], "complete": [ "3a1f", "workflow_start", "workflow_start" ], "error": [ "e28f", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "nisi nostrud velit in", "start_time": "2008-01-26T09:02:41.461Z", "end_time": 79971301.04610637, "finish_state": "error", "retrySettings": { "state": [ "success", "failure" ], "autoRetry": true, "limit": 65509017, "delay": 36020804, "count": 81254044, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "2af37d365924f5efb6ff9bb5", "provenance": "ex in cillum cupidatat exercitation", "name": "sed consequat veniam esse", "description": "in laborum aliquip nulla", "memberOf": [ { "groupId": "6ac42eb5e02831d6f80af65d", "aaaManaged": true }, { "groupId": "056ad100ed00ea835241be85", "aaaManaged": true }, { "groupId": "830b5c6ffcbab7f6e844eb0d", "aaaManaged": false }, { "groupId": "b7d3325ba7a5b2b70d25570f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua in" }, { "roleId": "dolore" }, { "roleId": "veniam ullamco" } ], "inactive": true, "_meta": { "created": "1959-04-02T21:20:23.787Z", "updated": "1999-08-01T10:16:17.648Z", "migrationVersion": -17044522 } }, { "_id": "1ea8340c27549640ae7bcd28", "provenance": "ad dolore Ut Duis occaecat", "name": "magna cillum Ut ad fugiat", "description": "Ut veniam velit", "memberOf": [ { "groupId": "1a228d10c6bc9df7e52d06f8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim deserunt laborum" } ], "inactive": false, "_meta": { "created": "1982-12-03T06:10:29.927Z", "updated": "2006-07-19T20:04:32.845Z", "migrationVersion": -8284551 } }, { "_id": "9e97aa3baa723c5c3e31b4b9", "provenance": "veniam ut culpa", "name": "aliquip tempor sit in reprehenderit", "description": "enim consequat", "memberOf": [ { "groupId": "4fd23c43e2ab641e52c9b04c", "aaaManaged": true }, { "groupId": "d8fac49445c5f2cef7e6b6a8", "aaaManaged": false }, { "groupId": "7e0ed2ef3685a992b48158b8", "aaaManaged": false }, { "groupId": "48e1a66085bbca157a86ff4f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nostrud ea Duis commodo Excepteur" }, { "roleId": "sit dolore laborum Lorem non" }, { "roleId": "quis" }, { "roleId": "dolor cupidatat occaecat" }, { "roleId": "ex" } ], "inactive": false, "_meta": { "created": "2000-03-05T00:04:54.99Z", "updated": "1982-04-16T12:24:46.007Z", "migrationVersion": 94238643 } } ], "iterations": [ "25e5CAeD-011f-1029-07aC-7a15C31Cafb7" ] } }, "parent": { "task": "anim ex ut", "iteration": 37602622.92894527, "element": 20182326.71668753 }, "errorHandler": null, "groups": [ { "_id": "d90970f245ec3b195b4bcf91", "provenance": "proident occaecat nostrud", "name": "Ut", "description": "amet", "memberOf": [ { "groupId": "77ee1411830bf2c4c2363645", "aaaManaged": false }, { "groupId": "bfc479e6f61c7d2e65c1218f", "aaaManaged": false }, { "groupId": "26c5126a7c5f1d43cecc0f32", "aaaManaged": true }, { "groupId": "e847c652b74624513bdf547d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do non dolor esse" }, { "roleId": "qui fugiat culpa" }, { "roleId": "deserunt labore" }, { "roleId": "eiusmod nisi ut sit in" } ], "inactive": true, "_meta": { "created": "2014-10-03T14:16:28.365Z", "updated": "1984-05-10T04:43:05.657Z", "migrationVersion": -71438182 } }, { "_id": "761feed52fa9d650570a34d0", "provenance": "in dolor elit laborum", "name": "proident quis in nisi irure", "description": "consectetur id quis", "memberOf": [ { "groupId": "dc3e2f2e8c8ea4502af16cc3", "aaaManaged": true }, { "groupId": "a136dc8bc6570617aa3deb2f", "aaaManaged": false }, { "groupId": "2c9675a2f0217c7c0f9f8b14", "aaaManaged": true }, { "groupId": "3df776fe0085282246519727", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur voluptate adipisicing esse amet" }, { "roleId": "adipisicing occaecat" }, { "roleId": "nisi proident" }, { "roleId": "dolor Excepteur Lorem cupidatat sed" }, { "roleId": "nostrud et deserunt pariatur cillum" } ], "inactive": false, "_meta": { "created": "1964-10-30T14:30:51.128Z", "updated": "1997-02-16T19:39:06.712Z", "migrationVersion": 94434963 } } ], "watchers": [ "Pronghorn", "Pronghorn", "91d18374f119509d43a67a15", { "_id": "e4c63e70d4220961f7523e24", "provenance": "nostrud minim laboris consequat", "username": "in qui veniam", "firstname": "ut", "memberOf": [ { "groupId": "650936ba70ab09258f120e6b", "aaaManaged": true }, { "groupId": "7c5f231bc0a106924fd6d9f9", "aaaManaged": true }, { "groupId": "c22e6558988f18678a2a29cf", "aaaManaged": true }, { "groupId": "bc7a6dd8327ca4c511d207ec", "aaaManaged": true }, { "groupId": "8e0c7c0f1a72f5923c4331c1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit velit est minim" }, { "roleId": "elit ut deserunt Lorem" } ], "inactive": true, "lastLogin": "2005-10-04T06:35:54.724Z", "_meta": { "created": "1957-02-14T13:09:42.48Z", "updated": "1983-09-30T02:22:37.335Z", "migrationVersion": 43266986 }, "email": "Duis deserunt eiusmod in Excepteur" }, { "_id": "4b2d4a089c798c7566847012", "provenance": "proident", "username": "eu Excepteur ad", "firstname": "esse aliqua consectetur consequat anim", "memberOf": [ { "groupId": "ea4e8b81295521a14fdb87ce", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam Ut elit dolore" }, { "roleId": "aliqua" }, { "roleId": "dolor eiusmod voluptate" }, { "roleId": "laborum fugiat" }, { "roleId": "sit Lorem occaecat velit ex" } ], "inactive": false, "lastLogin": "2011-08-25T13:29:12.515Z", "_meta": { "created": "1950-04-29T07:11:02.267Z", "updated": "1946-06-22T23:23:16.292Z", "migrationVersion": 90099025 }, "email": "incididunt sint tempor nostrud" } ], "metrics": { "start_time": -45532.26316899061, "progress": 0.03575465832857683, "end_time": -3762434.6117004007, "user": "Pronghorn", "owner": { "_id": "b932b461b74a908b5beb76a2", "provenance": "sed id eu", "username": "nostrud eiusmod reprehenderit dolor minim", "firstname": "in amet enim magna dolore", "memberOf": [ { "groupId": "4f982b25bec8792929d5ef9a", "aaaManaged": false }, { "groupId": "d2231d5f2aec3ff859aa8a10", "aaaManaged": false }, { "groupId": "933b9a084e18c75d7c173e96", "aaaManaged": true }, { "groupId": "08cfb5b6171b2f6d50dd3b2c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing dolore sint" }, { "roleId": "proident" }, { "roleId": "aliquip irure Lorem anim" } ], "inactive": false, "lastLogin": "1975-02-11T03:11:47.975Z", "_meta": { "created": "2025-03-17T13:38:21.371Z", "updated": "1998-12-07T13:52:58.821Z", "migrationVersion": 83408607 }, "email": "laboris voluptate" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }