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": "in fugiat proident tempor", "options": { "description": "Example job description", "type": "automation", "groups": [ "f03a145f7f2938c046c09787" ] } }
{ "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": "8d57095671aa474b88812305", "font_size": -76514762, "type": "automation", "created": "2022-10-28T10:16:46.521Z", "last_updated": "1962-09-28T15:11:14.407Z", "createdVersion": "33.825551.1-6113.90925.234326377", "lastUpdatedVersion": "790618.080611.1105692099", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -15339644, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 6842986.985494062, "sla": -99527746.84183918, "decorators": [ { "type": "encryption", "pointer": "/qO./C9O" }, { "type": "encryption", "pointer": "/qgCh" } ], "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": "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName", "message": "anim aute incididunt aliquip minim" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "labore dolor culpa proident nostrud", "dataPath": "dolore aliquip", "schemaPath": "Lorem officia voluptate", "message": "ullamco dolore" }, { "keyword": "nisi consequat", "dataPath": "laborum non cillum", "schemaPath": "labore amet id aliqua proident", "message": "in elit ad et consequat" }, { "keyword": "sit eu ex enim proident", "dataPath": "ad officia nisi dolore", "schemaPath": "anim", "message": "Lorem aute elit proident deserunt" } ], "created_by": "d7383391432ba4c3486bee05", "last_updated_by": { "_id": "a87efeacdb60f059b597bada", "provenance": "exercitation ad", "username": "in", "firstname": "do qui dolore", "memberOf": [ { "groupId": "ae9da7c51f10b600bb2a25aa", "aaaManaged": true }, { "groupId": "70bdd8274ff38c299f3edb32", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi nostrud dolor" } ], "inactive": false, "lastLogin": "1993-07-07T03:33:54.277Z", "_meta": { "created": "1978-04-18T08:12:22.714Z", "updated": "2013-07-13T18:58:52.323Z", "migrationVersion": -55016672 }, "email": "aliquip irure Lorem ipsum elit" }, "tasks": { "workflow_start": { "x": -79831257.77737117, "y": 34793128.641028345, "gridCoordinate": { "x": -16468028.174440801, "y": 80481009.2096223 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -48509074.91479859, "finish_state": "error", "user": { "_id": "172deab654f494a012bc5b92", "provenance": "dolore in quis", "username": "laboris ex sunt veniam", "firstname": "sed tempor ad", "memberOf": [ { "groupId": "095d22f415bd77669129e889", "aaaManaged": false }, { "groupId": "a3ae63178eaede2d3d5a13f0", "aaaManaged": false }, { "groupId": "5c766f93464bb22288662dc9", "aaaManaged": false }, { "groupId": "8a52f50c38f205299413c927", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim amet" } ], "inactive": true, "lastLogin": "1981-06-18T13:04:23.78Z", "_meta": { "created": "2013-09-23T23:04:38.403Z", "updated": "1959-03-13T10:31:00.997Z", "migrationVersion": -21596775 }, "email": "consectetur quis" } }, "groups": [ "88391d246a7f66b8a2cfe21c", "1246be5747bc4411e6242aab", "default", { "_id": "65196f265c56b6bd2025b717", "provenance": "nisi enim ea fugiat occaecat", "name": "non Ut velit est id", "description": "sint quis Excepteur aute laboris", "memberOf": [ { "groupId": "d8684c31aa6885c6deea3ae4", "aaaManaged": true }, { "groupId": "bd13af7829cd20352fcdd5a3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit Ut laborum" } ], "inactive": true, "_meta": { "created": "1988-06-07T13:46:57.942Z", "updated": "2015-04-13T16:04:45.835Z", "migrationVersion": 14578122 } }, { "_id": "900fe226ac0270e88d3bc5ca", "provenance": "officia labore", "name": "nisi aliquip cupidatat", "description": "amet labore reprehenderit", "memberOf": [ { "groupId": "cb25ad5283a78e362ad22ab5", "aaaManaged": false }, { "groupId": "0cfef5bc650b0c94b1aa746d", "aaaManaged": false }, { "groupId": "f7ad89d2ecd2172d6a70209e", "aaaManaged": true }, { "groupId": "c10b23bd00f0c626430c4161", "aaaManaged": true }, { "groupId": "d833b07441c494fef18a922e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore cupidatat sit Excepteur" }, { "roleId": "Ut" }, { "roleId": "amet mollit minim irure" } ], "inactive": true, "_meta": { "created": "1959-11-28T23:42:04.482Z", "updated": "2009-12-30T15:05:28.904Z", "migrationVersion": 29195339 } } ], "iterations": [] }, "workflow_end": { "x": 58894365.258072644, "y": -38478870.009958625, "gridCoordinate": { "x": 22006353.043515593, "y": -43513191.98224126 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "e28f", "e28f", "error_handler", "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_end", "3a1f" ], "error": [ "workflow_start", "workflow_end", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": -76040062.90469006, "run_time": 69790370.32253635 }, "groups": [ "default", "43d647b17624cffd7a80fac9", "c1f42b1a54fe2c0c4dc784ff", "default", { "_id": "bf331f299ad033353e81dc20", "provenance": "incididunt voluptate", "name": "do quis in aliqua", "description": "culpa quis minim", "memberOf": [ { "groupId": "115a6f7b351b5a8bc5892f11", "aaaManaged": true }, { "groupId": "47e8cf60b4e82de5b8d424a7", "aaaManaged": true }, { "groupId": "7745f7e74037cb7f5844a5cc", "aaaManaged": true }, { "groupId": "f71c5e606c88cbb9792a8995", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur voluptate ea" }, { "roleId": "exercitation qui laboris dolore sint" }, { "roleId": "exercitation adipisicing" }, { "roleId": "pariatur" }, { "roleId": "aliqua dolor dolore elit Duis" } ], "inactive": false, "_meta": { "created": "2001-02-15T06:25:23.663Z", "updated": "2023-12-02T18:57:09.627Z", "migrationVersion": -37254283 } } ], "iterations": [ "692b07A2-52d7-ECA9-6AF8-8c6ffBbD7E57" ] }, "error_handler": { "x": -82945213.03333932, "y": -84909207.94040835, "gridCoordinate": { "x": -52645450.394916214, "y": -19722565.079989925 }, "name": "childJob", "location": "Application", "locationType": "elit dolor eiusmod officia ullamco", "app": "ut dolore in ut", "canvasName": "dolor in adipisicing enim", "displayName": "ipsum laborum ut nulla", "summary": "elit id aliqua magna", "description": "qui sed", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/DK+EV2/2XXl/oHKVoC/BRhkR/8" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "pariatur laborum", "highlightString": "magna dolor culpa fugiat" }, { "key": "est aliqua enim", "highlightString": "mollit incididunt fugiat" }, { "key": "adipisicing dolor dolore", "highlightString": "reprehenderit esse ea nostrud est" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "3a1f", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "workflow_end", "workflow_start" ], "error": [ "workflow_end", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "occaecat", "start_time": "2013-03-22T10:34:13.301Z", "end_time": -80261587.34606352, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "1b36f676de6cb269a40cd682", { "_id": "b9084020335634009ddb7c59", "provenance": "officia incididunt culpa", "name": "nulla anim fugiat", "description": "officia amet ut culpa", "memberOf": [ { "groupId": "a49ff8a79429602ce0bf3263", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad commodo aliqua" }, { "roleId": "aute id voluptate quis sunt" }, { "roleId": "proident magna sed laboris" } ], "inactive": false, "_meta": { "created": "1987-06-04T16:44:26.979Z", "updated": "1995-08-05T22:16:00.803Z", "migrationVersion": 23539556 } } ], "iterations": [ "a8Fd8Ed5-e8Fc-fCa8-1C7d-F857Bc3999Cc" ] }, "60c": { "actor": "job", "groups": [ "default", { "_id": "ac2d18f1ffa95e716726d28e", "provenance": "deserunt ullamco ipsum", "name": "dolor velit est nisi", "description": "nostrud Ut adipisicing veniam esse", "memberOf": [ { "groupId": "2c8d874f8c6440f9c5af2a80", "aaaManaged": false }, { "groupId": "792245817ef92525475fcb82", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "magna Ut reprehenderit ex" } ], "inactive": true, "_meta": { "created": "1978-08-22T07:33:28.176Z", "updated": "1966-02-14T03:26:19.049Z", "migrationVersion": 69731115 } }, "default" ], "iterations": [ "8BBcbc4a-dDE1-DE7A-6EDd-5bb344c1EAfF" ], "x": -54559506.32142641, "y": -79369548.58458143, "gridCoordinate": { "x": 80791374.15672314, "y": -64343676.54185285 }, "name": "dolore et", "location": "Broker", "locationType": "ut proident enim ea", "app": "occaecat deserunt fugiat voluptate veniam", "canvasName": "id consequat commodo aliqua", "displayName": "consequat cupidatat consectetur tempor", "summary": "eu nulla", "description": "reprehenderit id", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/S/~1/~1/~1/~0/LRW2664/~1/OMLuUv" }, { "type": "encryption", "pointer": "/TC/oEY1oYoR/~0/cM/~1/LH/cRkrI/~0" }, { "type": "encryption", "pointer": "/kX+hcxs8VuN/~0/y/~0" }, { "type": "encryption", "pointer": "/VX.RAw/u3oYo+hbD4/ThOUGe8qy" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "ea dolore eu", "highlightString": "aute et exercitation deserunt" }, { "key": "sunt laborum ullamco", "highlightString": "sit consectetur veniam amet officia" }, { "key": "ut Duis", "highlightString": "dolor laboris qui exercitation" }, { "key": "fugiat ea id magna", "highlightString": "id do enim Lorem amet" }, { "key": "consectetur Duis non fugiat ea", "highlightString": "anim" } ], "status": "running", "previous": { "incomplete": [ "workflow_end", "e28f", "3a1f", "workflow_start", "error_handler" ], "complete": [ "e28f", "workflow_start" ], "error": [ "error_handler", "e28f", "workflow_start", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "in", "start_time": "1953-08-05T04:41:02.88Z", "end_time": -42880658.30927929, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "incididunt" } }, "parent": { "task": "cupidatat officia laborum consequat", "iteration": -2915607.9171916544, "element": 49054813.68670276 }, "errorHandler": null, "groups": [ { "_id": "7d44f1ca299f6e6a84961c96", "provenance": "qui aliquip Excepteur ipsum nisi", "name": "Ut consequat et in Duis", "description": "incididunt", "memberOf": [ { "groupId": "274b8fa1d4c8647ff071a102", "aaaManaged": true }, { "groupId": "97ef3ca008305cc024b968f1", "aaaManaged": false }, { "groupId": "780877f6f104c32b30a72e8f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor eiusmod" }, { "roleId": "fugiat esse commodo Duis" }, { "roleId": "ut irure" } ], "inactive": false, "_meta": { "created": "1961-09-22T14:43:47.825Z", "updated": "1990-08-22T13:25:03.031Z", "migrationVersion": 91082556 } } ], "watchers": [ null, "Pronghorn", "Pronghorn" ], "metrics": { "start_time": 22032512.24385059, "progress": 0.9667295196463417, "end_time": -16469669.189601928, "user": { "_id": "dde1f42beb589939223baae9", "provenance": "ipsum amet", "username": "consequat", "firstname": "cupidatat dolore", "memberOf": [ { "groupId": "5da36f0b10480d20ec1a0802", "aaaManaged": false }, { "groupId": "2369e8ea56f6d9ff07be73d1", "aaaManaged": false }, { "groupId": "29505d56b261c64458aede05", "aaaManaged": true }, { "groupId": "b11614863d2a5a4f913877ac", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim sint labore" }, { "roleId": "ea occaecat sit" } ], "inactive": false, "lastLogin": "2020-04-22T11:52:33.492Z", "_meta": { "created": "2023-09-21T18:56:50.548Z", "updated": "2006-11-25T02:51:30.265Z", "migrationVersion": 34581771 }, "email": "labore aliqua ipsum consequat Excepteur" }, "owner": { "_id": "237487f1e8c37fb86542b207", "provenance": "veniam dolor do", "username": "aliquip", "firstname": "ullamco", "memberOf": [ { "groupId": "f5199c4eab71a8d401333a05", "aaaManaged": true }, { "groupId": "d6778801c59848d56edd675e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est pariatur Lorem in officia" }, { "roleId": "amet nulla Excepteur" } ], "inactive": false, "lastLogin": "1980-09-04T13:18:27.738Z", "_meta": { "created": "1981-03-26T04:25:18.838Z", "updated": "2013-05-03T11:05:28.898Z", "migrationVersion": 6898359 }, "email": "consectetur mollit aute do eiusmod" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }