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": "laborum minim non labore aliqua", "options": { "description": "Example job description", "type": "automation", "groups": [ "dd52b0c86816df44d2e585cc", "244eec5569b5b2b1eb6ece20" ] } }
{ "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": "0833015d3019bc0a674a1392", "font_size": 74412712, "type": "resource:compliance", "created": "1955-11-23T12:45:18.478Z", "last_updated": "2022-05-27T21:08:55.677Z", "createdVersion": "074255.124642.2283281431", "lastUpdatedVersion": "22845212.8.112061-1033.556.2767008", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 66733937, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 7255997.06070818, "sla": 71468330.9924429, "decorators": [ { "type": "encryption", "pointer": "/~1/q69OvoFA/WAYs+-A/CbeX" }, { "type": "encryption", "pointer": "/wy/vJlT/B7/~0/~1/yIfIE" } ], "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": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "est amet in dolore", "instancePath": "quis sit", "schemaPath": "proident", "message": "do aliqua" }, { "keyword": "dolor labore aliquip qui", "instancePath": "velit amet veniam in", "schemaPath": "dolor ex ullamco ea cillum", "message": "laborum amet reprehenderit" } ], "created_by": { "_id": "f7915ed0711a0f7e9c0e5e55", "provenance": "veniam culpa Duis anim sunt", "username": "reprehenderit", "firstname": "dolore adipisicing", "memberOf": [ { "groupId": "f69c519f33e6268ac0ecd22a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "id laborum in amet anim" } ], "inactive": true, "lastLogin": "2005-07-09T22:53:04.619Z", "_meta": { "created": "1967-11-14T08:46:09.09Z", "updated": "1988-05-18T19:15:22.759Z", "migrationVersion": 26551267 }, "email": "aliqua" }, "last_updated_by": { "_id": "bce58a62f57d7427e6bd0061", "provenance": "voluptate mollit", "username": "quis", "firstname": "consequat exercitation", "memberOf": [ { "groupId": "674a8e4269ba58c32bdc129f", "aaaManaged": true }, { "groupId": "d5facea436e897f317143c0b", "aaaManaged": true }, { "groupId": "5f2eb7d71c82914bd9f8bc73", "aaaManaged": false }, { "groupId": "e67ab2d163b152120304d334", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat velit" }, { "roleId": "dolore" } ], "inactive": false, "lastLogin": "1987-04-02T23:54:22.36Z", "_meta": { "created": "1953-11-23T21:36:25.254Z", "updated": "2004-02-17T08:40:41.024Z", "migrationVersion": 48250226 }, "email": "ut sit velit" }, "tasks": { "78": { "x": -81626685.37574297, "y": 6829729.987127736, "gridCoordinate": { "x": 9915275.612579092, "y": 84695558.68061414 }, "name": "in in deserunt non amet", "location": "Broker", "locationType": null, "app": "ipsum ea dolore", "canvasName": "exercitation deserunt sint sed", "displayName": "voluptate", "summary": "pariatur consectetur elit", "description": "Lorem", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/IlVWnfIpl/LLo2B.vYh/~1/i0PtE/~0/AnJD-Dl/v/R1u7FBN/~1" }, { "type": "encryption", "pointer": "/~1/e/tm4fixDS0/~1/jJH-./~1/~0/eS+Mc1/wWOp+OFeCW//~1/~1" }, { "type": "encryption", "pointer": "/DH.NyjB/HioZ/~1/~0/~1/LFGCx.JNW/kn/~1/~0/qQGb.EO/" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "laboris", "highlightString": "dolor" }, { "key": "anim dolore", "highlightString": "reprehenderit nostrud sint aute" }, { "key": "consequat in aliqua", "highlightString": "ullamco ut pariatur" }, { "key": "adipisicing", "highlightString": "dolore amet est Excepteur cillum" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "3a1f" ], "complete": [ "3a1f", "error_handler", "error_handler", "3a1f" ], "error": [ "workflow_start", "error_handler", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "deserunt", "start_time": "1997-11-19T10:33:33.439Z", "end_time": 23261570.293981478, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "b18378a88a1638aaf606a96c", "provenance": "pariatur non adipisicing nostrud", "name": "Ut nisi anim", "description": "nostrud do ex enim", "memberOf": [ { "groupId": "301e1c805612ccf5c11a25fd", "aaaManaged": false }, { "groupId": "c849ddf4d1b678a484f0ba4a", "aaaManaged": false }, { "groupId": "26ff577264340fb26a0623c6", "aaaManaged": false }, { "groupId": "c0b96dab239eb61cf1e494d1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est deserunt" }, { "roleId": "ea cillum reprehenderit ut dolor" } ], "inactive": true, "_meta": { "created": "1952-10-26T11:21:16.719Z", "updated": "1966-10-25T00:08:17.705Z", "migrationVersion": 19520158 } } ], "iterations": [ "F606Cb5f-9C5F-Bf45-b5E4-0BE21D1af510", "156C2eB5-099e-c63f-18AF-a7D9Fd8C49EA", "F2e0AEFD-AaA3-fDbE-ba1C-AB943E4CbaeC" ] }, "workflow_start": { "x": 27466329.60566981, "y": 22565252.275369167, "gridCoordinate": { "x": 54122273.07353327, "y": 98269797.88754171 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 25915077.158644944, "finish_state": "success", "user": "2ea85f0ad886a30b487170bc" }, "groups": [ "aabe760a38d4bd5af19b3b0c", { "_id": "48e80f68a1ab6b5fb63bd237", "provenance": "ex velit commodo", "name": "Lorem ex", "description": "aliqua nulla laborum", "memberOf": [ { "groupId": "96ff03da85c3456bf56e9a36", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "commodo" }, { "roleId": "qui officia enim esse" }, { "roleId": "voluptate proident Lorem" } ], "inactive": false, "_meta": { "created": "1977-05-24T19:21:24.602Z", "updated": "1964-11-25T00:23:06.711Z", "migrationVersion": -43135050 } } ], "iterations": [ "FBE80069-bDc5-f4E2-b77b-b2F1D222E1EA" ] }, "workflow_end": { "x": 76417496.16291124, "y": 18700170.612286687, "gridCoordinate": { "x": 61394929.26623729, "y": 79975048.5849421 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_end", "e28f", "error_handler", "e28f" ], "complete": [ "e28f", "workflow_start", "workflow_start", "e28f" ], "error": [ "workflow_end", "workflow_end", "error_handler", "error_handler", "workflow_end" ] }, "metrics": { "end_time": 30074679.159592494, "run_time": 94792009.87695923 }, "groups": [ { "_id": "57f16eed486bcc3f49841299", "provenance": "officia tempor elit minim", "name": "veniam in eu", "description": "officia dolore", "memberOf": [ { "groupId": "0fed162b6626b6cf160f9ace", "aaaManaged": false }, { "groupId": "0c0da05408a7f6c80f077cc0", "aaaManaged": true }, { "groupId": "b0c0e133da12836aae37b0c9", "aaaManaged": false }, { "groupId": "6a9d57d5f9357cfca5ceb5f1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et aute" }, { "roleId": "labore" } ], "inactive": false, "_meta": { "created": "1968-03-29T21:36:50.335Z", "updated": "1975-11-22T04:27:45.63Z", "migrationVersion": 20947583 } }, "98e255e542f3f19977772d33", "default", "default", { "_id": "d7731daa11e6ace76ecf91f3", "provenance": "sunt in", "name": "veniam", "description": "eu nisi eiusmod", "memberOf": [ { "groupId": "2c4df76559a02ebb102cfa94", "aaaManaged": false }, { "groupId": "3355dd8605a33b742f398eb2", "aaaManaged": true }, { "groupId": "84ef9da06866124e0789fc4f", "aaaManaged": true }, { "groupId": "9caaa57a3a08cd4d486d27a6", "aaaManaged": true }, { "groupId": "fc612a9ce86d564c7ef9f5d1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum ut ex anim" }, { "roleId": "dolor" }, { "roleId": "elit veniam" }, { "roleId": "sed esse mollit exercitation" } ], "inactive": true, "_meta": { "created": "2010-04-12T01:44:05.12Z", "updated": "2008-08-01T02:27:20.637Z", "migrationVersion": -91651153 } } ], "iterations": [ "EDDe6Ab9-dcd5-Da8C-CC4f-21cdff9B7Ab2" ] }, "error_handler": { "x": 25167257.14880015, "y": -1678776.1646819264, "gridCoordinate": { "x": 30626358.34311554, "y": 43649374.06524271 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "fugiat culpa", "canvasName": "sunt commodo", "displayName": "ad", "summary": "proident dolor aliquip", "description": "aute consectetur in ut ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/frFsB" }, { "type": "encryption", "pointer": "/~1/UTh8r/ghz8meHl/aXvALZA-d/AAuC3uI" }, { "type": "encryption", "pointer": "/vX/cmuz/CLhF+g-WqF./hj/~1/~0/T/M6/,.g43R8K/napzE" }, { "type": "encryption", "pointer": "/zsc/v9uaX/jPoMmAotcQ/~0/Io4D8c8kAc/~0/~0/YQou5SMBKKn" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "quis", "highlightString": "ut nostrud laborum ad" }, { "key": "dolor in Ut ex cupidatat", "highlightString": "eu veniam labore sed" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "3a1f", "3a1f", "e28f" ], "error": [ "workflow_end", "workflow_end", "3a1f", "workflow_end", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "standard" } ] }, "serverId": "mollit sunt ut sint reprehenderit", "start_time": "1982-02-05T05:22:19.133Z", "end_time": -20658153.615745217, "finish_state": "failure", "retrySettings": { "state": [ "failure", "failure", "success", "success" ], "autoRetry": true, "limit": 75644879, "delay": 82551965, "count": 34920976, "finishedRetrying": false }, "type": "operation", "actor": "Pronghorn", "groups": [ "aa57eeb4a818cc7bcaef9580", "ae644666cd9964987e012f93", "default" ], "iterations": [ "be0BD1DA-E3Dc-DcF4-ce56-EdbEc596B5a1" ] } }, "parent": { "task": "occaecat consequat consectetur", "iteration": 8408264.648237914, "element": 73022848.07463479 }, "errorHandler": null, "groups": [ "default", "default", "9e0ccf770d7d193c7d650eb5" ], "watchers": [ null ], "metrics": { "start_time": 31389698.92908974, "progress": 0.08822376138759203, "end_time": -86732211.0353559, "user": { "_id": "67da6b60c8dcbbc28ae5ce77", "provenance": "nisi eu proident commodo", "username": "deserunt sint Excepteur", "firstname": "enim sed elit laboris", "memberOf": [ { "groupId": "4dbdad30f845e6d735725fa1", "aaaManaged": false }, { "groupId": "7bb26b957afec6455476390a", "aaaManaged": false }, { "groupId": "7dc1306c5b1c2374b2d4b44f", "aaaManaged": true }, { "groupId": "41e2afcb1f078efe66e28928", "aaaManaged": true }, { "groupId": "54ee38116605a9a8f120c45e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat enim dolor dolor voluptate" }, { "roleId": "Lorem eiusmod ea laboris nulla" }, { "roleId": "sunt ut in magna velit" }, { "roleId": "voluptate mollit in" }, { "roleId": "proident" } ], "inactive": false, "lastLogin": "1975-08-24T20:35:18.966Z", "_meta": { "created": "1986-04-22T08:20:27.516Z", "updated": "1968-07-01T03:50:42.729Z", "migrationVersion": 3370504 }, "email": "in nostrud pariatur" }, "owner": "6e8962d5c20bdd996d749563" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }