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": "pariatur aute cillum", "options": { "description": "Example job description", "type": "automation", "groups": [ "70d48d47fed2c28613d070e2", "fd6252b01e2d6c176eead55a" ] } }
{ "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": "1fe7c7135e38903b2ab03d4f", "font_size": -66324199, "type": "resource:compliance", "created": "2017-11-29T21:30:02.601Z", "last_updated": "1980-12-16T02:42:57.475Z", "createdVersion": "3292782.405159603.03323", "lastUpdatedVersion": "77132764.2093.52530518542", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -2349393, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 81357795.48753431, "sla": 29688385.43076919, "decorators": [ { "type": "encryption", "pointer": "/LbVCP8M/GDpMBd/~0/~0/~0/ib" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/fSNhfvg2" } ], "status": "running", "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": "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": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "890abb100457941051ac43bb", "c6e7b2f97eedadae623239b4", "e14b0b3ec090eb7d80f28e08" ], "validationErrors": [ { "keyword": "irure nulla in est ad", "instancePath": "in dolor et cupidatat nulla", "schemaPath": "in in", "message": "labore fugiat eiusmod" }, { "keyword": "magna culpa", "instancePath": "non", "schemaPath": "et cupidatat aute fugiat", "message": "amet" }, { "keyword": "amet", "instancePath": "consequat", "schemaPath": "ullamco adipisicing non veniam", "message": "incididunt" }, { "keyword": "et anim cillum", "instancePath": "voluptate sint incididunt proident ipsum", "schemaPath": "esse culpa Duis", "message": "consectetur" } ], "created_by": "99e88416ab9a5f7e414eb5f9", "last_updated_by": "a538fc610d2905dacea7b9f3", "tasks": { "workflow_start": { "x": 73480438.17447358, "y": -20741770.358079538, "gridCoordinate": { "x": -88952069.62580633, "y": 20541360.90231262 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -16526352.173508123, "finish_state": "success", "user": { "_id": "0b55931f55fdfc26785cab88", "provenance": "irure laboris nulla enim", "username": "in consectetur", "firstname": "magna", "memberOf": [ { "groupId": "b3d7b59b1f5a30c2e02436d9", "aaaManaged": false }, { "groupId": "9dce6ed26a185b8f9029493e", "aaaManaged": false }, { "groupId": "afb1c15e884c3af4cc1b9d68", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore aute" }, { "roleId": "aute exercitation" }, { "roleId": "eiusmod" }, { "roleId": "laborum" } ], "inactive": true, "lastLogin": "1949-08-30T04:21:50.365Z", "_meta": { "created": "2000-12-25T22:45:06.409Z", "updated": "2019-07-01T09:48:55.728Z", "migrationVersion": -99388821 }, "email": "enim dolor ullamco Lorem" } }, "groups": [ { "_id": "93751c6a0140b8b358045047", "provenance": "eiusmod culpa fugiat", "name": "Duis esse fugiat consequat ea", "description": "do fugiat velit nulla", "memberOf": [ { "groupId": "88e1c0c985951553af4aa46b", "aaaManaged": true }, { "groupId": "515cc66300fefc554b6ecd33", "aaaManaged": false }, { "groupId": "7dfe5c96f77e4ca57a93f974", "aaaManaged": true }, { "groupId": "14f8cea89521fd209ccd34a0", "aaaManaged": true }, { "groupId": "fc07813609455a469194ec3e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor qui eu ullamco" }, { "roleId": "dolor dolore" }, { "roleId": "ex aliqua" }, { "roleId": "minim dolor" }, { "roleId": "cupidatat tempor cillum commodo" } ], "inactive": false, "_meta": { "created": "1965-04-20T15:24:21.357Z", "updated": "1968-10-25T15:33:08.052Z", "migrationVersion": -54400141 } }, "default", "284281320ba52c918895dbf2", "default" ], "iterations": [ "FfEd4F4E-6e28-2aE8-3F30-FD1DD7bb2BBd" ] }, "workflow_end": { "x": 78386270.24289581, "y": -7148784.373836651, "gridCoordinate": { "x": -46877150.22264025, "y": 36829255.5720866 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler" ], "complete": [ "error_handler", "workflow_start", "3a1f" ], "error": [ "e28f" ] }, "metrics": { "end_time": -88690212.22690336, "run_time": -15371362.488606662 }, "groups": [ "f23538e76dc26f772a5c4ab0", { "_id": "492c8dc0492d48bbdd5bce74", "provenance": "occaecat consectetur", "name": "aliqua minim Duis aute", "description": "eu aute magna esse ex", "memberOf": [ { "groupId": "57d8e631f914f89062162bac", "aaaManaged": false }, { "groupId": "58eae39f6db7214ea8a79501", "aaaManaged": true }, { "groupId": "79cb1de412c25466ed6819a2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id tempor ea" } ], "inactive": true, "_meta": { "created": "1979-06-10T12:51:48.692Z", "updated": "1971-05-25T03:36:36.112Z", "migrationVersion": 23873271 } }, "f9531d5734601d18a8e91e7e", "cf16159e1868ecf86c7ff364", { "_id": "a3c8c78e2fea87c214422e58", "provenance": "nulla in ea Lorem anim", "name": "dolore Duis ut", "description": "magna aliqua mollit nisi dolor", "memberOf": [ { "groupId": "80bddfec2823ec848345ec76", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt occaecat" }, { "roleId": "nostrud anim" }, { "roleId": "sit minim aute irure" }, { "roleId": "anim ex" }, { "roleId": "ut qui magna aliqua in" } ], "inactive": false, "_meta": { "created": "1955-09-17T01:34:49.012Z", "updated": "1961-01-22T14:39:26.39Z", "migrationVersion": -37310324 } } ], "iterations": [ "EAC07b6B-9B12-49af-6ba1-2043528661bF" ] }, "error_handler": { "x": 38264847.0728789, "y": -77733720.98988736, "gridCoordinate": { "x": -4726281.157683894, "y": -8053115.96882689 }, "name": "childJob", "location": "Application", "locationType": "elit", "app": "eiusmod sit dolore", "canvasName": "ullamco amet nulla ipsum", "displayName": "dolor dolore cupidatat", "summary": "exercitation adipisicing", "description": "aliqua in dolor labore in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ob0AL/~1/~1/z4bnZqwAIK/~1" }, { "type": "encryption", "pointer": "/Ow/fU4wp/~0/qp-" }, { "type": "encryption", "pointer": "/~1/J5V//~0/~0/cGgX9l/4/~1" }, { "type": "encryption", "pointer": "/~1/~0/~0/Tg1/~0/YVCwHrvagxg/~0" }, { "type": "encryption", "pointer": "/y.f/~0/~1/~1/DCuwjrJ4kAz/~1/wuO2B7/g.g,UuPdPP/bv/~0/X" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "Lorem dolor", "highlightString": "Lorem" }, { "key": "esse aliquip magna", "highlightString": "ad" } ], "status": "failure", "previous": { "incomplete": [ "e28f", "error_handler", "e28f", "workflow_start", "e28f" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "workflow_start", "e28f", "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "revert" } ] }, "serverId": "eiusmod fugiat dolor non incididunt", "start_time": "1992-12-19T07:19:15.365Z", "end_time": -52595385.89895909, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": { "_id": "7fef0faf068070c79b223997", "provenance": "nulla qui consequat ex", "username": "elit", "firstname": "incididunt", "memberOf": [ { "groupId": "56f4442500aeffe103fc2792", "aaaManaged": true }, { "groupId": "fd3dc3bed7a55f9bf5ef4117", "aaaManaged": false }, { "groupId": "d583d52700b45a0341309d51", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure commodo veniam labore" }, { "roleId": "sed" }, { "roleId": "officia veniam eiusmod sint velit" }, { "roleId": "labore" } ], "inactive": true, "lastLogin": "1999-12-15T09:58:51.894Z", "_meta": { "created": "1982-05-02T01:19:16.884Z", "updated": "1954-08-07T14:16:50.233Z", "migrationVersion": -69615617 }, "email": "ut laborum commodo dolore ullamco" }, "groups": [ "default", { "_id": "b946b8d88950492525690a0f", "provenance": "laborum ad sed", "name": "proident Duis aute esse", "description": "eiusmod do", "memberOf": [ { "groupId": "7db3fe7925ae0bb7c6a4d7fe", "aaaManaged": false }, { "groupId": "93f539d79a44ece875ff9b9b", "aaaManaged": true }, { "groupId": "7396748f67971da121dca89b", "aaaManaged": false }, { "groupId": "0d5497a5a3d50690dab65e7b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor esse dolore in" } ], "inactive": true, "_meta": { "created": "1981-10-24T06:46:32.721Z", "updated": "2005-10-10T06:23:29.454Z", "migrationVersion": -14240439 } }, { "_id": "308b0a226c388fea0866d8a1", "provenance": "nulla ad do Duis incididunt", "name": "in adipisicing", "description": "ullamco Excepteur", "memberOf": [ { "groupId": "6461fa4d44b3bec3ff5ad9d5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu labore incididunt aliqua Duis" }, { "roleId": "sint laborum deserunt pariatur" }, { "roleId": "ex veniam" }, { "roleId": "in voluptate minim incididunt" }, { "roleId": "amet pariatur" } ], "inactive": false, "_meta": { "created": "1960-02-21T06:40:54.517Z", "updated": "2024-02-12T08:36:19.648Z", "migrationVersion": -31129149 } } ], "iterations": [ "D2e0686e-3dcB-8575-dB53-4d2EC7691Fdb", "3f5Eb5Ef-3d82-6FE8-9A5A-18B2DccAF4C7", "E7592811-6ED7-aEbF-39b9-dda0602BFdE4" ] }, "013d": { "actor": "job", "groups": [ "default", { "_id": "46cb3bd950e448f498e409b2", "provenance": "Lorem", "name": "velit eu consectetur quis", "description": "in esse", "memberOf": [ { "groupId": "78c4ac4a558193d8c73a0e23", "aaaManaged": false }, { "groupId": "1be5021106c5ca2a17fa346c", "aaaManaged": true }, { "groupId": "b3536b9a5759ce588e18ea9f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut sint" }, { "roleId": "mollit" }, { "roleId": "incididunt cillum" }, { "roleId": "magna" } ], "inactive": true, "_meta": { "created": "1981-03-11T02:44:24.598Z", "updated": "1956-09-25T20:18:05.173Z", "migrationVersion": 88568070 } } ], "iterations": [], "x": -55853254.78303553, "y": 94575453.89339638, "gridCoordinate": { "x": -923236.9786666483, "y": 94149373.98118135 }, "name": "pending", "summary": "do in dolor aliqua", "description": "in" } }, "parent": { "task": "mollit ad tempor esse cillum", "iteration": -49476333.4745675, "element": 14611890.010313556 }, "errorHandler": { "actor": "Pronghorn", "groups": [ "21b8f528cdefe2320975f084" ], "iterations": [ "c726a789-4FB1-A8cD-8d9F-3DFcc7EfE073" ], "x": -8503702.159108385, "y": -35811633.31061963, "gridCoordinate": { "x": -88056140.69087988, "y": 65032319.201960176 }, "name": "pending", "summary": "Ut sed sunt laboris", "description": "laborum cupidatat culpa do" }, "groups": [ "default", "default", { "_id": "bcbd6d245db6273f13703992", "provenance": "voluptate", "name": "velit sint id proident enim", "description": "dolore irure id", "memberOf": [ { "groupId": "f3899d91fdc3c271ce731556", "aaaManaged": true }, { "groupId": "76dfd33212807d2e42aec11f", "aaaManaged": false }, { "groupId": "6842cd85efafe5ff4961e5bb", "aaaManaged": true }, { "groupId": "5c01350500de00de6073caf1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod nostrud" }, { "roleId": "in laborum labore" }, { "roleId": "nulla in veniam dolor laboris" } ], "inactive": false, "_meta": { "created": "1960-10-24T01:51:54.508Z", "updated": "1989-12-02T10:51:52.215Z", "migrationVersion": 84274140 } }, "ba65e415c57985ccd118bff5" ], "watchers": [ { "_id": "0f8087af527ed3139c06258e", "provenance": "sit nostrud quis", "username": "adipisicing Ut ut", "firstname": "occaecat veniam esse", "memberOf": [ { "groupId": "9f11c5ce2dd55a7305acb1fe", "aaaManaged": true }, { "groupId": "811d4899cf5538e05aba9c57", "aaaManaged": true }, { "groupId": "a3b0d5b14f4502d012ebfdb1", "aaaManaged": false }, { "groupId": "9e1265b598ddc06da049f163", "aaaManaged": true }, { "groupId": "3660d80a4e887eff647683b4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod sunt nostrud qui cillum" }, { "roleId": "proident cillum nostrud" }, { "roleId": "in id nulla" } ], "inactive": true, "lastLogin": "1961-03-21T16:49:16.152Z", "_meta": { "created": "1967-12-04T13:51:54.663Z", "updated": "2020-04-28T07:53:00.618Z", "migrationVersion": 27071543 }, "email": "dolore" }, "8093b29af95f632b61e0f5b3", "c18cc2fe4f0471781c218175", null ], "metrics": { "start_time": -96874739.40834983, "progress": 0.5027473136728344, "end_time": -13885425.017898396, "user": "Pronghorn", "owner": "954d2750ca2d019d6697a17a" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }