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": "dolore labore eiusmod laborum", "options": { "description": "Example job description", "type": "automation", "groups": [ "279905a6ff1ed1e7b8b65b37", "db5b1300ef671c8062beb997", "9e6849c850302e931f95932e", "c2db9c0c4758567ef079e4bc" ] } }
{ "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": "d4be1fc2a2c7470453e1ca6a", "font_size": 38022410, "type": "resource:action", "created": "1973-05-03T16:50:24.841Z", "last_updated": "1996-01-30T08:59:49.285Z", "createdVersion": "438608.10.283592-3757.90276.38617", "lastUpdatedVersion": "9.2731238380.30368", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 69228033, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -94544789.41542019, "sla": -49235864.37036747, "decorators": [ { "type": "encryption", "pointer": "/~1/KuFeq/X/SAnG.8/G-RpmEYTu/~1/hG-/~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": "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 }, { "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_start", "name": "myCoolDocumentName", "message": "magna pariatur in labore" } ], "ancestors": [ "44edfbec5954e8f38e304f3c", "35d8392400e02c6df1f81094" ], "validationErrors": [ { "keyword": "officia ullamco esse", "dataPath": "nisi anim veniam", "schemaPath": "mollit do", "message": "Excepteur quis" }, { "keyword": "laboris est Ut in ut", "dataPath": "ut commodo nisi", "schemaPath": "cupidatat", "message": "commodo" }, { "keyword": "est in id", "dataPath": "fugiat voluptate ipsum esse veniam", "schemaPath": "sed officia ea culpa dolor", "message": "cupidatat Lorem mollit" } ], "created_by": "Pronghorn", "last_updated_by": { "_id": "3151a15d8f616e8f9217ab9b", "provenance": "in amet exercitation aliqua", "username": "irure in ut Duis", "firstname": "aliqua officia", "memberOf": [ { "groupId": "dc5767c06d8c977f8081f61d", "aaaManaged": true }, { "groupId": "a8b040e6b80c59d92f543254", "aaaManaged": true }, { "groupId": "3ec185d1f0ee4d78afa7f2ba", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum velit" } ], "inactive": true, "lastLogin": "1970-02-01T07:53:56.972Z", "_meta": { "created": "1953-10-07T11:47:12.385Z", "updated": "1950-03-29T21:34:36.528Z", "migrationVersion": -8631555 }, "email": "tempor veniam do adipisicing" }, "tasks": { "workflow_start": { "x": 44173013.497265995, "y": 46992782.98978934, "gridCoordinate": { "x": 2850760.905167252, "y": 48810700.43294814 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 72737317.38585672, "finish_state": "error", "user": null }, "groups": [ { "_id": "3359936d1ae6905be333eded", "provenance": "ullamco", "name": "sunt ipsum culpa magna nostrud", "description": "minim nostrud consectetur quis", "memberOf": [ { "groupId": "47a5680a94f89a3d3e3d3e77", "aaaManaged": false }, { "groupId": "2e83943e8ea0927b062f3381", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat tempor consequat in amet" }, { "roleId": "aliquip fugiat" }, { "roleId": "eu deserunt irure proident" } ], "inactive": false, "_meta": { "created": "2021-01-03T11:12:32.494Z", "updated": "2020-04-25T19:06:58.948Z", "migrationVersion": 41577785 } }, "b06c474f1a03f6b4625fcab1", "default", "dd96978fe6821e0f39e576a8", "default" ], "iterations": [ "9A98Ec75-8327-ce29-bAbf-f14bdAB01fDD" ] }, "workflow_end": { "x": -73627754.74317881, "y": -99455630.24334171, "gridCoordinate": { "x": 38431554.51753363, "y": -75861972.92206185 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "3a1f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end", "3a1f" ], "error": [ "workflow_start", "error_handler", "workflow_end", "workflow_start" ] }, "metrics": { "end_time": 69266716.17535675, "run_time": 21706246.088698894 }, "groups": [ "c29cfd0352e135da5891429a" ], "iterations": [ "F2Bca40F-Abc2-ECE2-6D87-173f6Df19efC", "bA5B36F0-6af8-Beb4-5bb7-1F241E55f910" ] }, "error_handler": { "x": 5828394.219699979, "y": 8164394.231109768, "gridCoordinate": { "x": -11865664.605931863, "y": -50306001.32623957 }, "name": "childJob", "location": "Application", "locationType": "deserunt", "app": "laborum", "canvasName": "adipisicing ipsum velit", "displayName": "commodo do culpa Duis", "summary": "officia adipisicing", "description": "ut sint dolore cillum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/OUnlIEPfAM/~0/~1/W6mODy/VHOoRIC+q/X8ne/f1JbeLau/aqF.J/~1/l+G/mtUvbq3vL" }, { "type": "encryption", "pointer": "/~0/~1/AsW5E7wzy/~1/PiV9VFcCT/yEOU/RDXIFtq7J" }, { "type": "encryption", "pointer": "/lK/S2,Ji-bUq" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "reprehenderit sed", "highlightString": "irure sint laborum dolore ut" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "workflow_start" ], "error": [ "error_handler", "error_handler", "workflow_start", "3a1f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "e28f", "type": "loop" } ] }, "serverId": "Duis labore ullamco amet id", "start_time": "2018-12-14T09:49:24.017Z", "end_time": -43844527.06285891, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "0c21977b998b1a07efffec4a", "provenance": "Duis in elit", "name": "aute dolore", "description": "elit magna", "memberOf": [ { "groupId": "d0774545548b90b29f5bc61b", "aaaManaged": true }, { "groupId": "1b6f292e91134b90e9aae31d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum deserunt dolore cillum" }, { "roleId": "et" } ], "inactive": true, "_meta": { "created": "1976-05-31T01:50:34.969Z", "updated": "2006-10-20T12:40:54.466Z", "migrationVersion": -26210958 } }, "default", "default", { "_id": "e60d635aaa4d2b2796286611", "provenance": "ipsum sit adipisicing minim", "name": "sed dolor dolore dolore", "description": "laborum", "memberOf": [ { "groupId": "c6014805ae0ebb205a6b4c75", "aaaManaged": false }, { "groupId": "fd34bf59fd550d888f6138d9", "aaaManaged": true }, { "groupId": "cfb1ea6005033c854b29b21b", "aaaManaged": false }, { "groupId": "87085226090f0389e2606c28", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit" }, { "roleId": "veniam" } ], "inactive": true, "_meta": { "created": "2004-05-30T15:53:19.861Z", "updated": "1957-06-11T19:30:44.884Z", "migrationVersion": 32261566 } } ], "iterations": [ "BfFb560c-942d-2eeC-D1e2-D99fCDebDC8a", "b74051fd-eeaE-Cbb1-c75E-050F4F31BDCA" ] }, "d6": { "x": -71937033.95268148, "y": -11246690.516250893, "gridCoordinate": { "x": 72732481.80422729, "y": 85518225.04576215 }, "name": "aliquip mollit reprehenderit", "location": "Application", "locationType": null, "app": "cillum consequat aliqua eiusmod", "canvasName": "in consequat officia eiusmod", "displayName": "quis", "summary": "in", "description": "ut Lorem tempor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/iEDw0/~1/h1N/~1/~0/~1/vsMf/lnPBj/~0/Rv/~0" }, { "type": "encryption", "pointer": "/~0/~0/IPrry-ja5/O/vZZ9/~1/~0/Y5" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "elit eiusmod ut sunt dolore", "highlightString": "aliquip" }, { "key": "mollit veniam occaecat", "highlightString": "esse anim" } ], "status": "complete", "previous": { "incomplete": [ "workflow_end", "error_handler" ], "complete": [ "3a1f", "workflow_start", "workflow_end", "workflow_start", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ut veniam in irure amet", "start_time": "1962-12-22T09:12:12.725Z", "end_time": 7219826.030419618, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "default" ], "iterations": [ "A9a2e2ea-bEdC-Fa4A-e5da-3048E6dA9Af3" ] } }, "parent": { "task": "nisi cupidatat officia dolore", "iteration": 13464305.230030105, "element": 97972331.7190701 }, "errorHandler": { "x": -86766081.48102435, "y": -61809987.24162192, "gridCoordinate": { "x": -98931809.5853394, "y": 46829396.31131831 }, "name": "cupidatat", "location": "Broker", "locationType": "eiusmod cillum enim deserunt anim", "app": "do labore in", "canvasName": "in nisi enim ullamco", "displayName": "officia", "summary": "reprehenderit Ut", "description": "irure tempor commodo dolor incididunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "pariatur", "highlightString": "ea" }, { "key": "Duis", "highlightString": "sunt quis nisi nulla veniam" }, { "key": "culpa aliqua sit eiusmod", "highlightString": "sit reprehenderit mollit ea" }, { "key": "et", "highlightString": "in ad nulla" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "3a1f", "3a1f", "workflow_end" ], "complete": [ "e28f", "3a1f", "workflow_start", "e28f" ], "error": [ "workflow_start", "error_handler", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "enim sint", "start_time": "1965-08-06T01:56:53.669Z", "end_time": -15602621.015323818, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "649948434c78bf7eade8b660", "groups": [ "1fb27e664996aa4f03fb00e7", "default" ], "iterations": [ "24DF2f0c-Fa7A-27fE-5e94-7C9fe05df02D" ] }, "groups": [ { "_id": "b4f9d65be5eaf28d40f44500", "provenance": "est officia eu eiusmod et", "name": "minim irure et", "description": "fugiat occaecat incididunt ad tempor", "memberOf": [ { "groupId": "7743e00f2a341e7c9c67ae46", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua dolor ea" } ], "inactive": false, "_meta": { "created": "1954-06-13T19:37:07.169Z", "updated": "2020-01-02T01:41:14.791Z", "migrationVersion": 50987424 } }, { "_id": "2993a32c6754cb4872b786b3", "provenance": "velit aute", "name": "eiusmod dolore quis aute", "description": "eu sunt", "memberOf": [ { "groupId": "6f79438d5013fdef3e0e4efe", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit in ad aute" }, { "roleId": "id in deserunt consectetur nisi" }, { "roleId": "ex reprehenderit in" }, { "roleId": "enim in" }, { "roleId": "cupidatat veniam eiusmod non anim" } ], "inactive": true, "_meta": { "created": "1949-05-11T09:08:23.885Z", "updated": "2008-12-03T05:05:19.602Z", "migrationVersion": 27454988 } }, { "_id": "41b42e15764ff2a7b686538c", "provenance": "do mollit consectetur", "name": "ipsum ex occaecat in adipisicing", "description": "eu", "memberOf": [ { "groupId": "49552e8b29792796558b90c0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed occaecat in sit" }, { "roleId": "tempor" } ], "inactive": true, "_meta": { "created": "1992-08-13T10:06:40.476Z", "updated": "1986-12-20T17:06:49.534Z", "migrationVersion": 22501194 } }, "default", "68b7fed9d1aaa13e12cde997" ], "watchers": [ { "_id": "757d55f0bff8da86aeea78ed", "provenance": "tempor", "username": "eu dolor ex reprehenderit deserunt", "firstname": "sint dolore nisi aliquip cillum", "memberOf": [ { "groupId": "6605f82fa11d6fdcdda16b09", "aaaManaged": true }, { "groupId": "9b6471a73c255d7c263f566f", "aaaManaged": false }, { "groupId": "ee548f24458c8e101c014263", "aaaManaged": false }, { "groupId": "76c18ae560c3dba4f92d8378", "aaaManaged": false }, { "groupId": "6e8a797fbb101c1c262a8e62", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit sit" }, { "roleId": "occaecat anim" }, { "roleId": "proident" }, { "roleId": "nostrud Ut" } ], "inactive": true, "lastLogin": "2007-04-21T19:50:27.044Z", "_meta": { "created": "1951-05-07T20:16:29.129Z", "updated": "1986-01-24T01:32:55.657Z", "migrationVersion": 59762353 }, "email": "Lorem" }, "Pronghorn" ], "metrics": { "start_time": 81029959.5847325, "progress": 0.5071730719059004, "end_time": 6404782.992057577, "user": "941b7b582277051f1a7f9580", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }