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": "deserunt in Ut dolore", "options": { "description": "Example job description", "type": "automation", "groups": [ "24528708212f5a84a5cebb1f", "f21486856eff0be7813b5295", "ff8b9f11fc0ef25315b77641", "5093e0fbdd0beba1c528249b", "35ef8a2b4c0a95fbc07ca47a" ] } }
{ "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": "52a383879369f06b82bde6a8", "font_size": 44874778, "type": "resource:action", "created": "1947-12-22T02:44:06.621Z", "last_updated": "1973-03-03T12:04:40.587Z", "createdVersion": "98544.1577565119.17304346133-5944.589.5145171851", "lastUpdatedVersion": "27011331334.3669090248.730", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -41858525, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 88798531.79647094, "sla": 42393963.85075879, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/~0/N-W8MjiVylF" } ], "status": "running", "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": "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": "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": "workflow_end", "name": "myCoolDocumentName", "message": "officia laborum eu anim labore" } ], "ancestors": null, "validationErrors": [ { "keyword": "proident qui nulla", "dataPath": "laboris mollit incididunt eiusmod", "schemaPath": "et sed consectetur in", "message": "qui eiusmod magna cupidatat do" }, { "keyword": "cupidatat consectetur eiusmod tempor aliqua", "dataPath": "laboris veniam labore elit", "schemaPath": "elit ipsum cupidatat in ea", "message": "anim irure" }, { "keyword": "ad nostrud tempor", "dataPath": "anim in ut", "schemaPath": "voluptate", "message": "elit enim irure consectetur ut" } ], "created_by": null, "last_updated_by": { "_id": "eeabaa9ac1b6a1905973f008", "provenance": "et ex sunt", "username": "irure esse Lorem incididunt cillum", "firstname": "elit", "memberOf": [ { "groupId": "66dcde4ce8cf6cad5eb1a7b3", "aaaManaged": true }, { "groupId": "005b6cf944ebb63fe1c1b266", "aaaManaged": false }, { "groupId": "9b3d8416cee8ac71b8b63de5", "aaaManaged": true }, { "groupId": "fa4f63f53aee64e0d385e276", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa Duis" }, { "roleId": "reprehenderit ut ullamco labore ut" }, { "roleId": "non pariatur" }, { "roleId": "Lorem dolor" }, { "roleId": "et irure ut do dolore" } ], "inactive": true, "lastLogin": "1963-06-01T22:10:56.592Z", "_meta": { "created": "2025-03-02T20:45:04.987Z", "updated": "2020-07-31T03:45:15.87Z", "migrationVersion": 57748219 }, "email": "cupidatat aliqua nisi elit sed" }, "tasks": { "798": { "actor": "$var.job.RnI4", "groups": [ "1d31c11c6da0dedeb21ddccb" ], "iterations": [ "fCb4b7DB-5cBb-64Df-D038-D0f30cc1CD6c", "8E697eDC-e53A-172a-AC59-d1eD3AeE524F" ], "x": -7541014.793484151, "y": 69064659.29926723, "gridCoordinate": { "x": -79508539.8044534, "y": 17204010.20242615 }, "name": "non in et culpa minim", "location": "Application", "locationType": "quis proident consectetur", "app": "dolore officia", "canvasName": "laboris aliqua eiusmod", "displayName": "non exercitation", "summary": "in ut ad pariatur nostrud", "description": "aliquip minim magna eu", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/YV/nSk/UV/~0/U1nm5x/Y/ny" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "officia adipisicing magna labore ex", "highlightString": "nulla enim" }, { "key": "culpa voluptate Duis laboris", "highlightString": "ad" } ], "status": "incomplete", "previous": { "incomplete": [ "error_handler", "workflow_start", "e28f", "3a1f", "3a1f" ], "complete": [ "e28f", "error_handler" ], "error": [ "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ] }, "serverId": "elit deserunt dolor incididunt ex", "start_time": "1980-12-21T08:39:24.564Z", "end_time": -22819421.941447884, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "workflow_start": { "x": 65652511.29248378, "y": 5537853.797130406, "gridCoordinate": { "x": 77238308.58164275, "y": -47969452.80270055 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -24226108.54110898, "finish_state": "failure", "user": { "_id": "03bb6cb585cf0e80b59d9523", "provenance": "minim enim consequat irure", "username": "do", "firstname": "elit nisi", "memberOf": [ { "groupId": "0226c2902887d0f1bbde7d68", "aaaManaged": false }, { "groupId": "b2513a8347102a45b7f1bf55", "aaaManaged": false }, { "groupId": "b18c54bb41eaea00c16df650", "aaaManaged": true }, { "groupId": "6915bfbd569fab9d424fc6e0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut pariatur amet officia" }, { "roleId": "labore commodo quis sunt" }, { "roleId": "fugiat aliquip amet ut nisi" }, { "roleId": "adipisicing sit" } ], "inactive": false, "lastLogin": "1984-04-16T17:23:18.141Z", "_meta": { "created": "1989-09-20T12:02:03.782Z", "updated": "2012-02-16T23:47:18.861Z", "migrationVersion": 43754170 }, "email": "ullamco" } }, "groups": [ "d0695112125c0e2ca08389b7" ], "iterations": [ "7b2A14AF-Cdf5-fa5a-6C16-BB1f4C07AB21" ] }, "workflow_end": { "x": -14163660.461393863, "y": 36309870.37354082, "gridCoordinate": { "x": -1832256.146066323, "y": 36323496.34035 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "error_handler" ], "complete": [ "e28f" ], "error": [ "3a1f", "3a1f" ] }, "metrics": { "end_time": 77757435.30670556, "run_time": 4891515.923127353 }, "groups": [ "default", "2741950e1dd87378b00d3de2", "11e42294ee07ee780143d07f" ], "iterations": [ "cCC4e9E1-b04C-88E6-cc4A-a9D645c0ea42", "6cbfeEfb-14a6-3E10-371B-7BDcbF8b99Ba" ] }, "error_handler": { "x": -72280821.58392328, "y": 10768914.361994937, "gridCoordinate": { "x": -30516760.802865893, "y": 72557527.33638436 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "ad fugiat sint esse", "canvasName": "qui", "displayName": "consequat dolore pariatur ut", "summary": "Excepteur ex Lorem", "description": "eiusmod in Duis exercitation in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/u/VpQn5vn./~1/e,lO" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/fHwB/Me/~0/NzgQEVtVX/~0/jOKDy//QZN//~1/~1/~1/tEfkajHFv" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "do", "highlightString": "ipsum" }, { "key": "dolore laborum sint", "highlightString": "nisi" }, { "key": "dolor elit", "highlightString": "et incididunt" } ], "status": "error", "previous": { "incomplete": [ "e28f", "workflow_end", "e28f", "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "e28f" ], "error": [ "error_handler", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "et aliquip officia eiusmod", "start_time": "1971-04-13T17:53:41.914Z", "end_time": 96096805.26410371, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "14ac7800a006cdf48ff1c216", "default", "21d19c708a7884aafdd71867", "46a7e98665a405c2ab5ed72c", "bded73fdf2be696c75ffda47" ], "iterations": [] } }, "parent": { "job": "labore est pariatur proident dolore", "task": "ipsum Duis proident eu", "iteration": -99072577.33138071, "element": -95198420.95162971 }, "errorHandler": { "actor": "$var.job.zZveqsbvRor", "groups": [ "default" ], "iterations": [], "x": -52750758.93622767, "y": 64164770.60441625, "gridCoordinate": { "x": -63091149.47205341, "y": 59292034.46787733 }, "name": "et irure esse deserunt veniam", "location": "Application", "locationType": "eu proident ad nisi occaecat", "app": "non Ut", "canvasName": "ipsum sint laborum ut", "displayName": "tempor", "summary": "incididunt", "description": "ea", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/qLJvG/aJ//C8j/~1/nyci4x/H-6.CEJOVW/V.x01tkBJUr/tbJ/~0" }, { "type": "encryption", "pointer": "/~0/~1/~1/sXV/-h,GM/ny-hS/r68YtJ/~0/~0/~0/cFv6/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "amet", "highlightString": "eu dolor enim" }, { "key": "exercitation commodo", "highlightString": "tempor in dolor consectetur" }, { "key": "dolore mollit minim dolore", "highlightString": "irure" }, { "key": "labore", "highlightString": "ex exercitation dolor" }, { "key": "ad enim", "highlightString": "dolore culpa cupidatat laborum id" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_end", "workflow_end", "e28f", "e28f", "workflow_end" ], "complete": [ "error_handler", "workflow_start", "workflow_start" ], "error": [ "error_handler", "e28f", "e28f", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "mollit", "start_time": "1948-03-17T18:50:54.177Z", "end_time": -14774241.679020956, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "groups": [ "default", "default" ], "watchers": [ "c1640b8e4aced1fab0613712", "Pronghorn" ], "metrics": { "start_time": -46675568.6663821, "progress": 0.5198069109639745, "end_time": -10096986.486741915, "user": { "_id": "d14120dbe17606ae4f9c4e80", "provenance": "et fugiat minim dolor", "username": "quis mollit ex dolore", "firstname": "nisi id", "memberOf": [ { "groupId": "29c84e32eab296155a87ccae", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure" } ], "inactive": true, "lastLogin": "2003-06-09T21:45:16.808Z", "_meta": { "created": "2012-09-16T03:51:57.799Z", "updated": "1953-05-02T14:16:04.543Z", "migrationVersion": -84171418 }, "email": "nulla mollit elit consequat" }, "owner": "928529afbbeb4a4ff80ade9a" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }