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": "eu ex non velit", "options": { "description": "Example job description", "type": "automation", "groups": [ "05bc9135af9898ff129ddb36" ] } }
{ "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 imported 3 of 4 documents", "data": { "_id": "b111d48d47c54e4a9be1f686", "uuid": "b59ebac9-1ca9-2ce9-c239-999424ab02f2", "font_size": 5917986, "type": "resource:action", "created": "2010-07-15T08:01:41.382Z", "last_updated": "1952-10-15T23:57:58.932Z", "createdVersion": "588.4075206.65368790-5299.348736.34.46146", "lastUpdatedVersion": "35.6847.70-9802.1138301823.637668.86", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 24889520, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 53907276.99336195, "sla": 18486895.50723432, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/S" }, { "type": "encryption", "pointer": "/~0/d0d/XxGGKMKWwD/~1/B" }, { "type": "encryption", "pointer": "/yEnn/~1/EmarK047ct0/my2MpHEUnq/HwLrF/e3f/~0" } ], "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": "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": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "irure reprehenderit pariatur dolor sit", "instancePath": "nostrud aliquip", "schemaPath": "adipisicing dolor exercitation ad quis", "message": "ipsum" }, { "keyword": "eu Duis ex", "instancePath": "consectetur sint", "schemaPath": "enim magna dolor commodo ullamco", "message": "quis minim sed deserunt pariatur" }, { "keyword": "Duis ullamco enim", "instancePath": "et reprehenderit sit dolor anim", "schemaPath": "velit amet fugiat", "message": "quis" }, { "keyword": "ullamco quis enim ut consequat", "instancePath": "laboris culpa deserunt aute fugiat", "schemaPath": "sint", "message": "adipisicing occaecat esse officia incididunt" } ], "created_by": { "_id": "db0773cc27be9316be010832", "provenance": "elit veniam irure", "username": "velit nulla quis adipisicing laborum", "firstname": "incididunt Duis", "memberOf": [ { "groupId": "33429406a577189ed59089c2", "aaaManaged": false }, { "groupId": "5afa89fb5a823803525ac9fa", "aaaManaged": false }, { "groupId": "ef9a95e301424f13f3124aec", "aaaManaged": true }, { "groupId": "5dcc89593918bfb1eb63a4f8", "aaaManaged": false }, { "groupId": "e156d256398a36e012347f76", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit et sunt incididunt" }, { "roleId": "proident cupidatat sunt ad esse" } ], "inactive": false, "lastLogin": "1983-09-17T07:25:11.27Z", "_meta": { "created": "2008-05-21T15:19:25.037Z", "updated": "1958-06-26T06:32:56.175Z", "migrationVersion": 11668031 }, "email": "nulla" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 17802068.06101176, "y": 63954508.193702966, "gridCoordinate": { "x": -68140903.04139304, "y": 46693617.04944414 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 40671271.43178579, "finish_state": "error", "user": "Pronghorn" }, "groups": [ "default", "default", "5694b37cfedef7e29b3c2f57" ], "iterations": [] }, "workflow_end": { "x": -67324257.72238106, "y": -91461955.36343397, "gridCoordinate": { "x": 10462117.968585268, "y": -61104763.45910496 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_end", "workflow_start", "e28f", "workflow_end" ], "complete": [ "workflow_start", "error_handler", "e28f", "error_handler", "workflow_start" ], "error": [ "e28f" ] }, "metrics": { "end_time": 15478886.73342812, "run_time": -50027616.72287237 }, "groups": [ "93292b738841076c9710017e", "caa8b9b95bd64f6218bb8ea0", "default", "7797cd6b3b540db53c77464e" ], "iterations": [ "3Bf9A2f9-0769-C58E-D597-0f2E9B8bbc72", "EEaBaEcD-3FB7-5d85-f8de-afF7B7c35ef7" ] }, "error_handler": { "x": 9605150.06679912, "y": 24564681.159504652, "gridCoordinate": { "x": 94184131.13346505, "y": -54007851.882463954 }, "name": "childJob", "location": "Application", "locationType": null, "app": "do nisi", "canvasName": "enim do", "displayName": "aliquip labore", "summary": "eiusmod dolore occaecat elit", "description": "laborum reprehenderit ad dolor proident", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/SNAslXf" }, { "type": "encryption", "pointer": "/w./~0/a2j54mHGt/~1/V/ZiJP/K/~1/~0/~1/w" }, { "type": "encryption", "pointer": "/~1/ZUCSqfxak2-/s/d,LhbQ" }, { "type": "encryption", "pointer": "/~1/~1/VL/~1/~0/Wb23zR3e/TA2e" }, { "type": "encryption", "pointer": "/SBeDsK6k2i/~1/~0/nE4lQIP/b7Gh3u/~0/Pznoim8" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "proident nostrud occaecat fugiat in", "highlightString": "do ipsum dolor" }, { "key": "incididunt consequat", "highlightString": "sed in" } ], "status": "running", "previous": { "incomplete": [ "error_handler", "3a1f" ], "complete": [ "workflow_start", "e28f" ], "error": [ "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "occaecat cupidatat veniam", "start_time": "1963-02-11T10:08:01.54Z", "end_time": -32426520.253989637, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "60ce7f9597861808fe3de2c7", "groups": [ "default", "default", { "_id": "d45a75a72b14840513fbb2bb", "provenance": "elit quis tempor", "name": "aliqua voluptate ullamco nostrud adipisicing", "description": "ullamco eiusmod aliqua", "memberOf": [ { "groupId": "e9871b0cba68a5cf011482f3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum" }, { "roleId": "minim" }, { "roleId": "ut" }, { "roleId": "in" }, { "roleId": "sed veniam Duis" } ], "inactive": true, "_meta": { "created": "1999-05-03T12:22:37.2Z", "updated": "2016-07-08T23:15:56.426Z", "migrationVersion": 94821065 } }, { "_id": "e1ce1fda04f3092350912a36", "provenance": "consequat officia minim", "name": "ullamco nostrud cillum labore", "description": "tempor Excepteur in", "memberOf": [ { "groupId": "975a8cd137581f562d23a49c", "aaaManaged": false }, { "groupId": "119b219f211fee9386db54cd", "aaaManaged": true }, { "groupId": "ec6e3bd80fd097ca8b70af00", "aaaManaged": true }, { "groupId": "763c03b8ac1d30ecf3c3a3b3", "aaaManaged": false }, { "groupId": "14e0bddac506af518ffe3047", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum" }, { "roleId": "esse velit veniam consequat" }, { "roleId": "in exercitation laborum culpa dolor" }, { "roleId": "et dolore mollit" } ], "inactive": true, "_meta": { "created": "1957-12-17T01:47:50.329Z", "updated": "1973-11-06T17:10:17.11Z", "migrationVersion": 85085358 } }, "default" ], "iterations": [ "D0e8DAE4-8D92-cD8C-3e6B-cd4c5264D545" ] }, "9c48": { "actor": "job", "groups": [ "default" ], "iterations": [ "3e24d2b0-eBFC-aEd5-A202-5daeFbEbBdAE" ], "x": -56836886.68502001, "y": -39756086.38887627, "gridCoordinate": { "x": 20783074.732310027, "y": -20357326.54322593 }, "name": "nulla anim", "location": "Broker", "locationType": "et aliqua mollit incididunt fugiat", "app": "nisi", "canvasName": "velit in", "displayName": "commodo ut incididunt", "summary": "nulla", "description": "dolor elit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/BsdWNTyC/~0/~1/~1/idNGC" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "Lorem et dolor nulla", "highlightString": "minim proident sunt" }, { "key": "esse minim consequat aliqua magna", "highlightString": "sed eiusmod consequat" }, { "key": "enim", "highlightString": "pariatur aliqua elit id nostrud" }, { "key": "est anim ex culpa", "highlightString": "cupidatat cillum sit aliqua" } ], "status": "error", "previous": { "incomplete": [ "workflow_end", "workflow_end" ], "complete": [ "e28f", "e28f", "workflow_start", "3a1f" ], "error": [ "workflow_start", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "laboris deserunt", "start_time": "1956-08-23T13:08:52.709Z", "end_time": 38218443.65837893, "finish_state": "failure", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 68075455, "delay": 83559735, "count": 89357491, "finishedRetrying": true }, "type": "manual", "view": "laboris voluptate" } }, "parent": { "job": "proident dolore occaecat", "task": "tempor ad", "iteration": 72618461.59610602, "element": 13931438.360621989 }, "errorHandler": null, "groups": [ { "_id": "d8b6916ee608895dff6d423c", "provenance": "dolor eiusmod in", "name": "ad laborum anim sit laboris", "description": "mollit officia dolore minim aliquip", "memberOf": [ { "groupId": "8718c1d37c5f3f88382c2996", "aaaManaged": true }, { "groupId": "acd3e2091b41315dbfd87249", "aaaManaged": false }, { "groupId": "7f7cef559658d3fa0269c431", "aaaManaged": true }, { "groupId": "015b2c76482a38879c1765e3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit" } ], "inactive": true, "_meta": { "created": "1999-12-01T14:08:30.994Z", "updated": "2015-07-01T16:38:46.917Z", "migrationVersion": -13790033 } } ], "watchers": [ "Pronghorn", null ], "metrics": { "start_time": 52805859.161771625, "progress": 0.25889137423974073, "end_time": -53132278.26990565, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }