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": "ut nisi Excepteur veniam ea", "options": { "description": "Example job description", "type": "automation", "groups": [ "c6b4f4dee8bcbdb9aa60fe2a", "1cda7d0eb510fd1875d809e4", "f1bad0d078b9b943dcba5726", "4a6436e434bc246005e9255b", "fb6c2b32628aa975996e0bfe" ] } }
{ "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": "7ae290e4327b7c3b8ec137e3", "uuid": "b6ab8f69-8e60-6c23-4b8f-51eb791d95ff", "font_size": 96789884, "type": "resource:compliance", "created": "1975-09-12T14:24:09.001Z", "last_updated": "1981-11-22T00:50:24.572Z", "createdVersion": "21.2971.6598-3656.29855269252.30896162088", "lastUpdatedVersion": "70586598530.295684036.20249275-0327.65557111.6370822626", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 2097614, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 8396391.681031898, "sla": -74851488.22020352, "decorators": [ { "type": "encryption", "pointer": "/~0/EEpBOPUW/L6BTE1AgzsO/~0" }, { "type": "encryption", "pointer": "/~0/~1/AoiZHTWx4v/u/~1" } ], "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": "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": "e28f", "name": "myCoolDocumentName", "message": "tempor sint" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "in nisi officia aliquip tempor" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "esse reprehenderit nulla pariatur" } ], "ancestors": null, "validationErrors": [ { "keyword": "ipsum", "instancePath": "ad non ut Duis", "schemaPath": "sit proident laboris cillum tempor", "message": "Duis" }, { "keyword": "consequat ullamco in laboris Ut", "instancePath": "aute", "schemaPath": "labore est ad", "message": "id reprehenderit do" }, { "keyword": "officia in cillum laborum veniam", "instancePath": "qui labore occaecat sed", "schemaPath": "consequat ut", "message": "reprehenderit laborum ad quis" } ], "created_by": null, "last_updated_by": { "_id": "7fa9388f4e6554ddbc4d6d03", "provenance": "ullamco incididunt commodo", "username": "voluptate", "firstname": "ad cupidatat", "memberOf": [ { "groupId": "2738e6fd9054684780f4c2c3", "aaaManaged": false }, { "groupId": "15077040cc8f516aec527766", "aaaManaged": true }, { "groupId": "48dd0c7aff9d7212f9fbf6a6", "aaaManaged": false }, { "groupId": "6321664864a9205523c86d61", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do velit Excepteur" }, { "roleId": "non voluptate esse in" }, { "roleId": "nulla magna officia" } ], "inactive": false, "lastLogin": "2020-08-14T05:03:17.057Z", "_meta": { "created": "1959-08-16T01:44:20.057Z", "updated": "1979-07-08T04:01:17.711Z", "migrationVersion": 9979421 }, "email": "Ut dolor laboris anim" }, "tasks": { "362": { "actor": "job", "groups": [ "9e9590e6b097bdf6a76df2fe", "default", { "_id": "cdfce04adb365fa3dbdd8263", "provenance": "ad cillum magna non", "name": "veniam esse voluptate non", "description": "Lorem", "memberOf": [ { "groupId": "fb4205705c243eef255d2e53", "aaaManaged": true }, { "groupId": "c0a150a35729da9eaec04d43", "aaaManaged": false }, { "groupId": "9b6867136e035a577f496aef", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco" }, { "roleId": "non elit ipsum amet fugiat" }, { "roleId": "aliquip in fugiat eiusmod officia" } ], "inactive": false, "_meta": { "created": "2000-09-21T20:17:00.696Z", "updated": "1951-08-24T07:47:44.337Z", "migrationVersion": -53295958 } }, { "_id": "462f4f65f2baddc712261de9", "provenance": "exercitation", "name": "culpa magna sint veniam mollit", "description": "ex do", "memberOf": [ { "groupId": "b9dec00c9566d02b417c8510", "aaaManaged": false }, { "groupId": "c62fa5b89f29db775023f7ce", "aaaManaged": true }, { "groupId": "76bdcdcdbd1783067772fd7c", "aaaManaged": false }, { "groupId": "c4e4ef617caf345c90fffa27", "aaaManaged": false }, { "groupId": "69a615c78c2c71fcd22dbe41", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est labore" }, { "roleId": "nostrud in occaecat in officia" }, { "roleId": "magna veniam" }, { "roleId": "consectetur tempor eu veniam consequat" }, { "roleId": "qui laboris" } ], "inactive": false, "_meta": { "created": "2002-09-04T00:52:25.152Z", "updated": "2017-09-02T12:07:51.773Z", "migrationVersion": -12520784 } }, { "_id": "1fa3e66c303819500424c0b6", "provenance": "magna", "name": "incididunt in in consequat Ut", "description": "sunt velit consectetur non", "memberOf": [ { "groupId": "8581f265eb91b1ce89612a89", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint in deserunt" }, { "roleId": "exercitation ut ut" }, { "roleId": "ipsum" } ], "inactive": false, "_meta": { "created": "1969-12-09T09:38:39.657Z", "updated": "2008-07-18T02:03:02.946Z", "migrationVersion": 25577072 } } ], "iterations": [ "ca11ACDC-423c-Ebde-DcB1-fA8235Ec8200", "cf5f2e4a-0639-e223-EBE5-5F2dA6eF3faD" ], "x": -15088654.200910985, "y": -35793283.86754885, "gridCoordinate": { "x": 92934027.9068183, "y": -65555288.02140853 }, "name": "reprehenderit eiusmod", "location": "Application", "locationType": "adipisicing id anim laborum dolore", "app": "cupidatat non do", "canvasName": "childJob", "displayName": "nulla elit in", "summary": "sunt aute minim nulla ex", "description": "commodo proident officia ea", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/ufz0TR/~1" }, { "type": "encryption", "pointer": "/fm/klpc7uluf/d../PT.Q0Cx59LJ/SS" }, { "type": "encryption", "pointer": "/ZQ/~1/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/~0/lU9LESgK/~0/~1/ywX4z/vhV" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolore in", "highlightString": "aute" }, { "key": "occaecat eu sunt", "highlightString": "aute laborum" }, { "key": "qui id", "highlightString": "consectetur in magna culpa reprehenderit" } ], "status": "canceled", "previous": { "incomplete": [ "e28f", "workflow_start", "workflow_end", "e28f" ], "complete": [ "e28f", "workflow_end", "e28f", "3a1f" ], "error": [ "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "revert" } ] }, "serverId": "veniam deserunt", "start_time": "1985-10-29T01:57:37.731Z", "end_time": 54440901.47651684, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": false, "finishedCount": -81793960.56473526, "outgoing": [] }, "childJobs": [ { "_id": "in aliquip culpa cillum ex", "name": "consectetur", "iteration": 8420052.473696634 } ] }, "workflow_start": { "x": -31208845.58668892, "y": -57543408.85930014, "gridCoordinate": { "x": -42052732.96996457, "y": 20786457.723859802 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 90436153.07898057, "finish_state": "error", "user": "Pronghorn" }, "groups": [ { "_id": "0c011d3d88e8363eec6617c4", "provenance": "ex in occaecat", "name": "id cillum velit proident", "description": "sunt ex in fugiat laboris", "memberOf": [ { "groupId": "2e9e18d01e73b9f65dfb5be9", "aaaManaged": false }, { "groupId": "a8ed96d0b7ec7334abd7c694", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure laborum velit" }, { "roleId": "tempor in cillum qui nulla" } ], "inactive": true, "_meta": { "created": "2024-01-28T14:14:12.568Z", "updated": "1989-02-25T02:56:03.608Z", "migrationVersion": 54044073 } }, "default", "d6ac189ab529c88bfb5d0b35", "default" ], "iterations": [ "dABdbca6-E0bc-e9D9-dB4B-9B63f2bdEBAB" ] }, "workflow_end": { "x": 30265181.209615737, "y": -10878337.142998487, "gridCoordinate": { "x": 48727538.05113104, "y": 55757626.49883735 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler" ], "complete": [ "workflow_start" ], "error": [ "error_handler", "workflow_start", "workflow_start", "workflow_end", "e28f" ] }, "metrics": { "end_time": -36456345.0491437, "run_time": -36627104.85259324 }, "groups": [ { "_id": "75601cf5d11af05aaa437141", "provenance": "Duis", "name": "sed laborum reprehenderit", "description": "et", "memberOf": [ { "groupId": "263f76486334620da3d33416", "aaaManaged": false }, { "groupId": "8e7020e54a3f3e24d618c7cc", "aaaManaged": true }, { "groupId": "88d0aa52791970b4f2855578", "aaaManaged": false }, { "groupId": "d52cba23ef4d9b748b9840ca", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco sit in" } ], "inactive": true, "_meta": { "created": "1985-09-28T11:34:59.7Z", "updated": "2006-07-23T17:10:04.228Z", "migrationVersion": -96489627 } }, { "_id": "24df42752d8520c6577c674c", "provenance": "consequat ut esse", "name": "aliqua officia", "description": "fugiat dolore dolor exercitation", "memberOf": [ { "groupId": "522d0cf991e3cb9f60bf06ce", "aaaManaged": true }, { "groupId": "0c5610806a74924cdeb730ab", "aaaManaged": false }, { "groupId": "9e1f08f0be313353d0aa3b6e", "aaaManaged": false }, { "groupId": "3f7e05708cf4e23f6987fb69", "aaaManaged": true }, { "groupId": "0dc4538ad3929efceecf1557", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet laboris sit" }, { "roleId": "exercitation nulla nostrud" }, { "roleId": "quis in nostrud mollit" }, { "roleId": "id tempor aliqua" }, { "roleId": "elit" } ], "inactive": false, "_meta": { "created": "2003-08-07T02:15:06.104Z", "updated": "1988-01-14T00:25:26.964Z", "migrationVersion": 91852780 } }, "default" ], "iterations": [] }, "error_handler": { "x": 75220475.99395582, "y": 77109790.60908481, "gridCoordinate": { "x": -3226832.443603337, "y": 10081430.593678892 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "exercitation ullamco laboris eu anim", "canvasName": "eu eiusmod occaecat", "displayName": "cupidatat aute sunt occaecat", "summary": "ipsum anim", "description": "enim incididunt irure", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/NSL/~1/~0/rm/u6DwwG4GbRs/~1/KMp/~0" }, { "type": "encryption", "pointer": "/~0/~1" }, { "type": "encryption", "pointer": "/~1/OZF/~0/~1/~0/~0" }, { "type": "encryption", "pointer": "/~1/A1-9k/j26N4OOtGe/mcdP/~1" }, { "type": "encryption", "pointer": "/TXjJwguLS79/~0/LBw+0JjOxQ" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "tempor consequat sint", "highlightString": "Lorem" }, { "key": "sunt do mollit", "highlightString": "non aliquip" }, { "key": "laboris", "highlightString": "ut" } ], "status": "complete", "previous": { "incomplete": [ "e28f", "3a1f" ], "complete": [ "workflow_start", "3a1f" ], "error": [ "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "eiusmod", "start_time": "1991-10-12T13:54:33.91Z", "end_time": -84249104.97866853, "finish_state": "failure", "retrySettings": { "state": [ "success", "success", "success", "success" ], "autoRetry": false, "limit": 6406226, "delay": 33512394, "count": 73108065, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", "default" ], "iterations": [ "71513FDe-a2BF-77ce-749F-46BEAc7B907E" ] } }, "parent": { "task": "commodo", "iteration": -1453848.9356368184, "element": 38241016.1924701 }, "errorHandler": null, "groups": [ "default", { "_id": "53d09a06b64ae6c8f2209721", "provenance": "pariatur qui nulla", "name": "tempor", "description": "reprehenderit esse eu", "memberOf": [ { "groupId": "9954e7ceaefb5c1831f40b35", "aaaManaged": true }, { "groupId": "005ca97b47d7efd162f0e363", "aaaManaged": true }, { "groupId": "952a877d387d7638164695f7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur sint adipisicing aliquip aliqua" }, { "roleId": "labore sit est consequat dolor" }, { "roleId": "ea exercitation nulla magna" }, { "roleId": "exercitation sint cupidatat aliquip" }, { "roleId": "fugiat nisi dolor qui" } ], "inactive": false, "_meta": { "created": "2007-07-20T09:27:38.611Z", "updated": "2009-06-15T06:56:14.128Z", "migrationVersion": 25042264 } } ], "watchers": [ null, "c9a5d9c283f552e8725b8ddd" ], "metrics": { "start_time": 1989475.7158991843, "progress": 0.15558406030307292, "end_time": -67087160.09779674, "user": "Pronghorn", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }