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": "non proident quis cupidatat", "options": { "description": "Example job description", "type": "automation", "groups": [ "2472597e454aed9086a192dd" ] } }
{ "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": "65b26839923f993de73dd9b8", "font_size": -23966948, "type": "automation", "created": "2007-07-30T03:48:39.174Z", "last_updated": "2006-09-06T09:19:27.205Z", "createdVersion": "085027.681.8-7755.132527.4.5", "lastUpdatedVersion": "92.179614295.54198732462", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -60070170, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 62815276.24773994, "sla": -93910362.16709834, "decorators": [ { "type": "encryption", "pointer": "/mg6E.84I8" }, { "type": "encryption", "pointer": "/IPQeiH/Y50G/C4d1/~0/~0/~0/~1/~0/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1" } ], "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "est occaecat labore" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "ex ut enim do nostrud" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": [ "ff6628e788906b38e8707970", "9dcebc8d9ece49868f0a53df", "6c7aa2cf0624f818b404060a" ], "validationErrors": [ { "keyword": "veniam", "dataPath": "in minim mollit Excepteur Lorem", "schemaPath": "qui labore quis", "message": "nisi" }, { "keyword": "anim voluptate proident pariatur", "dataPath": "in", "schemaPath": "ex quis adipisicing pariatur non", "message": "sed occaecat dolor Duis" }, { "keyword": "cupidatat officia ad", "dataPath": "sit deserunt irure ex", "schemaPath": "cupidatat nulla velit qui esse", "message": "voluptate velit commodo ut" }, { "keyword": "tempor minim magna incididunt dolore", "dataPath": "nostrud dolore cillum adipisicing non", "schemaPath": "enim ut aliqua qui", "message": "sint labore in" } ], "created_by": "Pronghorn", "last_updated_by": null, "tasks": { "workflow_start": { "x": 62848999.91477686, "y": -86087485.78984313, "gridCoordinate": { "x": 64075044.7958872, "y": 84362185.38158542 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -14896843.490767479, "finish_state": "error", "user": "0124d01a520cc2afa905d75a" }, "groups": [ "default", "default" ], "iterations": [ "A15E882e-70Bd-FeF9-Af57-32815ECfee5D" ] }, "workflow_end": { "x": -72548187.2217312, "y": -75262695.60812801, "gridCoordinate": { "x": -71705545.6469653, "y": -73185287.42428198 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "e28f", "workflow_start", "workflow_start", "3a1f" ], "complete": [ "3a1f", "error_handler" ], "error": [ "error_handler", "error_handler", "workflow_end", "workflow_end", "error_handler" ] }, "metrics": { "end_time": -81212237.99738422, "run_time": -54143636.4845544 }, "groups": [ "default" ], "iterations": [ "AbaAf44C-c5ea-eB1E-Cc7D-F3E89a60cDCE", "04583edd-f530-02FE-27FA-AabAfdEfDDfC" ] }, "error_handler": { "x": -25646278.901138693, "y": 3309505.430282831, "gridCoordinate": { "x": -29755363.6479436, "y": 73339662.09781787 }, "name": "childJob", "location": "Adapter", "locationType": "consequat commodo do", "app": "exercitation consequat", "canvasName": "dolor culpa mollit", "displayName": "culpa aute consequat", "summary": "nostrud", "description": "reprehenderit commodo", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/Q" }, { "type": "encryption", "pointer": "/D9d/aRf,K9bhB.B/~0/NSz-/~1" }, { "type": "encryption", "pointer": "/~0/~1/~1/RILEVLU.m8r/~0/~1/~0/ZBT+4/~1/~1/e" }, { "type": "encryption", "pointer": "/c-oDtFzTpw/~0/~0/~0/~1/IJ2/Lx9.LoEL/s" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "Ut reprehenderit cupidatat", "highlightString": "velit Lorem aute ullamco" } ], "status": "paused", "previous": { "incomplete": [ "e28f", "error_handler", "workflow_start", "workflow_end", "error_handler" ], "complete": [ "e28f", "e28f", "error_handler", "workflow_end" ], "error": [ "workflow_end", "3a1f", "e28f", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "incididunt", "start_time": "2016-10-20T03:47:33.185Z", "end_time": -84389363.59259124, "finish_state": "failure", "retrySettings": { "state": [ "error", "failure", "failure", "failure" ], "autoRetry": false, "limit": 21875714, "delay": 61780056, "count": 7782205, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", "default", "default", "b6fb8508cad92ac3b0fb049a" ], "iterations": [] }, "33c0": { "actor": "3a4eca3669e892c05b0c50db", "groups": [ "default", { "_id": "9ba11fbbbcf6f713b7ed372a", "provenance": "quis Excepteur in nulla exercitation", "name": "dolor velit mollit in", "description": "non eu adipisicing sed", "memberOf": [ { "groupId": "6c9e005c0e0593481dda2a0c", "aaaManaged": true }, { "groupId": "a1c0b7360587a034ac80bcd7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do id reprehenderit incididunt culpa" }, { "roleId": "nostrud dolore nisi sunt" } ], "inactive": true, "_meta": { "created": "1980-12-29T15:11:38.451Z", "updated": "2013-06-20T20:42:59.503Z", "migrationVersion": -13127618 } }, "83e1c68c74fddb525bedeb42", "default" ], "iterations": [ "D450E75e-8B14-FDD7-9e6C-D1e9BdD1aeeC", "B5AbD55F-C3Ad-04dc-610C-bF3706045F83", "Ae6F7aC6-063A-Bde2-8bCa-C8F5e5426fc4" ], "x": 13100032.96657461, "y": 64390622.331846595, "gridCoordinate": { "x": 64038707.42356452, "y": -81293575.7153495 }, "name": "Ut consequat dolore", "location": "Adapter", "locationType": null, "app": "qui commodo", "canvasName": "aute ut enim", "displayName": "amet minim quis", "summary": "sit", "description": "ut dolor ad aute id", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1" }, { "type": "encryption", "pointer": "/~1/wL/~1" }, { "type": "encryption", "pointer": "/~0/G/~1/Jy9Aoupx+/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/frEve/~0/~1/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "Excepteur amet", "highlightString": "ad officia et aliquip ex" }, { "key": "dolore consequat amet irure ex", "highlightString": "ut consectetur aliquip ea" } ], "status": "running", "previous": { "incomplete": [ "3a1f", "e28f" ], "complete": [ "workflow_start", "3a1f", "workflow_end", "error_handler" ], "error": [ "workflow_end", "3a1f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "e28f", "type": "revert" } ] }, "serverId": "non consectetur deserunt", "start_time": "1955-04-18T13:30:42.277Z", "end_time": 12771791.868661001, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "sunt ut qui labore enim" } }, "parent": { "job": "aliqua", "task": "exercitation dolore aute qui irure", "iteration": 40226552.56010291, "element": -17515581.937334985 }, "errorHandler": null, "groups": [ "1ed2657c2063a6b36ecd98bd", "ff9edbc53858a1d6bbceef68" ], "watchers": [ "Pronghorn", { "_id": "9a3f73d8ac7462c29e91adbe", "provenance": "exercitation sunt ut laborum", "username": "Lorem anim", "firstname": "dolor reprehenderit in aliquip", "memberOf": [ { "groupId": "23c10d58baec62adc6e9b484", "aaaManaged": false }, { "groupId": "f646256a2ebba348d2081cfc", "aaaManaged": true }, { "groupId": "2e0a25f7c7bcae9d8afcdcc3", "aaaManaged": true }, { "groupId": "da40e62b07595a155df9e6bb", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis et non Lorem minim" }, { "roleId": "anim ad" }, { "roleId": "voluptate eiusmod sint" } ], "inactive": true, "lastLogin": "2015-06-01T16:23:49.346Z", "_meta": { "created": "1973-04-15T18:38:56.142Z", "updated": "2022-06-10T07:40:43.874Z", "migrationVersion": 44167951 }, "email": "occaecat dolor qui nisi aliqua" } ], "metrics": { "start_time": -52166658.203670524, "progress": 0.5871588062103528, "end_time": -43947078.58256788, "user": null, "owner": "3b0a737b9097c6f50faca1c2" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }