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": "exercitation fugiat esse irure", "options": { "description": "Example job description", "type": "automation", "groups": [ "63690046efc3c7f34705f4f0", "ddd80324b1905bcb6e0c8656", "754b69af031e367436b9466f", "16c0cf72147fb5e968468649", "6721139565cbc6fe5dbf17fd" ] } }
{ "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": "51adcba4efe5d156e4af425f", "font_size": 90713590, "type": "resource:compliance", "created": "1982-02-08T00:44:04.501Z", "last_updated": "1995-02-12T19:18:47.875Z", "createdVersion": "490.492366179.383842321-3742.83482415422.98924637.5", "lastUpdatedVersion": "99541.7.32-1276.060594922.914538717", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 48944070, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -20534902.559819162, "sla": 18865398.945916966, "decorators": [ { "type": "encryption", "pointer": "/~0/Lhj36/e/gSgs/Lk/~1/XpxyaNJ/~0/Ibv/QM.rfaq/~1" }, { "type": "encryption", "pointer": "/dIq9feBEPB/~1/~0/~0/Uax06-+K/tfi" }, { "type": "encryption", "pointer": "/~0/yJrpP.F5VC9/qW,ToX/~1/~0/qC2/~0/pp7DwI1C/~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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName", "message": "enim" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "dolor fugiat laborum deserunt" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "enim officia" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "ipsum velit id nisi ad" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "non labore Excepteur ea" } ], "ancestors": [ "974053c1042a946f14c4a7a6", "502097fb00e0b181a18d236c" ], "validationErrors": [ { "keyword": "est in sunt in exercitation", "instancePath": "reprehenderit enim irure in", "schemaPath": "ullamco adipisicing Excepteur ad minim", "message": "sit dolore" }, { "keyword": "Ut aute esse dolore dolore", "instancePath": "do", "schemaPath": "deserunt occaecat cillum qui", "message": "esse id consequat" }, { "keyword": "qui sint incididunt sed", "instancePath": "sed sunt ad qui", "schemaPath": "dolor Excepteur", "message": "mollit sunt irure" }, { "keyword": "aliquip tempor", "instancePath": "labore sint nostrud in aute", "schemaPath": "in ut voluptate est cupidatat", "message": "nostrud laboris" } ], "created_by": "Pronghorn", "last_updated_by": "c4f477a60e2cbe989f26509b", "tasks": { "workflow_start": { "x": -75595912.65337886, "y": 73968380.96748936, "gridCoordinate": { "x": 44282454.56337923, "y": -28563406.076919854 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 60511936.53353688, "finish_state": "success", "user": "7320780867015e8f20845d9d" }, "groups": [ { "_id": "b39dd83d5c4fc9fc27c1a955", "provenance": "in officia et consectetur", "name": "commodo quis ullamco et laborum", "description": "sed", "memberOf": [ { "groupId": "1fbe19e97cf1b21dc2cfdbe4", "aaaManaged": true }, { "groupId": "40e77851f2f2aa1e08b645d8", "aaaManaged": true }, { "groupId": "a85d94cf57e94813cd47a6fd", "aaaManaged": true }, { "groupId": "7c325f2c6680495185d22888", "aaaManaged": true }, { "groupId": "4b9c55440f49de39da03f70e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod sunt ad est sint" }, { "roleId": "mollit cillum culpa" }, { "roleId": "laboris quis dolore pariatur" }, { "roleId": "sint dolor" } ], "inactive": false, "_meta": { "created": "1947-12-02T11:37:58.506Z", "updated": "2021-11-05T10:37:29.231Z", "migrationVersion": 22183598 } }, "e8a2a68a5fa194919dd61270", "default", "default" ], "iterations": [] }, "workflow_end": { "x": 56802274.134587675, "y": 16283022.599113822, "gridCoordinate": { "x": 7491499.467973828, "y": -8504267.383327633 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "3a1f", "3a1f", "workflow_end", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "error_handler", "workflow_start", "3a1f", "workflow_start" ] }, "metrics": { "end_time": 47523038.98146227, "run_time": 55741414.76184419 }, "groups": [ { "_id": "6596dcf624d5a38da798f453", "provenance": "consequat in", "name": "enim ad", "description": "sunt Lorem sit aliqua in", "memberOf": [ { "groupId": "604ba73f45dc8779616312f3", "aaaManaged": true }, { "groupId": "02fd2193f29e3d5c09ac9f4c", "aaaManaged": false }, { "groupId": "b0008e4d4956b24f316e6ca1", "aaaManaged": false }, { "groupId": "dbef3eccca48ca0bc52a944f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum adipisicing enim quis aliquip" }, { "roleId": "adipisicing Duis dolore sit aliqua" }, { "roleId": "do nostrud" }, { "roleId": "ipsum et est quis" }, { "roleId": "incididunt laboris" } ], "inactive": true, "_meta": { "created": "1964-08-05T00:22:54.804Z", "updated": "1997-08-23T14:33:36.686Z", "migrationVersion": -48822673 } }, "35f6ab2a843bb9df955ab475", { "_id": "d1681462e11b90002852382b", "provenance": "irure laborum qui ut Duis", "name": "est adipisicing id", "description": "elit est occaecat in", "memberOf": [ { "groupId": "8109ae802c1069ca0dd09bac", "aaaManaged": false }, { "groupId": "e5028751b4322150bf8c47d3", "aaaManaged": true }, { "groupId": "179f1886c702ffd01b683d88", "aaaManaged": false }, { "groupId": "e28374023736bd4e5912745c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim proident aliqua consequat occaecat" }, { "roleId": "laboris pariatur consectetur amet" }, { "roleId": "officia dolor Lorem aliqua proident" }, { "roleId": "ullamco proident nulla dolore" } ], "inactive": false, "_meta": { "created": "2009-02-04T19:09:18.459Z", "updated": "2003-10-24T05:37:36.46Z", "migrationVersion": -83816576 } } ], "iterations": [ "C7eBbADa-9392-8B82-Bfba-0EFabFB2aDCd", "Db9Ef9ca-B484-bb25-f3fb-47329db6feef", "Dfb1A91f-91eF-0d60-faEb-f9cf5DB4Aa35" ] }, "error_handler": { "x": -98096012.73679589, "y": -68759147.39423513, "gridCoordinate": { "x": 35711520.30602497, "y": -87642024.62829371 }, "name": "childJob", "location": "Application", "locationType": null, "app": "enim dolor commodo fugiat", "canvasName": "ut", "displayName": "aute sit est eiusmod tempor", "summary": "Excepteur", "description": "nisi ad", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/EC+/QB-TROF4sz/vuH/~1/Kn/~0/Bba/s8NC4j,/~1/Jg6vkaFH+ht" }, { "type": "encryption", "pointer": "/~0/j/WGUdYg/pq/IfpPtR8Pa/o/~0/~1" }, { "type": "encryption", "pointer": "/~1/~1/PoqG+/U/~1/~1/HH/~0/~0/sYXW/m3ZYXz-9V" }, { "type": "encryption", "pointer": "/~1/~1/~0" }, { "type": "encryption", "pointer": "/GAvwpNR9/~0/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "sit amet ex velit esse", "highlightString": "occaecat exercitation ex" }, { "key": "amet proident esse voluptate Lorem", "highlightString": "nostrud ad labore aliqua cupidatat" }, { "key": "ad enim commodo", "highlightString": "aliquip voluptate nulla" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "error_handler", "3a1f" ], "complete": [ "3a1f" ], "error": [ "workflow_end", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "ad Ut anim fugiat", "start_time": "1990-04-28T09:51:17.977Z", "end_time": 42867109.46706802, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "default", "ded288013d47d6b3b82557ca" ], "iterations": [ "0306d45a-20a0-a2cd-FF8D-AFD4724cBDFd" ] }, "a96e": { "x": -50849969.44330853, "y": -72957438.95928463, "gridCoordinate": { "x": -95399099.66860342, "y": -93459312.81976925 }, "name": "veniam", "location": "Application", "locationType": "non esse", "app": "aliqua enim", "canvasName": "ad", "displayName": "do Lorem ipsum adipisicing consectetur", "summary": "in ut occaecat laboris incididunt", "description": "ea tempor aliqua anim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/DP05h9/~0/g8+P.,/S/~0/oqK/~1/MS" }, { "type": "encryption", "pointer": "/fFmC2Cis0Lu/~1/~1/~1/Z3/~1/l.tCw.2/~0" }, { "type": "encryption", "pointer": "/~1/~0/g,A/~0/~1/wTIB881gC./yeePk4y8IHY" }, { "type": "encryption", "pointer": "/~1/~1/KWvo-/fTO5L/np+iKdqU1/~1/iyx7+/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "sint", "highlightString": "id Ut dolore" }, { "key": "occaecat est exercitation Ut id", "highlightString": "velit" }, { "key": "velit est eu", "highlightString": "ad nulla eu voluptate" }, { "key": "ut velit", "highlightString": "velit" }, { "key": "dolore Duis", "highlightString": "ut do ad" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "workflow_end" ], "complete": [ "3a1f", "workflow_start" ], "error": [ "workflow_start", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" } ] }, "serverId": "cillum", "start_time": "2003-09-24T23:10:39.219Z", "end_time": -26468722.53650266, "finish_state": "failure", "retrySettings": { "state": [ "failure", "failure", "error" ], "autoRetry": false, "limit": 26490505, "delay": 54312382, "count": 59663733, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "991675ca78cb6aabe8769867", "provenance": "dolore eiusmod", "name": "dolore est", "description": "cupidatat sit do tempor ipsum", "memberOf": [ { "groupId": "f07e7949541de5e67e4106c1", "aaaManaged": false }, { "groupId": "314c86722595b36489c6c418", "aaaManaged": false }, { "groupId": "965a6f462cceba1e9172fada", "aaaManaged": false }, { "groupId": "e18d8efad985ab94213ae80e", "aaaManaged": true }, { "groupId": "8e73f5451c8d891317b56445", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "et aliqua anim consequat culpa" }, { "roleId": "culpa ipsum" }, { "roleId": "ut velit amet" }, { "roleId": "Ut elit" } ], "inactive": false, "_meta": { "created": "1963-02-25T10:22:46.082Z", "updated": "1956-11-22T10:25:13.347Z", "migrationVersion": 90972952 } }, { "_id": "044cd721732432defee692e9", "provenance": "culpa nisi eu do quis", "name": "culpa dolore est enim dolore", "description": "adipisicing ea ut veniam", "memberOf": [ { "groupId": "165b1b19b981fb140c226218", "aaaManaged": false }, { "groupId": "633fb8f81366d94b53f7527e", "aaaManaged": true }, { "groupId": "cdb4f2c328b9c74dca41491e", "aaaManaged": true }, { "groupId": "4e75ef1d06b0f76f3dd40dfc", "aaaManaged": true }, { "groupId": "f07170e5e1562876b37b7e2f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat quis Duis ullamco consequat" }, { "roleId": "elit do laborum in voluptate" }, { "roleId": "proident irure quis commodo" }, { "roleId": "labore laboris dolore" } ], "inactive": true, "_meta": { "created": "2022-11-30T12:09:31.608Z", "updated": "2020-12-02T22:46:51.136Z", "migrationVersion": -3616775 } }, { "_id": "235b5b63da070fc6812b39b2", "provenance": "ut officia", "name": "proident et consequat tempor nostrud", "description": "nostrud commodo", "memberOf": [ { "groupId": "4fb3b7bad658e3b48bab785a", "aaaManaged": true }, { "groupId": "397d424d47e43794951b61fa", "aaaManaged": true }, { "groupId": "c720c8d08290c643469668c8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod eu ipsum in" } ], "inactive": false, "_meta": { "created": "1985-12-30T17:47:33.717Z", "updated": "1968-08-03T08:21:52.406Z", "migrationVersion": -95517187 } }, { "_id": "3c331d74f65dff2855a7e707", "provenance": "mollit consectetur tempor do aliquip", "name": "incididunt laboris officia dolore in", "description": "magna id Ut ea irure", "memberOf": [ { "groupId": "b887ac6b8feabd79396fd4ed", "aaaManaged": false }, { "groupId": "9bde1d7c0828cafe3cbab9f2", "aaaManaged": false }, { "groupId": "ba150c31da9cbc202baffd89", "aaaManaged": false }, { "groupId": "e9abf6b9c25561440a4d7ae5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation" }, { "roleId": "cillum culpa laborum" }, { "roleId": "officia" }, { "roleId": "sunt Ut commodo Duis incididunt" } ], "inactive": false, "_meta": { "created": "1946-08-15T22:03:53.964Z", "updated": "2017-03-21T03:43:09.337Z", "migrationVersion": -11977090 } }, "95b8e15ed79fbd4720daed55" ], "iterations": [ "Ffd96f17-AEeF-fC7E-be6c-b389e617e07a" ] } }, "parent": { "job": "sed consectetur adipisicing ullamco pariatur", "task": "sit laborum Excepteur sunt", "iteration": -87929151.4127205, "element": -35854652.08292668 }, "errorHandler": null, "groups": [ { "_id": "873f3167f7de906e4762079a", "provenance": "exercitation Ut laborum tempor aliquip", "name": "fugiat", "description": "enim fugiat", "memberOf": [ { "groupId": "0f8a1f553ccb347341a75bb3", "aaaManaged": true }, { "groupId": "8a225bd170d6f4c31884e42a", "aaaManaged": false }, { "groupId": "dcb112ad99b792b2aa317699", "aaaManaged": false }, { "groupId": "1f5dbffe9f581c073476e62c", "aaaManaged": true }, { "groupId": "fed606abb09e7c68f201cd02", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt ut in labore" }, { "roleId": "proident aliqua qui nostrud id" }, { "roleId": "laborum aliqua occaecat do veniam" }, { "roleId": "ut ipsum ad aliqua consectetur" }, { "roleId": "ipsum" } ], "inactive": true, "_meta": { "created": "1971-08-12T00:59:42.339Z", "updated": "1947-11-28T14:03:20.335Z", "migrationVersion": 49875776 } } ], "watchers": [ { "_id": "0e6180052d72070069e610c0", "provenance": "sint dolor ut velit amet", "username": "consectetur voluptate", "firstname": "magna consequat fugiat id ut", "memberOf": [ { "groupId": "ff0c313b528923af0e07a84a", "aaaManaged": false }, { "groupId": "66ca5ea3588179cac30bb4a6", "aaaManaged": true }, { "groupId": "9408ed38f48401ed39c8aeaf", "aaaManaged": false }, { "groupId": "fd34ade8172c4efb471d928a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi labore non minim" } ], "inactive": true, "lastLogin": "1965-03-22T10:42:14.254Z", "_meta": { "created": "2015-05-14T19:35:07.068Z", "updated": "1957-05-31T18:09:32.581Z", "migrationVersion": 73044137 }, "email": "in laboris labore pariatur voluptate" }, "6979922363bb3bcbce73ee33" ], "metrics": { "start_time": -48158166.138150185, "progress": 0.9122244068988037, "end_time": 1211985.9786122441, "user": null, "owner": { "_id": "8ec77f43955bde57f9835cd3", "provenance": "et", "username": "enim", "firstname": "cillum reprehenderit sunt", "memberOf": [ { "groupId": "b750321b3116abacd2593ce3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "anim ullamco ad" }, { "roleId": "fugiat" }, { "roleId": "Excepteur et ad" }, { "roleId": "exercitation ut adipisicing aliqua" }, { "roleId": "exercitation enim commodo" } ], "inactive": false, "lastLogin": "1978-09-01T13:24:30.176Z", "_meta": { "created": "1944-07-02T20:51:53.999Z", "updated": "1964-06-30T21:27:26.075Z", "migrationVersion": 56113291 }, "email": "Duis esse occaecat" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }