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": "aute magna eu", "options": { "description": "Example job description", "type": "automation", "groups": [ "717c6fedd2fe44387439d59b", "175d05a85b3f606b3c7a619b", "9394a85a35f690a66a0c8c2a", "8fa1671797dbf49d180d993e", "057efa4956037d4487c1db49" ] } }
{ "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": "633f7faed3c51b18d62e0d35", "font_size": 34154549, "type": "automation", "created": "2003-04-23T01:14:56.062Z", "last_updated": "1961-12-27T19:35:17.323Z", "createdVersion": "58622956407.2.56426896-1626.9.921", "lastUpdatedVersion": "5221.602434.134565687-2773.72303143650.39862.722695603", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -93265604, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 6138563.92325905, "sla": -92503055.38082664, "decorators": [ { "type": "encryption", "pointer": "/z8/Ul2F8/ltzTycx6/~1/~0" } ], "status": "paused", "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 }, { "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": "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": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "velit in", "instancePath": "amet in culpa", "schemaPath": "ipsum culpa sint", "message": "laboris" } ], "created_by": "Pronghorn", "last_updated_by": "a90ac9521fe50f803a225fd2", "tasks": { "54": { "actor": "job", "groups": [ { "_id": "bac39ebfc70c9df0ea5da72d", "provenance": "dolore do culpa", "name": "adipisicing Lorem", "description": "aliqua", "memberOf": [ { "groupId": "71d180ac0b7a4361f53a11dd", "aaaManaged": true }, { "groupId": "a64782c12d1bf2d16885f29d", "aaaManaged": false }, { "groupId": "58c3e3bce3e197ab4f076fc0", "aaaManaged": false }, { "groupId": "eeb5886a324bbcae99df8b09", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet sit veniam occaecat" } ], "inactive": false, "_meta": { "created": "1966-05-29T17:31:31.437Z", "updated": "1964-09-06T07:48:08.859Z", "migrationVersion": -33154841 } }, { "_id": "aab24ded2151d758a15838c4", "provenance": "occaecat enim", "name": "eiusmod cupidatat officia", "description": "in", "memberOf": [ { "groupId": "87495a55e635fcb37c7a80aa", "aaaManaged": true }, { "groupId": "303c3b8c6ccd29a05673b6f1", "aaaManaged": true }, { "groupId": "86d2483837ff6f1a416b3cd7", "aaaManaged": false }, { "groupId": "b66e44d25601d8b819e0e9d8", "aaaManaged": true }, { "groupId": "c464d20109cafea17e2f712e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis" } ], "inactive": false, "_meta": { "created": "1987-01-14T05:26:30.457Z", "updated": "1986-01-10T11:48:13.017Z", "migrationVersion": -71877626 } } ], "iterations": [ "3CD1445e-06ca-3bab-bbEf-F65FF46fFc0F" ], "x": 1551141.206185624, "y": -30831401.8489583, "gridCoordinate": { "x": 31446250.541712, "y": 88936780.0671472 }, "name": "amet ut anim ex in", "location": "Adapter", "locationType": "aliqua id Duis esse", "app": "exercitation et nisi dolore", "canvasName": "dolor nisi non", "displayName": "laborum", "summary": "non deserunt cillum", "description": "ut commodo consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/fi" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "dolore ut", "highlightString": "sint" }, { "key": "in eu cillum ea non", "highlightString": "aliqua in ad ullamco est" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "e28f", "workflow_start", "e28f", "workflow_start", "3a1f" ], "error": [ "workflow_start", "workflow_end", "e28f", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "standard" } ] }, "serverId": "est Excepteur do", "start_time": "1952-10-12T04:40:59.542Z", "end_time": 82881433.38816422, "finish_state": "error", "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": true, "limit": 93122404, "delay": 18841494, "count": 4245183, "finishedRetrying": false }, "type": "manual", "view": "velit non" }, "workflow_start": { "x": 57877722.17933044, "y": 98757512.16027147, "gridCoordinate": { "x": 55708247.01283619, "y": 73936261.10977277 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -95636492.10201529, "finish_state": "error", "user": "c1a0be138ae90c96b13b1352" }, "groups": [ "default", { "_id": "2714c678d801548fdce2f40c", "provenance": "dolore tempor irure", "name": "nisi est", "description": "Duis occaecat nostrud fugiat", "memberOf": [ { "groupId": "2fa68aede3b3324b3cd21a20", "aaaManaged": true }, { "groupId": "a0b9cb4db965c5ceba459c9f", "aaaManaged": false }, { "groupId": "63725abcc3a6c73636941418", "aaaManaged": false }, { "groupId": "5680efff7faad61cb2b5db3e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum cillum tempor incididunt" }, { "roleId": "sunt ipsum ullamco aute deserunt" } ], "inactive": false, "_meta": { "created": "1955-03-04T00:50:10.782Z", "updated": "1952-05-08T03:44:04.416Z", "migrationVersion": 50911396 } } ], "iterations": [] }, "workflow_end": { "x": -32172390.593037516, "y": -44266442.62773523, "gridCoordinate": { "x": -12764460.540412605, "y": 33018747.953776374 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "3a1f", "workflow_start", "e28f" ], "complete": [ "workflow_start" ], "error": [ "3a1f", "error_handler", "e28f", "workflow_start", "e28f" ] }, "metrics": { "end_time": 52689672.124798685, "run_time": 98781352.14657098 }, "groups": [ { "_id": "7db21e780cc78baf59f7cf56", "provenance": "qui culpa", "name": "Ut sit laboris", "description": "laborum nulla labore ipsum dolore", "memberOf": [ { "groupId": "47910d1e6bd73ab78f5d9468", "aaaManaged": false }, { "groupId": "238a13b66b415b44199847dc", "aaaManaged": true }, { "groupId": "154836657f989a00433f86f6", "aaaManaged": true }, { "groupId": "ef49a93517ea3048627d2f16", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Excepteur" } ], "inactive": false, "_meta": { "created": "2002-12-30T18:05:47.828Z", "updated": "2010-02-03T21:42:38.976Z", "migrationVersion": 5011794 } }, { "_id": "944355ed1088d98e235338c0", "provenance": "ullamco irure qui culpa", "name": "cillum esse eu non", "description": "do enim velit sunt nisi", "memberOf": [ { "groupId": "1932c82decedea3a8a2d2c05", "aaaManaged": true }, { "groupId": "483f2908dedac9264f04a059", "aaaManaged": true }, { "groupId": "088d509147ce76fd58005037", "aaaManaged": false }, { "groupId": "d047ebdfd60a9d819cc768d9", "aaaManaged": true }, { "groupId": "05bc3313ef661c6e4c6ae3b6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non consectetur quis" }, { "roleId": "est Excepteur veniam minim" } ], "inactive": false, "_meta": { "created": "1976-11-09T00:48:17.792Z", "updated": "1964-04-15T14:17:52.017Z", "migrationVersion": 79580647 } } ], "iterations": [ "ACDAcCAE-0BCB-Ab6c-3f4a-FCfEadAA71EA", "1fdEE03E-eAfF-CB9C-A67A-fBD9dFc336C4", "F6856B3A-E2Ea-feAa-8ecc-C5F7D7D22F4f", "29e47F9c-ee4E-82Ad-Dde3-ccdF19e5cbF5" ] }, "error_handler": { "x": -70108849.09517588, "y": 35954116.29658067, "gridCoordinate": { "x": 12495165.093872845, "y": -85474971.53232038 }, "name": "childJob", "location": "Adapter", "locationType": "eu in", "app": "sint cillum in do", "canvasName": "in sint do", "displayName": "sunt", "summary": "ex", "description": "consectetur nostrud", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/ET.VkYiwgm/~0/XkWJHtYvcq/UF/Z9cJvHoIUu/RAMC--Rs3/~0/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "quis ad ex", "highlightString": "ea dolore sed minim" }, { "key": "dolore dolor", "highlightString": "sint mollit ea qui cillum" }, { "key": "elit laboris Lorem et", "highlightString": "commodo" }, { "key": "adipisicing tempor aliquip", "highlightString": "dolor" } ], "status": "incomplete", "previous": { "incomplete": [ "error_handler", "3a1f", "workflow_start", "3a1f" ], "complete": [ "workflow_start", "workflow_start", "3a1f", "workflow_end" ], "error": [ "workflow_end", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "tempor Ut dolore do", "start_time": "1993-11-17T21:49:50.823Z", "end_time": 93114622.28710186, "finish_state": "failure", "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 58785819, "delay": 13108092, "count": 92782455, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "4776153d5894c72a637c0284", "f1f82514e0fea674cae81db6", "default" ], "iterations": [ "64C7490f-15EF-A637-0e2D-bc47a6A19fa5", "dc5FcD35-d2B3-ADE0-fD7b-bB9e8042A0aa", "cF24FAF7-d92E-FcCB-9A28-B0deC5B7f42b" ] } }, "parent": { "job": "sed", "task": "tempor", "iteration": 77663509.2528821, "element": 11118682.82388042 }, "errorHandler": null, "groups": [ { "_id": "4020c16cfaa80b6fa6416869", "provenance": "Ut pariatur tempor", "name": "Duis consectetur magna laborum", "description": "cillum dolor", "memberOf": [ { "groupId": "919f2bb3717f75e51f322525", "aaaManaged": true }, { "groupId": "9a0d6ffcab4ff55a76e3c43b", "aaaManaged": true }, { "groupId": "b12bde85ebabde4b733f8b66", "aaaManaged": true }, { "groupId": "17ae6ef0847b0546cb2c747f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit consequat nostrud sint" }, { "roleId": "ut ea dolore" }, { "roleId": "Duis dolore reprehenderit in sunt" }, { "roleId": "ea exercitation" }, { "roleId": "ipsum occaecat do proident deserunt" } ], "inactive": false, "_meta": { "created": "2010-07-05T21:36:57.716Z", "updated": "1990-06-29T11:20:06.341Z", "migrationVersion": -82236549 } }, { "_id": "bef6d8e4de29ad3747cb612c", "provenance": "occaecat", "name": "laborum consectetur eu mollit", "description": "dolore", "memberOf": [ { "groupId": "1e93048f17208f91fe47b7fd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum nisi ut Duis" }, { "roleId": "laboris consectetur" }, { "roleId": "in" }, { "roleId": "do commodo Excepteur ea ex" }, { "roleId": "aliqua laboris enim mollit dolore" } ], "inactive": true, "_meta": { "created": "2020-10-07T21:41:38.777Z", "updated": "1976-12-25T08:30:12.483Z", "migrationVersion": -29051297 } }, { "_id": "87124b9735196c7f23cb588f", "provenance": "irure nostrud", "name": "in", "description": "ad laboris ut Lorem", "memberOf": [ { "groupId": "95b8b312659c8dcd5867df4e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "velit laboris culpa dolore ea" } ], "inactive": false, "_meta": { "created": "1947-03-29T13:52:28.773Z", "updated": "1960-12-06T01:38:59.508Z", "migrationVersion": -95858379 } } ], "watchers": [ { "_id": "01965ce937f5de7af721d729", "provenance": "elit", "username": "minim labore ut dolor", "firstname": "deserunt sit nisi", "memberOf": [ { "groupId": "df781e7d2475b9de45d155e6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex nulla sint qui do" }, { "roleId": "ullamco" }, { "roleId": "Excepteur non incididunt" }, { "roleId": "sit veniam" } ], "inactive": false, "lastLogin": "2011-04-08T00:36:14.495Z", "_meta": { "created": "1988-11-20T02:21:05.802Z", "updated": "1951-07-14T08:43:26.979Z", "migrationVersion": -43333642 }, "email": "aliqua cillum veniam" }, "625780db4290f38239c3fd4f", { "_id": "c3416b9e7ddc521bb7e83292", "provenance": "Ut nostrud aute voluptate", "username": "aliqua occaecat est do in", "firstname": "Excepteur laboris id laborum veniam", "memberOf": [ { "groupId": "470b4577f1f16dfc44623bd3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "et in tempor reprehenderit id" }, { "roleId": "magna" }, { "roleId": "aliquip irure" } ], "inactive": false, "lastLogin": "2000-04-08T13:51:48.84Z", "_meta": { "created": "1969-01-22T13:11:08.862Z", "updated": "2017-02-13T07:56:36.267Z", "migrationVersion": -54651431 }, "email": "mollit adipisicing" }, "9f7ef1ec34477dea53308df4" ], "metrics": { "start_time": -56619771.29217233, "progress": 0.7613568379194848, "end_time": 96977092.79795563, "user": "Pronghorn", "owner": "da7f2febec6e42499c9936fd" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }