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": "mollit", "options": { "description": "Example job description", "type": "automation", "groups": [ "662bacc99cb085345d3152a1", "8fb522eeb5b1478b6b89a0e0", "427fb43008bb481493b63169" ] } }
{ "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": "99af20114b741ce5c1632326", "font_size": -57118511, "type": "resource:action", "created": "2024-12-22T07:39:47.365Z", "last_updated": "2010-01-15T12:51:53.128Z", "createdVersion": "9236783157.05658.905656662", "lastUpdatedVersion": "22.9914427144.82198043", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -68893377, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -71703174.76192039, "sla": -47399362.417723715, "decorators": [ { "type": "encryption", "pointer": "/~1/g-g08,g/~0/gW7Hro/q/~0/~1/Z8dm0jkkdw/SoBhEyq/UF2S-e1/~0" } ], "status": "complete", "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 }, { "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" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "mollit Ut" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "commodo aute dolor laboris", "instancePath": "laborum id sunt veniam occaecat", "schemaPath": "velit ut est", "message": "dolor" }, { "keyword": "non", "instancePath": "nisi voluptate dolor", "schemaPath": "sit est ullamco in amet", "message": "velit irure" }, { "keyword": "exercitation elit esse eu", "instancePath": "consectetur elit irure", "schemaPath": "laborum exercitation sit in", "message": "veniam" } ], "created_by": { "_id": "a783eaddce681a373ad29c48", "provenance": "ullamco", "username": "occaecat magna qui elit exercitation", "firstname": "commodo est do pariatur sunt", "memberOf": [ { "groupId": "b3e416a847c624287aeba229", "aaaManaged": false }, { "groupId": "932968096e6e124bda2d114b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do velit" }, { "roleId": "ut ullamco in" } ], "inactive": false, "lastLogin": "1955-09-02T15:00:23.435Z", "_meta": { "created": "1993-04-01T19:20:03.76Z", "updated": "1955-01-27T04:55:57.345Z", "migrationVersion": -3558636 }, "email": "et" }, "last_updated_by": "6f500fbbc14ec133d27cf42e", "tasks": { "workflow_start": { "x": -50223710.63564051, "y": -58672978.55930418, "gridCoordinate": { "x": 94019064.14833218, "y": -26085806.519523963 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 78697611.65870884, "finish_state": "error", "user": "5b351db960fa868233837c94" }, "groups": [ "default" ], "iterations": [ "68171BD0-b4Eb-B99f-FdDB-9Af9Bb7D216f", "91Ba5a4B-ddaA-4B93-5fec-D6c8AE0E7046", "C05CCd3E-265d-f2da-5a6f-2c4737E0F96B", "2CA558Ab-5ebe-CB1B-958E-56fdb557235e" ] }, "workflow_end": { "x": -60300840.71021653, "y": -35845919.39339301, "gridCoordinate": { "x": 93976095.29128158, "y": 80818339.64537126 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_end", "e28f", "workflow_start" ], "complete": [ "workflow_end", "workflow_start", "e28f" ], "error": [ "workflow_end", "workflow_start" ] }, "metrics": { "end_time": -17928901.972991616, "run_time": 75027880.01706451 }, "groups": [ "2621c4c91e3b7936d4011331", "8202f62b181be1b3a28050c9", { "_id": "8ed55eadbbb2d41cee9c8191", "provenance": "dolor eu", "name": "sunt quis", "description": "in est deserunt", "memberOf": [ { "groupId": "2abe157f9fb03e17110a4467", "aaaManaged": true }, { "groupId": "9f768a4153649d779a95204d", "aaaManaged": false }, { "groupId": "8af8911b5ce68756726a8428", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat in nulla et" }, { "roleId": "cillum incididunt Duis eu" }, { "roleId": "nulla velit culpa" }, { "roleId": "adipisicing eiusmod fugiat non" }, { "roleId": "mollit fugiat dolor occaecat nisi" } ], "inactive": false, "_meta": { "created": "1996-12-21T12:03:03.931Z", "updated": "1967-06-01T12:48:22.813Z", "migrationVersion": -18235293 } } ], "iterations": [ "e0DE077f-aEFa-56Fb-B7ed-9D8bF8D2F080" ] }, "error_handler": { "x": 86440516.58927152, "y": 89105942.35948414, "gridCoordinate": { "x": -3348018.959356874, "y": -43678078.134470865 }, "name": "childJob", "location": "Application", "locationType": null, "app": "ullamco est ad anim occaecat", "canvasName": "pariatur", "displayName": "nulla est ut Excepteur", "summary": "occaecat veniam tempor", "description": "aute ex veniam laborum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/DB/JjFqeDc/P6ul/QBo" }, { "type": "encryption", "pointer": "/~1/rs/~1/cV,YoUgHUO/~1/~1/e1/~0/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/So2D/~0/~1/~1/~1/~0" }, { "type": "encryption", "pointer": "/u/D80uITD/xXX+00gk5dw/WslX-Ow/VAtcQC+XSL" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "est velit", "highlightString": "officia consequat elit" }, { "key": "aliqua deserunt consequat culpa eu", "highlightString": "minim Duis elit" }, { "key": "in ad", "highlightString": "reprehenderit ut labore ex mollit" }, { "key": "Excepteur", "highlightString": "aute" }, { "key": "magna eu non elit irure", "highlightString": "commodo nisi culpa" } ], "status": "paused", "previous": { "incomplete": [ "error_handler", "e28f", "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "workflow_end", "workflow_end", "e28f", "workflow_start", "error_handler" ], "error": [ "error_handler", "error_handler", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "minim aute do culpa", "start_time": "1981-11-23T18:16:35.059Z", "end_time": -79485029.13630216, "finish_state": "error", "retrySettings": { "state": [ "error", "failure", "success", "success", "success" ], "autoRetry": true, "limit": 19567141, "delay": 49591164, "count": 36916517, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "6280b2ac704e3f36bc2af05d", "44048e3a87167bf3b393a5d1", "default" ], "iterations": [ "A9CA9aA0-9BfF-FAeF-Eedb-BdADdEcfE50F", "cb4F08A9-E92F-57Fd-EC37-7ca2Dd2d66eD" ] }, "c": { "actor": "$var.5f81.RFNdkD_vtqi", "groups": [ { "_id": "bbe0ef1828bd1262474060f6", "provenance": "eu ad aliquip", "name": "sunt ad sed do", "description": "id Ut", "memberOf": [ { "groupId": "e8db8cff08fcd4ef0b24743b", "aaaManaged": false }, { "groupId": "6fa728ad7f850dfc806f7f1c", "aaaManaged": false }, { "groupId": "5d9928ddb67c52bccd662677", "aaaManaged": true }, { "groupId": "24ea3e2d0acdd07d69a6c267", "aaaManaged": false }, { "groupId": "8fc56e1b0cbc6e5d9b2dc200", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod nisi occaecat fugiat cupidatat" }, { "roleId": "dolor" } ], "inactive": true, "_meta": { "created": "2000-11-16T21:38:42.214Z", "updated": "1987-10-25T07:02:47.777Z", "migrationVersion": -34102543 } }, "97bb690471ef1dc860157f49", "d0f6b5a7d5c40597e86246fb", "d870bfeafa9204a067b9baec" ], "iterations": [ "8dC5D2f2-467e-06E7-28eE-dDda8d0cC3fd" ], "x": 84304115.46385685, "y": 85758196.92311898, "gridCoordinate": { "x": -23710103.824254826, "y": 9712250.018941626 }, "name": "ut ea Excepteur", "location": "Application", "locationType": null, "app": "laboris", "canvasName": "dolor labore exercitation cupidatat", "displayName": "officia", "summary": "sint", "description": "nisi reprehenderit quis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Es1RhX/mx/dR.JXREhdU/~1/OeAw9K-p/~1/dR.N5aaT/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "sunt", "highlightString": "et Excepteur ut in" }, { "key": "amet id", "highlightString": "consequat" }, { "key": "laboris commodo sit in", "highlightString": "ipsum minim adipisicing" } ], "status": "failure", "previous": { "incomplete": [ "e28f", "error_handler", "workflow_end", "3a1f" ], "complete": [ "error_handler", "workflow_start", "e28f" ], "error": [ "error_handler", "e28f", "workflow_end", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "et", "start_time": "1986-10-17T20:04:28.36Z", "end_time": -56729886.9563388, "finish_state": "failure", "retrySettings": null, "type": "automatic" } }, "parent": { "task": "pariatur", "iteration": 27648479.73658879, "element": 60312516.401135296 }, "errorHandler": null, "groups": [ { "_id": "84e7627600b87bd06b589c88", "provenance": "in Lorem", "name": "nisi non", "description": "tempor", "memberOf": [ { "groupId": "2a22a6398f4eb17cebe3ee0d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit nulla labore ut est" }, { "roleId": "nostrud irure do" }, { "roleId": "mollit nostrud cupidatat ipsum labore" }, { "roleId": "non aliqua enim" }, { "roleId": "irure" } ], "inactive": false, "_meta": { "created": "1949-11-14T03:26:51.353Z", "updated": "1962-05-26T07:50:21.154Z", "migrationVersion": 48343215 } }, "default", "default" ], "watchers": [ null, "380c5ac7b9d0b476bcd0e5d2", null ], "metrics": { "start_time": 45677444.074068695, "progress": 0.9579544221255283, "end_time": -58456491.645226814, "user": null, "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }