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 exercitation laboris ut dolore", "options": { "description": "Example job description", "type": "automation", "groups": [ "46789c138e5b17f03c1b59b1", "90c42dcb65d115d93ba8d370" ] } }
{ "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": "03cc010d0f0f2f07c8e19d48", "font_size": 5817980, "type": "resource:action", "created": "1996-06-05T02:30:02.838Z", "last_updated": "2016-11-11T00:40:06.45Z", "createdVersion": "07931932991.431485.00", "lastUpdatedVersion": "9978649.3596.2010841", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -17537704, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 64986831.247195244, "sla": 595865.7210882753, "decorators": [ { "type": "encryption", "pointer": "/dn/RI/zo/~0/UkHj4D/~0" }, { "type": "encryption", "pointer": "/y7K-h1n./~0/fvntYEe4KsE/~0/~1/lZu8sXa5" } ], "status": "error", "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 }, { "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": "error_handler", "name": "myCoolDocumentName", "message": "nisi irure" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "in culpa dolore occaecat eu" } ], "ancestors": [ "b3956a7b9560c90b6af0b0a5" ], "validationErrors": [ { "keyword": "id adipisicing anim", "dataPath": "dolore cupidatat dolor mollit", "schemaPath": "magna nisi minim amet", "message": "officia consectetur non eiusmod" }, { "keyword": "sit", "dataPath": "veniam Duis", "schemaPath": "sit", "message": "cupidatat Lorem eiusmod occaecat" }, { "keyword": "ex ad ut eiusmod", "dataPath": "veniam velit", "schemaPath": "in enim sit", "message": "aliqua Duis consectetur" }, { "keyword": "eiusmod ad aliquip cupidatat sed", "dataPath": "deserunt", "schemaPath": "laborum reprehenderit id laboris cillum", "message": "eu" }, { "keyword": "aliquip occaecat consectetur quis", "dataPath": "aliqua quis laboris ut id", "schemaPath": "magna fugiat officia enim veniam", "message": "occaecat fugiat" } ], "created_by": "Pronghorn", "last_updated_by": "14f54b13f8438a1653054cfa", "tasks": { "38": { "actor": "$var.fe34.o2CcVqTuNw", "groups": [ "default", "2315e2cb320e2b25aee0ceb0", { "_id": "4fe7ba785f96c5cbc029e1bc", "provenance": "in commodo proident ut", "name": "in eu", "description": "irure et sit", "memberOf": [ { "groupId": "66e6374684b8c9f4b895a736", "aaaManaged": false }, { "groupId": "70e57fb1a31fcd2ce5900e0e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure nulla" } ], "inactive": true, "_meta": { "created": "1971-03-19T20:57:16.789Z", "updated": "2011-10-17T10:42:03.396Z", "migrationVersion": -99125400 } }, "default" ], "iterations": [ "e4fE43a0-81be-93b2-deB8-C6D50b733FC1", "5a2FD76A-D68E-d2dF-8C45-4C59e49AdC7e", "E24bcBB4-C48D-9ADf-6E75-1B1d73B1C14F", "BFbC2EBb-0509-a4Be-C2a7-583b0FAedF92" ], "x": -73591472.26670907, "y": 34365502.06788698, "gridCoordinate": { "x": -69961065.88981004, "y": -16613059.123026684 }, "name": "voluptate dolore in sint", "location": "Application", "locationType": "dolore ut Lorem quis voluptate", "app": "tempor elit Duis", "canvasName": "do deserunt ullamco", "displayName": "dolor dolor dolore", "summary": "pariatur reprehenderit eiusmod", "description": "Duis esse", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/oIu/s8hce,I1/~0/~0/~0/wQ69/VwWx" }, { "type": "encryption", "pointer": "/~0/pyuuTiIzlt9" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "sint dolor proident in", "highlightString": "labore quis" }, { "key": "officia dolore cupidatat dolore", "highlightString": "Duis cillum adipisicing incididunt proident" }, { "key": "ut magna occaecat nostrud", "highlightString": "et nostrud in adipisicing Lorem" }, { "key": "ipsum cillum", "highlightString": "dolore consequat dolore" }, { "key": "mollit officia quis sunt", "highlightString": "pariatur est officia esse cupidatat" } ], "status": "complete", "previous": { "incomplete": [ "3a1f", "workflow_start", "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "3a1f", "workflow_start", "3a1f" ], "error": [ "workflow_end", "workflow_start", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "ex elit magna voluptate veniam", "start_time": "2022-02-15T07:44:02.452Z", "end_time": 66536650.64927176, "finish_state": "success", "retrySettings": { "state": [ "failure", "success", "success", "error", "failure" ], "autoRetry": true, "limit": 75340892, "delay": 24523547, "count": 68782428, "finishedRetrying": false }, "type": "automatic" }, "workflow_start": { "x": 72075623.41280678, "y": 30416484.478718743, "gridCoordinate": { "x": -26603471.80635822, "y": -72635356.65555389 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -57424273.493741795, "finish_state": "error", "user": "Pronghorn" }, "groups": [ { "_id": "a27b9e19decfbbea2947ce16", "provenance": "qui culpa sunt laboris", "name": "exercitation", "description": "et sit in eiusmod non", "memberOf": [ { "groupId": "c45633583b311ddd56cbab39", "aaaManaged": false }, { "groupId": "500f6f3996eca7dfa25eceef", "aaaManaged": true }, { "groupId": "93247c28f5efee69f1945ba2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud esse" }, { "roleId": "dolor" }, { "roleId": "labore" }, { "roleId": "dolor" } ], "inactive": false, "_meta": { "created": "1999-04-15T20:30:54.986Z", "updated": "2019-08-27T10:53:07.403Z", "migrationVersion": 92017634 } }, { "_id": "89d1174f33b8b86b2ef345b2", "provenance": "ad cupidatat nisi eiusmod", "name": "aliqua dolore reprehenderit", "description": "mollit ut esse exercitation", "memberOf": [ { "groupId": "57740e06ddf5fdb000d2649b", "aaaManaged": true }, { "groupId": "28729c2e7a9b8190ca9ec922", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut" }, { "roleId": "sint elit" }, { "roleId": "proident ea culpa sit in" }, { "roleId": "aliquip esse occaecat" }, { "roleId": "aute et eiusmod in nulla" } ], "inactive": true, "_meta": { "created": "1988-07-29T19:16:16.089Z", "updated": "1999-01-04T18:22:48.004Z", "migrationVersion": -85751455 } }, "default", { "_id": "f65fb74f822c49b5fb1c0ea1", "provenance": "pariatur reprehenderit", "name": "ea ipsum aute veniam laboris", "description": "mollit eiusmod sed enim dolore", "memberOf": [ { "groupId": "050e19fa99c5d5399bd8b788", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex pariatur consequat" }, { "roleId": "deserunt veniam" } ], "inactive": true, "_meta": { "created": "1947-10-04T03:54:07.374Z", "updated": "1971-05-03T23:17:59.001Z", "migrationVersion": 56265133 } } ], "iterations": [] }, "workflow_end": { "x": 58427747.37708193, "y": 63729604.06985456, "gridCoordinate": { "x": -42514535.171994835, "y": 72990205.11596578 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_start", "e28f", "error_handler" ], "error": [ "workflow_end", "error_handler", "workflow_end" ] }, "metrics": { "end_time": 15595486.73767814, "run_time": 59265043.01646069 }, "groups": [ { "_id": "80e160002a4429bfb282f622", "provenance": "ex voluptate laborum", "name": "labore", "description": "dolor ea pariatur", "memberOf": [ { "groupId": "6b7454b74f03451ebce626b0", "aaaManaged": true }, { "groupId": "a6cf0f392c71452e61c11153", "aaaManaged": true }, { "groupId": "57c9af668ae5f23dbc7e296e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute cillum voluptate" }, { "roleId": "fugiat dolor ut sed est" } ], "inactive": false, "_meta": { "created": "1968-05-31T10:10:58.26Z", "updated": "2017-11-12T01:00:37.459Z", "migrationVersion": -29813219 } }, "e161195bf9e22ab2e849fb68", "75d53801c17aad9be4381ccb", "default", { "_id": "71f617119729930777a875da", "provenance": "Ut elit est aliquip velit", "name": "nulla", "description": "in", "memberOf": [ { "groupId": "277846b96cb38ca2800eb600", "aaaManaged": true }, { "groupId": "d5131a01c9f7db78c778ba78", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt laboris commodo amet" }, { "roleId": "ullamco consectetur dolore sit culpa" }, { "roleId": "pariatur nostrud nisi" }, { "roleId": "proident consectetur aute" }, { "roleId": "Ut dolore eu" } ], "inactive": true, "_meta": { "created": "1967-06-25T02:03:08.964Z", "updated": "1966-09-10T13:30:06.37Z", "migrationVersion": 24476704 } } ], "iterations": [ "0b48F6Db-483A-Ff64-C262-2acFeacA3FDD" ] }, "error_handler": { "x": -17798729.457956105, "y": 35162844.88718492, "gridCoordinate": { "x": -46646267.35677686, "y": 75762227.38012502 }, "name": "childJob", "location": "Adapter", "locationType": "dolore ea aliqua adipisicing", "app": "minim", "canvasName": "qui esse est fugiat in", "displayName": "eiusmod sint", "summary": "mollit velit incididunt amet", "description": "eiusmod sint", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/jKV-/~0/n0rVsl/EYN/~1/~1" }, { "type": "encryption", "pointer": "/OFyykkvH/~1/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ut dolor sit", "highlightString": "pariatur commodo ipsum nisi" }, { "key": "in qui eu", "highlightString": "consequat qui esse et" }, { "key": "quis dolor elit mollit", "highlightString": "proident ex sit in" }, { "key": "magna elit consectetur proident", "highlightString": "cillum ad" }, { "key": "ad ullamco", "highlightString": "aute" } ], "status": "incomplete", "previous": { "incomplete": [ "3a1f", "3a1f", "3a1f", "workflow_start" ], "complete": [ "workflow_end", "e28f" ], "error": [ "workflow_start", "workflow_start", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "in", "start_time": "1958-10-16T13:20:58.695Z", "end_time": -20347666.386616096, "finish_state": "error", "retrySettings": { "state": [ "failure", "error" ], "autoRetry": true, "limit": 75674241, "delay": 84909270, "count": 93500854, "finishedRetrying": true }, "type": "operation", "actor": "bd95847eb5dab6ab2b6d4ef6", "groups": [ { "_id": "57129a431128af983d12c7ea", "provenance": "Duis et", "name": "sunt labore ullamco", "description": "incididunt do proident consequat", "memberOf": [ { "groupId": "464bf2a06467e8cedfda145c", "aaaManaged": false }, { "groupId": "3fd32ee893810e460e12444a", "aaaManaged": false }, { "groupId": "a628749cc4fa75e19b70b1c2", "aaaManaged": true }, { "groupId": "45e9febfd9339fbe29e62c3b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat deserunt" }, { "roleId": "nostrud" }, { "roleId": "veniam laborum" }, { "roleId": "non culpa dolore est irure" } ], "inactive": false, "_meta": { "created": "1963-05-21T00:19:52.113Z", "updated": "2021-10-11T10:25:04.504Z", "migrationVersion": 6285090 } } ], "iterations": [ "2987Efe3-7436-a8AA-6A1b-6FFE8aEfbcbb", "e5CBD1da-7A2D-85Ab-DECB-74f50EfCa7BC" ] } }, "parent": { "task": "dolore nostrud fugiat ut", "iteration": 1882357.6471218616, "element": -50839241.10953522 }, "errorHandler": null, "groups": [ "default" ], "watchers": [ { "_id": "ac8e87fa5103bfe92fd60151", "provenance": "sint aliqua", "username": "aliquip", "firstname": "et nulla dolore", "memberOf": [ { "groupId": "16c79f458140ecaf97e6bb25", "aaaManaged": false }, { "groupId": "2abdd8edfc1bff4b020f2211", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor aliqua eu in adipisicing" }, { "roleId": "cillum Duis culpa in" }, { "roleId": "consequat reprehenderit deserunt adipisicing" }, { "roleId": "tempor cillum" }, { "roleId": "et" } ], "inactive": true, "lastLogin": "1966-06-12T09:15:56.8Z", "_meta": { "created": "1995-10-19T05:29:10.731Z", "updated": "2020-06-26T12:17:20.99Z", "migrationVersion": -65017713 }, "email": "tempor cillum" }, "Pronghorn", "e43aaa95f5ab3956b75a66f8", "6d797a573026db14d71cfcb1" ], "metrics": { "start_time": -54571543.04320353, "progress": 0.0722440794796475, "end_time": 4475857.091419041, "user": { "_id": "d382a61071eff378bf74615e", "provenance": "sed", "username": "Ut Duis sint irure aute", "firstname": "et", "memberOf": [ { "groupId": "588d301b029e2fa7a8862d4d", "aaaManaged": true }, { "groupId": "fd41afec454383522c8e6783", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do" }, { "roleId": "dolor enim amet id irure" }, { "roleId": "non dolor in Duis aute" } ], "inactive": true, "lastLogin": "1952-11-19T13:08:14.6Z", "_meta": { "created": "2007-06-07T07:57:55.248Z", "updated": "1992-03-24T00:00:50.177Z", "migrationVersion": 32467735 }, "email": "mollit" }, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }