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": "adipisicing non laboris nostrud", "options": { "description": "Example job description", "type": "automation", "groups": [ "dbfde220b5ad29166fe8ad08" ] } }
{ "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": "a586f299dd305b3e42c1a964", "uuid": "fb2e7051-afea-b945-b54b-35f4d2084693", "font_size": -29033686, "type": "resource:action", "created": "1985-07-19T06:11:27.37Z", "last_updated": "1970-05-03T06:02:02.039Z", "createdVersion": "8496570.3759299.038029378-1812.14858108.632037", "lastUpdatedVersion": "0285.80721209.07460", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -36778657, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 33651860.01450336, "sla": 19486656.43910022, "decorators": [ { "type": "encryption", "pointer": "/Sic6/~1/CtPSn+MI5fl/~1/~0/mx6-5ZzImPs/ddibcuVr" }, { "type": "encryption", "pointer": "/~1/~0/~0/~0/qz7C-w3cMi/gwwQXP0byAv/XgUl,Q3l9/DkRi/IrksWm/Yq.Y" }, { "type": "encryption", "pointer": "/~1/BsWvtaTh" }, { "type": "encryption", "pointer": "/~1/SHWuE/Bd8sN/yC9jVXAyM/~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_end", "name": "myCoolDocumentName", "message": "magna labore ut" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "nisi consectetur in Excepteur" } ], "ancestors": [ "41bdd5d1dff4c1f10ff68d25", "5657661e7254ff783cabc18e", "b12329820d84c1b4d665dcd6" ], "validationErrors": [ { "keyword": "quis in et eiusmod", "instancePath": "ullamco ea", "schemaPath": "eiusmod ullamco Excepteur id ex", "message": "aliqua" }, { "keyword": "enim sed irure labore", "instancePath": "sit deserunt", "schemaPath": "in cupidatat dolor dolor", "message": "esse ad quis" }, { "keyword": "in aute anim ipsum", "instancePath": "culpa exercitation commodo sed enim", "schemaPath": "eu est ullamco", "message": "Duis labore" }, { "keyword": "sit ex", "instancePath": "irure ea", "schemaPath": "in", "message": "fugiat est Ut" }, { "keyword": "aliqua culpa in", "instancePath": "consequat consectetur", "schemaPath": "nostrud Lorem aute", "message": "sit velit" } ], "created_by": "63b3076b7d23a5fea419cae2", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 62280170.94983739, "y": 16482878.966871351, "gridCoordinate": { "x": 18425371.0790312, "y": 99326123.74405253 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -39440798.30898972, "finish_state": "error", "user": "848fb15d8d22c35124de4e74" }, "groups": [ { "_id": "7c7c01b195309343b4b3fa16", "provenance": "in dolore", "name": "irure ea aliqua commodo", "description": "ut reprehenderit consequat", "memberOf": [ { "groupId": "8df1ff58f01d1ccfc62ca1c9", "aaaManaged": false }, { "groupId": "03e4d88b0e889c6481467f8f", "aaaManaged": false }, { "groupId": "a8df62294ab5764959e3a4c6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat nulla" } ], "inactive": false, "_meta": { "created": "1950-07-13T12:53:25.3Z", "updated": "2010-01-03T02:32:49.322Z", "migrationVersion": -46033942 } } ], "iterations": [ "71162940-cED2-A2cA-E9D4-BB85Df9F357a", "b63Cd78A-C4b3-4703-C54e-de9aD8c8F8ff", "6DabaB5d-5eC4-7949-6b7e-7d3a2F47298E" ] }, "workflow_end": { "x": 18832019.998277888, "y": -88354401.33997707, "gridCoordinate": { "x": -99586824.26856372, "y": -55268794.677765995 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_end", "e28f", "error_handler" ], "complete": [ "workflow_start", "workflow_end", "workflow_start", "workflow_end", "e28f" ], "error": [ "workflow_start", "workflow_start", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 84389414.65926543, "run_time": 4480306.378712088 }, "groups": [ "default" ], "iterations": [ "3Aea703f-AF6B-C3ee-AdF6-d43EEb08aE6F", "D8cfd976-A7d5-820a-95Cf-4aDAb41AF6fF", "893f21Cf-0464-0459-5ee2-7b91Bc817A11" ] }, "error_handler": { "x": -57098503.69695699, "y": -92456521.66501772, "gridCoordinate": { "x": 96628185.73824742, "y": 23890421.38704008 }, "name": "childJob", "location": "Broker", "locationType": "tempor Lorem qui sint", "app": "pariatur nostrud ullamco id sit", "canvasName": "ut", "displayName": "reprehenderit nostrud mollit eu", "summary": "laborum Lorem velit consequat consectetur", "description": "nulla irure consequat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/O/rMp3xUpy9/JbiuG/ZmGTTO/~0" }, { "type": "encryption", "pointer": "/SJC+Kcoe/~1/~1/~0/OMiVg/~0/J,1Ntk/rn" }, { "type": "encryption", "pointer": "/AXj/aF7-W/~1/LdY-rF/yUI/s/~0/~1/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "nulla tempor et fugiat ut", "highlightString": "dolore in in Duis deserunt" }, { "key": "aute ullamco", "highlightString": "ea consequat proident" }, { "key": "esse", "highlightString": "sit commodo" }, { "key": "consectetur sint minim adipisicing", "highlightString": "tempor nulla amet" }, { "key": "quis incididunt dolore eu", "highlightString": "ullamco pariatur velit mollit dolore" } ], "status": "error", "previous": { "incomplete": [ "3a1f", "workflow_end", "e28f" ], "complete": [ "workflow_start" ], "error": [ "3a1f", "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "laboris aliqua cupidatat anim sint", "start_time": "2022-04-05T01:10:47.619Z", "end_time": -57674292.41829305, "finish_state": "success", "retrySettings": { "state": [ "error", "failure" ], "autoRetry": true, "limit": 77753363, "delay": 33811538, "count": 72459175, "finishedRetrying": true }, "type": "operation", "actor": { "_id": "b3dc7514049dba1b5e063d8c", "provenance": "dolor anim eiusmod commodo ad", "username": "laboris Excepteur officia tempor", "firstname": "velit nisi", "memberOf": [ { "groupId": "a2d405019591e91c1ff9b553", "aaaManaged": false }, { "groupId": "9c381b24cce14bba3c29007b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud cupidatat minim adipisicing incididunt" }, { "roleId": "amet sunt laboris" }, { "roleId": "sit eu" }, { "roleId": "in voluptate aliquip ipsum est" }, { "roleId": "sit" } ], "inactive": true, "lastLogin": "1986-07-15T21:05:55.146Z", "_meta": { "created": "2015-11-24T03:12:44.588Z", "updated": "2007-06-09T05:01:22.437Z", "migrationVersion": -52713702 }, "email": "qui incididunt tempor" }, "groups": [ "bc4e1b3f2e8657e8a99cfd50", { "_id": "051d603b5123c54dfa7758bd", "provenance": "enim aliqua ea id", "name": "irure non id", "description": "nisi", "memberOf": [ { "groupId": "0d07bf4e454654c64ca78575", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit Ut est do" }, { "roleId": "occaecat exercitation ut adipisicing" }, { "roleId": "veniam commodo ullamco" }, { "roleId": "non laboris do cupidatat eiusmod" }, { "roleId": "tempor" } ], "inactive": true, "_meta": { "created": "1964-01-21T19:50:12.238Z", "updated": "1971-02-15T06:56:45.574Z", "migrationVersion": -2979944 } }, "2eaf11a3f5c9d6ca3eb30304", "default", "default" ], "iterations": [ "d8A898CB-7eCa-cf52-E7de-FD8cd3370BC8" ] }, "07": { "actor": null, "groups": [ "default", { "_id": "42064fbc1c4434b4967f34f0", "provenance": "Excepteur Duis velit Lorem adipisicing", "name": "labore ad adipisicing", "description": "pariatur", "memberOf": [ { "groupId": "89233d6498f7e6d58bf43801", "aaaManaged": false }, { "groupId": "8e14cfa0563d545fe14b5996", "aaaManaged": true }, { "groupId": "f36f13fa8288f199627da348", "aaaManaged": true }, { "groupId": "eebd6dad187878ee5cca54de", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur Ut consectetur sunt" }, { "roleId": "adipisicing minim" } ], "inactive": true, "_meta": { "created": "1955-03-15T18:39:02.791Z", "updated": "2017-05-29T16:59:15.781Z", "migrationVersion": 89733960 } }, { "_id": "10a34d9056018d3788da287e", "provenance": "aliqua nostrud eu", "name": "aliquip est consectetur culpa veniam", "description": "quis fugiat cillum Duis esse", "memberOf": [ { "groupId": "b31c3aacd2f6c5c118569477", "aaaManaged": false }, { "groupId": "c1e2303e32af680b1144ff05", "aaaManaged": true }, { "groupId": "4a231ccc1e18b60df99c9f1a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum dolore" }, { "roleId": "irure eiusmod fugiat pariatur" }, { "roleId": "ea" } ], "inactive": true, "_meta": { "created": "2016-04-05T17:42:06.904Z", "updated": "1975-10-25T10:21:51.15Z", "migrationVersion": -65281926 } }, { "_id": "bf9be7395b9ac86b51d85922", "provenance": "amet aute labore tempor", "name": "nulla pariatur", "description": "est culpa", "memberOf": [ { "groupId": "d57eaaf5bf97a8a0ce130b96", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "enim velit Excepteur" }, { "roleId": "dolor in" } ], "inactive": true, "_meta": { "created": "2002-10-25T16:11:05.337Z", "updated": "1955-05-17T02:45:38.001Z", "migrationVersion": 22876149 } }, "default" ], "iterations": [ "BfF7a9f1-4a2b-c49d-8A2b-bd72AA7C818d" ], "x": -39050755.23517438, "y": 40659136.75489798, "gridCoordinate": { "x": 45524595.29390073, "y": 52953521.00081864 }, "name": "pending", "summary": "sit", "description": "sed" } }, "parent": { "job": "culpa nisi occaecat cillum Lorem", "task": "do cupidatat aliquip", "iteration": 39518889.22632313, "element": 23293543.107290387 }, "errorHandler": null, "groups": [ "6453cb524b35d54d17acae14", { "_id": "e113ecf407754b4844b52ed3", "provenance": "aute irure officia fugiat nisi", "name": "ut pariatur exercitation", "description": "pariatur amet incididunt", "memberOf": [ { "groupId": "a94eea987c9c826a46428d8a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident incididunt laborum pariatur" }, { "roleId": "ut deserunt aliqua proident" }, { "roleId": "consectetur" } ], "inactive": true, "_meta": { "created": "1975-06-07T08:42:57.488Z", "updated": "2012-04-28T13:50:39.552Z", "migrationVersion": -27666454 } }, { "_id": "844cd729d69441e54870d672", "provenance": "sit mollit", "name": "sunt ipsum irure", "description": "sed Ut id laboris", "memberOf": [ { "groupId": "ddb79cfc6ec2031eb9f4ae66", "aaaManaged": false }, { "groupId": "89cb90b2e8af041787474a3b", "aaaManaged": false }, { "groupId": "3e872145ab7b455a27d0626c", "aaaManaged": true }, { "groupId": "61f08ae683331855752c75fa", "aaaManaged": false }, { "groupId": "7888a4cdb641007e89491790", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat occaecat quis eu" } ], "inactive": true, "_meta": { "created": "1998-09-23T11:38:28.115Z", "updated": "1948-09-28T16:02:05.232Z", "migrationVersion": 27890993 } }, { "_id": "0702d77b6c2f29634dab3818", "provenance": "in irure dolor ipsum", "name": "dolor in in sint", "description": "voluptate aute consequat", "memberOf": [ { "groupId": "31d69f7b23993139096a3259", "aaaManaged": true }, { "groupId": "4768d22a41b00f6bffa2f027", "aaaManaged": false }, { "groupId": "3c8ca1e316a0c9886cf53e0f", "aaaManaged": false }, { "groupId": "6611101840c64dc41ffd4b1a", "aaaManaged": false }, { "groupId": "3d2ececc6cc15f2db9648916", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa nulla eu tempor" } ], "inactive": false, "_meta": { "created": "1998-04-14T20:15:45.75Z", "updated": "1955-06-01T16:48:38.94Z", "migrationVersion": -5390937 } }, { "_id": "55a6b66d29f2c6c973739358", "provenance": "ullamco officia consectetur sit pariatur", "name": "pariatur occaecat", "description": "magna dolore est enim", "memberOf": [ { "groupId": "686e9a9d344ed664efcaba3f", "aaaManaged": false }, { "groupId": "e51c2af64532b9518ba9eb6b", "aaaManaged": true }, { "groupId": "6c0796288a31c7cd08c284e3", "aaaManaged": true }, { "groupId": "a2c3432ff71c7233adbc51d6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis" }, { "roleId": "in" }, { "roleId": "occaecat qui" }, { "roleId": "consequat sint Ut" }, { "roleId": "nostrud sed ut veniam anim" } ], "inactive": true, "_meta": { "created": "1966-04-07T15:03:46.652Z", "updated": "2007-01-27T12:46:38.082Z", "migrationVersion": -39088445 } } ], "watchers": [ null, "Pronghorn", "f81f25c0e2421a86b87a3db3", { "_id": "3e84e9a8e00652bca0b3d8ec", "provenance": "tempor sed ad", "username": "esse ut consequat deserunt", "firstname": "consequat aute dolor", "memberOf": [ { "groupId": "25084d9392ddb9afb33ed764", "aaaManaged": false }, { "groupId": "6b9a6e4de689d83f793d6dea", "aaaManaged": true }, { "groupId": "b2f2486c5aa4f02306ef5a6f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit ad" }, { "roleId": "tempor qui aute consequat Excepteur" } ], "inactive": false, "lastLogin": "1964-02-17T18:44:37.385Z", "_meta": { "created": "2001-06-06T04:41:14.807Z", "updated": "1983-07-09T20:44:49.883Z", "migrationVersion": 15316614 }, "email": "aute veniam" } ], "metrics": { "start_time": -90186675.7443511, "progress": 0.0068859324012089385, "end_time": -88384747.17232549, "user": { "_id": "230c886c800c3e1ea72aa7a7", "provenance": "nisi cupidatat", "username": "proident elit", "firstname": "ex magna aliqua ipsum", "memberOf": [ { "groupId": "44b7f06b03a973666b5526e3", "aaaManaged": false }, { "groupId": "6639e859cc494bec34f202cb", "aaaManaged": true }, { "groupId": "ba594d96932a19c8fee25276", "aaaManaged": false }, { "groupId": "40d576a0e54624b06b40d454", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat ex" }, { "roleId": "cupidatat" }, { "roleId": "deserunt minim voluptate" } ], "inactive": false, "lastLogin": "1947-11-11T00:29:07.205Z", "_meta": { "created": "2013-04-11T20:10:15.209Z", "updated": "1988-09-11T21:34:14.823Z", "migrationVersion": -97984449 }, "email": "minim" }, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }