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": "Ut in", "options": { "description": "Example job description", "type": "automation", "groups": [ "580ef60e022163c0eaa8343b", "2ce1f1816d7ea7afab68df11", "74f594db5060a643c071daf6", "344cf5e2a0cd2e7b0fb314ab" ] } }
{ "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": "c5a1f62bf1f2e4a5b55cb2e0", "font_size": 86399275, "type": "automation", "created": "1979-10-22T09:32:11.843Z", "last_updated": "1984-07-11T05:10:30.891Z", "createdVersion": "40.8093097181.7501-7442.122931958.3342", "lastUpdatedVersion": "497157319.571587421.2754930801-9820.42439.878832752.210984", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 30891120, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 88854997.67857894, "sla": 14454400.369263753, "decorators": [ { "type": "encryption", "pointer": "/I2wZypWrr1/~0/FiB89-ri/O8s.hcJ/e339akdoE/u4UK3g9P2Qv/eEUufo" }, { "type": "encryption", "pointer": "/~1/~0/~1/o7e78GU/pN-ztEk/sgMIq" } ], "status": "canceled", "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": "workflow_start", "name": "myCoolDocumentName", "message": "ex do" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "ut mollit" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "aliquip culpa enim et Ut" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "esse dolore" } ], "ancestors": [ "7450ca7fd4b26dc9bd39e74e", "2a55f9573f6cb3832e5ec9ee", "271249a4deb7eaa7a6b6b96a" ], "validationErrors": [ { "keyword": "in dolore", "dataPath": "Lorem", "schemaPath": "tempor esse", "message": "dolore est sunt aute" }, { "keyword": "aliqua minim", "dataPath": "Lorem in aliquip", "schemaPath": "Duis pariatur sed Excepteur in", "message": "proident amet" } ], "created_by": { "_id": "6c286485d922b7768b8cfcf7", "provenance": "velit ut ut consequat in", "username": "ut anim officia dolore reprehenderit", "firstname": "culpa", "memberOf": [ { "groupId": "bcd2a019bd952d2bb7dc1532", "aaaManaged": true }, { "groupId": "fb252ee55e6b41c15b0e2e46", "aaaManaged": false }, { "groupId": "2efe698bfea227ce517313df", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum sunt" }, { "roleId": "dolore" }, { "roleId": "enim non ex minim sunt" } ], "inactive": false, "lastLogin": "1982-06-03T04:38:46.958Z", "_meta": { "created": "1990-09-03T21:20:34.43Z", "updated": "1967-03-24T19:33:52.319Z", "migrationVersion": -961153 }, "email": "nostrud laborum do esse ea" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 23158482.32315734, "y": 27046785.346472695, "gridCoordinate": { "x": 275476.5004608035, "y": -56792924.32800462 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -89995917.12962638, "finish_state": "failure", "user": "ce2b078b13768c358eb86243" }, "groups": [ "default", "30b100d52fe72b200ae260eb", { "_id": "4658926b6e321b270fa7d971", "provenance": "tempor aliqua laboris incididunt pariatur", "name": "ipsum consequat", "description": "laborum in ullamco", "memberOf": [ { "groupId": "3cbf948b7773f7b1ee28c282", "aaaManaged": false }, { "groupId": "f7770070954688298a772d6b", "aaaManaged": false }, { "groupId": "7be7681dd707a93f6814f712", "aaaManaged": true }, { "groupId": "66a0c24e7d1f272446b91fea", "aaaManaged": true }, { "groupId": "9113c97caaeab67f383139a4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure culpa Lorem in Excepteur" }, { "roleId": "ex deserunt" }, { "roleId": "consectetur minim id qui et" }, { "roleId": "sit" } ], "inactive": false, "_meta": { "created": "1966-03-02T11:00:59.913Z", "updated": "1997-03-23T02:56:43.218Z", "migrationVersion": 77437264 } }, "2e914e7854c386ec689d724a", "default" ], "iterations": [ "cf4Ff81A-a1ea-5d2E-1ADe-8FdB5ee4cDc1", "45D2fedE-3973-c33d-eE29-d1f0ecb5F4A7", "c239D0b0-35CA-7BcE-eed3-faAC5c5babeD" ] }, "workflow_end": { "x": -7250235.831179813, "y": 80138963.66140503, "gridCoordinate": { "x": 85345291.4026362, "y": 77157021.98116553 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "e28f", "workflow_end", "workflow_start", "workflow_start" ], "complete": [ "e28f", "workflow_end" ], "error": [ "workflow_end", "workflow_start", "error_handler", "e28f", "workflow_start" ] }, "metrics": { "end_time": -31805968.14640437, "run_time": 29872877.91170767 }, "groups": [ "a2f9a02eb0749e1cc262b6cc", "22c48ca8caadd91b8e0e52ae", { "_id": "8b7187a8a14397f8d65f339e", "provenance": "enim magna do", "name": "ut", "description": "Excepteur sed magna irure reprehenderit", "memberOf": [ { "groupId": "4ae6dd0e53e1eebebc7726c6", "aaaManaged": true }, { "groupId": "4b4437088ae31327f7eb63da", "aaaManaged": true }, { "groupId": "20552da0d21b99228b396695", "aaaManaged": false }, { "groupId": "e7dc15d5fbcaeaf61666061a", "aaaManaged": false }, { "groupId": "f4cefa33ead2a5a326fc4ee3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod sed sunt mollit" }, { "roleId": "do" } ], "inactive": true, "_meta": { "created": "1962-03-21T06:06:37.081Z", "updated": "2006-01-10T14:53:41.315Z", "migrationVersion": -74704758 } } ], "iterations": [] }, "error_handler": { "x": 12289694.023990184, "y": -87292100.7067216, "gridCoordinate": { "x": -3616554.9285411835, "y": 14116339.252223268 }, "name": "childJob", "location": "Application", "locationType": "minim est ad dolore culpa", "app": "velit sit Ut", "canvasName": "commodo", "displayName": "tempor labore Lorem amet", "summary": "culpa", "description": "Lorem ullamco voluptate", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/eHK,B/tTztLNQIw0/TGee2G9ADm/~0" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "laboris cillum deserunt dolor", "highlightString": "sunt" }, { "key": "dolor consectetur", "highlightString": "elit ad enim cupidatat occaecat" }, { "key": "velit", "highlightString": "aute eu ipsum ea Duis" }, { "key": "ut sed consequat", "highlightString": "Excepteur" } ], "status": "canceled", "previous": { "incomplete": [ "e28f", "error_handler" ], "complete": [ "3a1f", "e28f", "workflow_start" ], "error": [ "e28f", "workflow_end", "error_handler", "e28f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "adipisicing", "start_time": "2007-07-06T11:35:28.849Z", "end_time": -66417574.55506498, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": { "_id": "04b6871cb3cdf8702046a0dd", "provenance": "sit commodo laborum non esse", "username": "fugiat amet id enim eu", "firstname": "do id sunt culpa", "memberOf": [ { "groupId": "a8141d288a1a1fd055071c5f", "aaaManaged": true }, { "groupId": "888e0af9afd2522e813c3575", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit deserunt" }, { "roleId": "cillum nostrud Ut aute ad" }, { "roleId": "magna aute dolore" }, { "roleId": "velit veniam minim ad est" } ], "inactive": false, "lastLogin": "1966-03-17T01:06:42.322Z", "_meta": { "created": "1976-07-10T10:15:58.883Z", "updated": "1972-02-10T12:16:41.209Z", "migrationVersion": -34409386 }, "email": "irure aute voluptate" }, "groups": [ "444a6bf4eaa03156983a0ae7" ], "iterations": [ "A05f4d2f-4E85-8ADE-1d38-299Dd302fD1b", "DD3D7A58-A8ba-e1BD-bC7E-2c3DFc51F85f", "45d5b7D4-FEc9-553A-7e1f-Abc3c7D5b8Ef" ] }, "8c9d": { "actor": null, "groups": [ { "_id": "eefe4dc0bbedc4f48c8a0151", "provenance": "mollit laboris aute eu", "name": "et do", "description": "Excepteur non", "memberOf": [ { "groupId": "7098978d6ae5a0265e2978bb", "aaaManaged": false }, { "groupId": "51b71bb7706d4d0c8c2956a5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco qui incididunt voluptate" }, { "roleId": "culpa" } ], "inactive": true, "_meta": { "created": "1965-09-17T18:30:32.575Z", "updated": "2007-10-16T01:22:25.811Z", "migrationVersion": -80125156 } }, { "_id": "93b8ffe647db15413b424ac4", "provenance": "do voluptate in ad ea", "name": "dolore laboris", "description": "aliquip do laboris ex minim", "memberOf": [ { "groupId": "86e5c9777f96837fbd844849", "aaaManaged": true }, { "groupId": "fbea3fd3e3bb8c64aca4bc56", "aaaManaged": true }, { "groupId": "3d346b3f651032e7babf8faa", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum aliquip et incididunt" } ], "inactive": true, "_meta": { "created": "1995-06-20T10:29:55.935Z", "updated": "2005-05-30T10:09:51.226Z", "migrationVersion": -47686801 } } ], "iterations": [ "5f2Ef2Df-C15D-34Ba-081b-D2d62748c9f9", "28FcD7F2-fe9c-B1FF-95c9-C9128D3DBA0f", "714D86B2-569a-aA65-8c59-e29F1fd0b83d" ], "x": -5635905.333403766, "y": 86733103.22832966, "gridCoordinate": { "x": -48944691.5454808, "y": -61299211.62893801 }, "name": "in ullamco non", "location": "Broker", "locationType": null, "app": "nostrud sed aute", "canvasName": "childJob", "displayName": "magna tempor sit Ut laboris", "summary": "ullamco dolore sunt", "description": "ex magna", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/j2Y8XSL8+9/~0" }, { "type": "encryption", "pointer": "/OUTAm9Ftj/VZ/C2HvQe+wn/fdK+/~0/qklpfMkYBOz/fqXZ" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "dolor fugiat ad", "highlightString": "enim amet" }, { "key": "laborum aute enim", "highlightString": "anim ullamco amet quis" }, { "key": "ea exercitation", "highlightString": "dolore eu magna qui" }, { "key": "ullamco proident Lorem quis commodo", "highlightString": "aliqua proident culpa dolore" }, { "key": "aute dolore", "highlightString": "laboris cillum nulla qui" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "workflow_start", "e28f", "workflow_end" ], "complete": [ "error_handler", "3a1f", "workflow_start", "error_handler" ], "error": [ "e28f", "e28f", "3a1f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "loop" } ] }, "serverId": "voluptate Excepteur ullamco", "start_time": "1969-04-30T22:58:00.572Z", "end_time": 42226965.692777544, "finish_state": "failure", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": 26559099.805524826, "outgoing": [ null, null, "velit" ] }, "childJobs": [ { "_id": "eu consectetur Duis qui", "name": "incididunt consectetur veniam", "iteration": 65479402.06727624 }, { "_id": "sunt nisi proident Duis consequat", "name": "laboris", "iteration": -32958499.02807282 } ] } }, "parent": { "task": "eiusmod do cillum consectetur occaecat", "iteration": 81086897.85833758, "element": 32547899.946359232 }, "errorHandler": null, "groups": [ "default", "default", { "_id": "1bd8df045de7a29e867f00d6", "provenance": "mollit sint dolore commodo", "name": "qui enim cupidatat", "description": "nostrud anim reprehenderit", "memberOf": [ { "groupId": "510612ea020d0c34ac175682", "aaaManaged": false }, { "groupId": "1f303ffd4cf70fe990c50c3f", "aaaManaged": false }, { "groupId": "fcb46fee4ab28f66a39a9e4a", "aaaManaged": false }, { "groupId": "4f39d7c211f862698a6ea38a", "aaaManaged": true }, { "groupId": "c47f342eec03824a1ed96898", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sint" }, { "roleId": "cupidatat consequat" }, { "roleId": "Ut aliquip occaecat velit" } ], "inactive": false, "_meta": { "created": "2018-10-18T21:22:47.826Z", "updated": "1980-01-27T23:52:51.989Z", "migrationVersion": 12795689 } } ], "watchers": [ "Pronghorn", "0a6b3061ddd5df2f8b6864ce", "83c09a1d1a0b40e907ca8a1d", { "_id": "3aaa6b8193e4d9f45e64e1a3", "provenance": "esse Lorem ut sed officia", "username": "Ut", "firstname": "est eu ut minim", "memberOf": [ { "groupId": "731cf90513de2e1ba93b06dc", "aaaManaged": false }, { "groupId": "4eff08864aac2ca0f50035d8", "aaaManaged": true }, { "groupId": "ffd4f55090c02830b9eb834f", "aaaManaged": false }, { "groupId": "1ac8494a3c3ac3459f20ddfe", "aaaManaged": true }, { "groupId": "79bbdb1d563b38a743c43403", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam" }, { "roleId": "Ut proident dolore" } ], "inactive": false, "lastLogin": "1962-11-09T08:16:56.469Z", "_meta": { "created": "1997-01-10T00:35:13.896Z", "updated": "2015-05-02T16:30:21.91Z", "migrationVersion": -658321 }, "email": "in" } ], "metrics": { "start_time": 60603016.46798098, "progress": 0.32403257320698686, "end_time": -74258014.14560515, "user": null, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }