Summary
Run Endpoint Trigger With POST
Description
Runs the Automation associated with the API Trigger.
Route
POST /operations-manager/triggers/endpoint/:routeName
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
routeName | string | yes | The routeName of the API Trigger. |
body | object | yes | Any key-value pairs in the POST body will be used to create job variables. |
{}
{ "title": "body", "type": "object", "properties": {}, "additionalProperties": true }
Return
Name | Type | Description |
---|---|---|
result | object | The spawned Job. |
{ "message": "Successfully created the requested item", "data": { "_id": "77d8a4ac998143c3e9205d8a", "font_size": 87162882, "type": "automation", "created": "2003-04-12T07:39:01.31Z", "last_updated": "1987-05-31T21:21:47.093Z", "createdVersion": "8486.61563618586.39996342-7513.317201495.84188942548.48428055", "lastUpdatedVersion": "61323966.3.942654", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 87747453, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 39460570.88281223, "sla": 87798431.13935483, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/Z-qJuc+/YVH-/~1/f,wYPzlX2/" }, { "type": "encryption", "pointer": "/~0/~1/YlnhC6Ao75" }, { "type": "encryption", "pointer": "/~0/~0/~0/I" } ], "status": "complete", "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": "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": "velit dolore Ut" } ], "ancestors": [ "8d86c8f60781d0f674126b7e" ], "validationErrors": [ { "keyword": "exercitation dolore velit", "instancePath": "sed", "schemaPath": "minim", "message": "ullamco laboris eu non" }, { "keyword": "elit est", "instancePath": "dolore elit dolor ut voluptate", "schemaPath": "Duis in ut deserunt", "message": "occaecat" }, { "keyword": "occaecat Lorem Excepteur proident", "instancePath": "consequat sint", "schemaPath": "qui consectetur velit proident irure", "message": "dolor" }, { "keyword": "velit Duis irure deserunt", "instancePath": "in laboris veniam sit incididunt", "schemaPath": "labore incididunt non do in", "message": "elit sint Duis cupidatat et" }, { "keyword": "qui sit magna", "instancePath": "sunt", "schemaPath": "exercitation aute", "message": "sed cillum adipisicing in deserunt" } ], "created_by": { "_id": "c8e43afcde338b8a7f7faf2d", "provenance": "in", "username": "id", "firstname": "nulla", "memberOf": [ { "groupId": "74314ee773496e8140a80a74", "aaaManaged": false }, { "groupId": "811168daf523bc6268e0cb6d", "aaaManaged": true }, { "groupId": "b82eb77ba694bbe4214c64a6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem ex elit ea" }, { "roleId": "consectetur ut aute" }, { "roleId": "nulla" }, { "roleId": "laborum enim" }, { "roleId": "tempor" } ], "inactive": true, "lastLogin": "1988-05-12T06:10:48.334Z", "_meta": { "created": "1964-09-01T19:59:36.55Z", "updated": "1982-06-15T13:45:17.54Z", "migrationVersion": -36320603 }, "email": "ea ad reprehenderit magna sit" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -12083255.060128152, "y": 69750504.74183014, "gridCoordinate": { "x": 88284466.86696222, "y": -63048539.56299885 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 26469470.10824126, "finish_state": "error", "user": "ce8fcdd12df91ffd4ba34732" }, "groups": [ "default", "dfa32743af72f9ecd876d35e", { "_id": "2617a4c189576201a3c43838", "provenance": "deserunt amet nulla ullamco ad", "name": "Ut velit deserunt in", "description": "magna", "memberOf": [ { "groupId": "d69dc8949d4295f5145ff027", "aaaManaged": false }, { "groupId": "1a105fb9996a83001e2e6392", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do consequat" }, { "roleId": "mollit aliqua eu do" } ], "inactive": true, "_meta": { "created": "1950-02-16T16:10:51.826Z", "updated": "2008-03-14T21:08:35.115Z", "migrationVersion": -53684733 } }, { "_id": "1eb7685af6dd87b9aa9e7980", "provenance": "occaecat dolor dolore sint", "name": "mollit", "description": "amet proident tempor aliquip dolor", "memberOf": [ { "groupId": "fe423e378e3f0753c250d775", "aaaManaged": true }, { "groupId": "475e10360b12ea7c31ea1393", "aaaManaged": false }, { "groupId": "8d3e026f7a96bf7d44a9e18e", "aaaManaged": false }, { "groupId": "b1c217a7ab4603575c821022", "aaaManaged": true }, { "groupId": "fe2689668dcd607f61e9726b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit Lorem" } ], "inactive": false, "_meta": { "created": "1954-04-21T17:29:55.521Z", "updated": "1998-01-01T06:03:48.317Z", "migrationVersion": 40433818 } }, "default" ], "iterations": [ "dbD4Aa4D-7CA9-6aC6-4a22-bFbcf0B942D7", "ad2bb8D8-366B-f63B-5ed4-e37c4c0753A4", "d9A8cF07-F7D6-4060-8843-49ccAb14fAb7", "7CdD1e4a-D862-02C3-2aa4-CeD812e1eE5B" ] }, "workflow_end": { "x": -63772182.57317665, "y": -52543861.5009719, "gridCoordinate": { "x": -58288611.271540344, "y": -41256393.04075075 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "3a1f", "workflow_start", "3a1f" ], "error": [ "workflow_end", "3a1f", "e28f", "error_handler", "workflow_start" ] }, "metrics": { "end_time": -99429493.9380452, "run_time": -12129583.920587987 }, "groups": [ "default", "default" ], "iterations": [ "1B79461F-FcBD-aeAd-2966-049bAD1AaD0E", "a6433c5C-B1C4-37B8-cFC8-CCb8ee9Cceda" ] }, "error_handler": { "x": -26056154.598429024, "y": 33230554.07790187, "gridCoordinate": { "x": -24098054.518014684, "y": 15991882.497931093 }, "name": "childJob", "location": "Application", "locationType": "est", "app": "Excepteur incididunt", "canvasName": "elit pariatur tempor cillum dolore", "displayName": "elit id reprehenderit", "summary": "exercitation laboris", "description": "Excepteur eu", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/YEU2b0/EHq46H/aNA/~1/MirFTSd-/~0/~0/ec0Gf-cO" }, { "type": "encryption", "pointer": "/x/ssWCqSXSd/gwRGF/x4/TgQA/a" }, { "type": "encryption", "pointer": "/~0/c6E88UUACr/Xv-A/jPVGpz,-4,i/~1/TnPJyvfQ/~1" }, { "type": "encryption", "pointer": "/bTIFlZ/r/X9dkaW/~1/pshvTY,./~1/~0/YIxK/~0/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "consequat", "highlightString": "labore in ad" }, { "key": "sunt magna", "highlightString": "id et" }, { "key": "incididunt ipsum adipisicing", "highlightString": "mollit nisi est labore in" }, { "key": "veniam laboris voluptate", "highlightString": "labore ut eiusmod" } ], "status": "failure", "previous": { "incomplete": [ "e28f", "e28f", "3a1f", "e28f", "3a1f" ], "complete": [ "workflow_start", "3a1f", "3a1f", "workflow_end" ], "error": [ "e28f", "3a1f", "workflow_end", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "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": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "standard" } ] }, "serverId": "enim sunt officia", "start_time": "2002-02-12T20:10:31.741Z", "end_time": -32118243.379385754, "finish_state": "success", "retrySettings": { "state": [ "error", "failure", "error" ], "autoRetry": false, "limit": 3887853, "delay": 45388943, "count": 82296585, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ "default", "default", "default" ], "iterations": [ "8d50f2C6-4d62-cA8f-40e5-df87BEd3Ff32" ] }, "30a8": { "x": 40958937.09023398, "y": -93132758.00559197, "gridCoordinate": { "x": -69723933.32105517, "y": 42257557.48351291 }, "name": "dolore fugiat veniam Duis", "location": "Broker", "locationType": null, "app": "dolor velit ut", "canvasName": "proident consectetur irure et sint", "displayName": "culpa ex sit", "summary": "voluptate amet", "description": "tempor eu", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/bGRFqS/Cgr1nLU7" }, { "type": "encryption", "pointer": "/~1/a5+e9" }, { "type": "encryption", "pointer": "/yUpkJ9RIE/~1/PNBO/~1/LffZS/~1" }, { "type": "encryption", "pointer": "/he" }, { "type": "encryption", "pointer": "/RF" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "cillum laboris qui veniam", "highlightString": "Duis eiusmod in anim" }, { "key": "sed", "highlightString": "est anim pariatur dolor officia" }, { "key": "velit Ut", "highlightString": "adipisicing commodo" }, { "key": "Ut anim incididunt dolore", "highlightString": "eiusmod enim cupidatat" }, { "key": "aliquip amet id officia incididunt", "highlightString": "qui officia cillum" } ], "status": "incomplete", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_start" ], "error": [ "3a1f", "3a1f", "workflow_start", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "laborum ad ut veniam", "start_time": "1971-10-06T06:33:20.919Z", "end_time": -18310740.51422155, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "865df4ca931ba7628fc68806", "default", "722f9de96fab4a17f6c3a960", "default", "d17f7169bcb9385704d69dcd" ], "iterations": [] } }, "parent": { "task": "qui adipisicing sed non magna", "iteration": 91288035.43768746, "element": 37112966.96688181 }, "errorHandler": { "x": -6821029.465947732, "y": -67259631.80979103, "gridCoordinate": { "x": 17710368.85804893, "y": 75080380.50382707 }, "name": "elit", "location": "Adapter", "locationType": "minim adipisicing culpa", "app": "cupidatat sed tempor", "canvasName": "laboris aliquip cupidatat", "displayName": "consectetur sunt cillum id aliqua", "summary": "Excepteur", "description": "incididunt dolore deserunt esse sit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/juqR/jtluicI42/~1/lgQGX5Y/QPYCBPoN/~0/fGHqX2/H0Xu/~0/b7ZF6uyh7Zc" }, { "type": "encryption", "pointer": "/w" }, { "type": "encryption", "pointer": "/uH00g/~1/~1/Qi5jK/trd5h.S/~1/G9-vc,Wc-Rr/~0" }, { "type": "encryption", "pointer": "/~1/~1/~1/~0/~0/WNWwWg/~1/v9c/J3u/zImjn/g" }, { "type": "encryption", "pointer": "/~1/awsXb8oXI" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "Duis Ut elit aliquip", "highlightString": "aliqua qui" }, { "key": "tempor sint et ea Excepteur", "highlightString": "in labore Lorem reprehenderit" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "3a1f", "workflow_start" ], "complete": [ "workflow_end", "error_handler" ], "error": [ "workflow_start", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" } ] }, "serverId": "velit Duis consectetur", "start_time": "1954-03-04T09:09:44.406Z", "end_time": -64361221.73324828, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "ada05078757d3abfbeca6944", "provenance": "tempor aliquip ex sint", "name": "incididunt ullamco", "description": "sint cupidatat", "memberOf": [ { "groupId": "db03656e699ee82a944e4993", "aaaManaged": false }, { "groupId": "3fcede96a6220528bc75b4d7", "aaaManaged": false }, { "groupId": "850afadf05b9f2f7662b5a64", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui sunt" }, { "roleId": "occaecat ad" }, { "roleId": "irure Lorem id sed" }, { "roleId": "quis exercitation ad aliqua" } ], "inactive": false, "_meta": { "created": "1983-02-22T21:45:10.98Z", "updated": "1975-07-09T10:47:53.393Z", "migrationVersion": -20592775 } }, { "_id": "a34945b08cfd2197384ae616", "provenance": "ipsum sit", "name": "ea fugiat dolore magna irure", "description": "voluptate minim cillum Ut aliquip", "memberOf": [ { "groupId": "79e63a2e5903e10c730e6ff8", "aaaManaged": true }, { "groupId": "98bbfd6bb4a04059f51a0dbb", "aaaManaged": true }, { "groupId": "6b56dd8d39ce8337b0c9381c", "aaaManaged": true }, { "groupId": "9b004528786c9bce572b0b48", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed tempor id aliqua" } ], "inactive": true, "_meta": { "created": "1972-01-08T17:53:02.825Z", "updated": "1998-11-23T13:48:27.238Z", "migrationVersion": 87175757 } } ], "iterations": [ "1ec913e8-baFD-1d2A-8Ae6-928CbdDc6fe7" ] }, "groups": [ { "_id": "2f536dd88b2e68ea7a5ce139", "provenance": "proident anim", "name": "ea dolore eiusmod nostrud", "description": "aliquip culpa irure", "memberOf": [ { "groupId": "ec4275827bb5744b287b910c", "aaaManaged": true }, { "groupId": "fd2e8aebf9795d2792b8067b", "aaaManaged": false }, { "groupId": "fbd25ffbfae6a93543279249", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation commodo ullamco nisi" }, { "roleId": "in elit proident" }, { "roleId": "culpa laborum non mollit" } ], "inactive": true, "_meta": { "created": "2004-08-16T05:56:16.757Z", "updated": "2022-02-26T22:39:46.187Z", "migrationVersion": 67147465 } }, "0715e2cb68620cfbb519e3cf", "6bb6444633b3bf21f3e20d68", "feb91bdfb29bcb34dc7ce1d6", { "_id": "a546bdbe00d1a97b37528357", "provenance": "adipisicing ut reprehenderit dolore", "name": "ullamco sed", "description": "sit adipisicing", "memberOf": [ { "groupId": "1bd90f4708d913b2b02b740b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam" }, { "roleId": "eiusmod culpa fugiat elit sed" } ], "inactive": true, "_meta": { "created": "1959-11-14T21:29:31.296Z", "updated": "1973-02-27T10:21:13.022Z", "migrationVersion": 55328988 } } ], "watchers": [ null, "Pronghorn", "3ebc7c38984527be0c2487c4", null ], "metrics": { "start_time": -40219403.79227984, "progress": 0.184624538710207, "end_time": 15580670.660695046, "user": "038d10eb5a93175792b9cbf8", "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }