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": "b1667d1eb114c7e6f533d4f1", "uuid": "e5ebae31-c1d2-3f5d-c3a1-6f4b7a4b1715", "font_size": -99169391, "type": "resource:action", "created": "2021-10-03T02:08:48.867Z", "last_updated": "2014-03-18T11:07:20.798Z", "createdVersion": "99639437741.3211511.85727", "lastUpdatedVersion": "99977.2427655460.7126373625-0094.97874.129764184.79923720", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 51087774, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -3999577.614410788, "sla": 95025547.82985198, "decorators": [ { "type": "encryption", "pointer": "/kvRD/~1/IwwNEhyBW/FrkBK6u//~0/~0/dGujSjFlr2E/~1/~1/Dr+XVAVydqO" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~0/eYfV7dBw8/~0/I9/uK0qaP" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/m0+NUQ/~0/~1/~0/~0/HyX/~0/CFA" } ], "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 } ], "warnings": [ { "task": "e28f", "name": "myCoolDocumentName", "message": "mollit voluptate velit dolore consequat" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "pariatur sint eu" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "pariatur in tempor aliquip exercitation" } ], "ancestors": [ "f7ea6c13ccfc951599dd1be5", "7c618f8cd6f2665413a3f92b", "d7a653984786ea1b2f520780", "92c92590a0550ed46361f969" ], "validationErrors": [ { "keyword": "officia nulla elit anim mollit", "instancePath": "dolore", "schemaPath": "amet et quis ullamco sed", "message": "in veniam elit" }, { "keyword": "aute et minim sit incididunt", "instancePath": "quis", "schemaPath": "incididunt id", "message": "labore amet" }, { "keyword": "Duis velit", "instancePath": "aute irure in", "schemaPath": "consectetur magna", "message": "in cupidatat aliquip et incididunt" }, { "keyword": "cupidatat velit", "instancePath": "exercitation elit nostrud", "schemaPath": "do enim ipsum", "message": "voluptate cupidatat adipisicing ipsum laborum" }, { "keyword": "commodo", "instancePath": "Lorem dolor consectetur", "schemaPath": "laboris labore incididunt ut nulla", "message": "ullamco" } ], "created_by": null, "last_updated_by": { "_id": "9e53af023410d50a7d0b5bef", "provenance": "sint est enim", "username": "mollit", "firstname": "magna nisi exercitation", "memberOf": [ { "groupId": "c25444a1525b3a85510fb6ce", "aaaManaged": true }, { "groupId": "a8cf7441a0d39d6016272270", "aaaManaged": true }, { "groupId": "67bf66d4b834a779d9b3e0f8", "aaaManaged": true }, { "groupId": "d8b6afa2ff2b3fe9ab0bed84", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat Duis dolor consectetur mollit" }, { "roleId": "adipisicing dolor aliqua voluptate cillum" }, { "roleId": "adipisicing sed anim" }, { "roleId": "sunt ipsum laboris nostrud" } ], "inactive": true, "lastLogin": "2019-05-08T04:32:08.886Z", "_meta": { "created": "1975-08-24T02:42:18.097Z", "updated": "2003-11-22T12:38:01.929Z", "migrationVersion": -77984239 }, "email": "do" }, "tasks": { "workflow_start": { "x": 73241974.97814482, "y": -55453428.5268145, "gridCoordinate": { "x": -19066537.102229163, "y": 26673941.248743027 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -82412326.37223952, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "default", "16086f28cbbd2b0733a01880", { "_id": "4a82d0a5929c1f2057595471", "provenance": "ex mollit incididunt id", "name": "ullamco cupidatat ut", "description": "sint labore", "memberOf": [ { "groupId": "df5911e71d9875c6dc4f8dfe", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse anim do ex ipsum" } ], "inactive": false, "_meta": { "created": "1968-12-23T07:30:18.582Z", "updated": "1956-03-21T02:06:25.4Z", "migrationVersion": 53062979 } } ], "iterations": [ "ab8c7124-cFa4-75a0-9cEc-C77D423cB0b2" ] }, "workflow_end": { "x": -29461583.30388844, "y": -83808261.19133848, "gridCoordinate": { "x": -24764820.309084132, "y": -5373079.392103538 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "e28f" ], "complete": [ "workflow_end", "workflow_end", "e28f", "workflow_start" ], "error": [ "workflow_end", "3a1f", "workflow_start", "error_handler" ] }, "metrics": { "end_time": -91325537.748213, "run_time": 95474447.2285313 }, "groups": [ "56a258171a83b56acaea095f", "default", { "_id": "46321f3b9999670262418186", "provenance": "velit ullamco amet", "name": "Duis nostrud id voluptate", "description": "pariatur ullamco mollit ea", "memberOf": [ { "groupId": "572bf9af3aa4b5d90ba18dc5", "aaaManaged": true }, { "groupId": "d810a7303b33e8f0817b5f83", "aaaManaged": false }, { "groupId": "c791c45067f0b5b9e6375d2f", "aaaManaged": false }, { "groupId": "2529794152d1a054d3e23402", "aaaManaged": false }, { "groupId": "b9dc98396e9848079bcafc30", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor laborum labore in in" } ], "inactive": false, "_meta": { "created": "1998-05-14T11:11:21.022Z", "updated": "1958-02-04T16:39:33.414Z", "migrationVersion": 95711696 } }, { "_id": "760d3516d01314b605b32762", "provenance": "deserunt irure", "name": "consectetur eu id", "description": "pariatur veniam elit occaecat", "memberOf": [ { "groupId": "5237ad359e7eb7ae6999b32f", "aaaManaged": true }, { "groupId": "78afc9af124171b0e61b2672", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation Lorem fugiat proident aliquip" }, { "roleId": "culpa ut exercitation" }, { "roleId": "aute tempor non et" }, { "roleId": "proident pariatur" }, { "roleId": "ex laboris" } ], "inactive": true, "_meta": { "created": "1999-12-16T19:32:54.77Z", "updated": "1958-07-30T22:38:34.165Z", "migrationVersion": -23893836 } } ], "iterations": [] }, "error_handler": { "x": 94461351.789186, "y": 19986248.16755469, "gridCoordinate": { "x": 5348123.198029861, "y": -19291289.52711889 }, "name": "childJob", "location": "Application", "locationType": null, "app": "est dolor eu exercitation", "canvasName": "eiusmod aliquip", "displayName": "proident", "summary": "Excepteur reprehenderit elit dolor", "description": "commodo cillum nostrud ullamco", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/gendiW-L/~0/BRU/~1/~1/~1/gE4yKL9n/~0/U/GkAQVxG8iW/TG," }, { "type": "encryption", "pointer": "/~1/~1/~1/phItiNLcQ/~1/~1" }, { "type": "encryption", "pointer": "/iHH/~1/~0/~1/s9yhEP/pV4c1l8UAP/AWTQNYaLH+/F8OI8pF+/HW.7G/~1" }, { "type": "encryption", "pointer": "/P/JXMEe-/B60eBoetAm0/~0/VO6o2/f8ls/~1/fDTE9CdVs5/~1/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "nulla pariatur sit magna sunt", "highlightString": "eiusmod ut occaecat cillum" }, { "key": "voluptate ut", "highlightString": "in reprehenderit sunt culpa" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "e28f", "e28f" ], "complete": [ "workflow_start", "workflow_start", "error_handler", "workflow_end" ], "error": [ "workflow_start", "workflow_start", "3a1f", "workflow_start", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "labore dolore fugiat", "start_time": "1973-06-13T16:17:11.16Z", "end_time": 97373430.66621453, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "e9262030845fe88db7ca05ce", "856fc758b04735e3384663c2", { "_id": "dd418ebb2cacfbb684a9b5d1", "provenance": "elit dolore", "name": "minim deserunt aliquip fugiat", "description": "dolor ea Excepteur nisi", "memberOf": [ { "groupId": "b4b109ee2ddc73eb04af6795", "aaaManaged": false }, { "groupId": "284c9dfde92b0a16b0decf35", "aaaManaged": true }, { "groupId": "51ac038a9b6b8c1e582fb852", "aaaManaged": false }, { "groupId": "2e0e28d4f77d556b16b80063", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur quis" } ], "inactive": true, "_meta": { "created": "1998-04-05T21:47:59.214Z", "updated": "1956-08-15T14:55:18.945Z", "migrationVersion": -9634710 } } ], "iterations": [] }, "c7c": { "actor": null, "groups": [ "6375b68ffa5263e799dd5d68" ], "iterations": [ "4F4cEeCb-FB5e-cf3B-3Fef-52fb58Eff7C3", "9B9E8dD8-84d9-c473-41f7-2316D7F2F6Ca" ], "x": -27887949.27954492, "y": -15124121.987430915, "gridCoordinate": { "x": 39416069.98519349, "y": -39521098.037916325 }, "name": "dolore quis tempor", "location": "Application", "locationType": "tempor", "app": "cillum nostrud laboris Excepteur ad", "canvasName": "anim veniam dolore enim fugiat", "displayName": "proident adipisicing ut ad magna", "summary": "exercitation esse aliqua proident", "description": "mollit quis sint in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/K3OXq,NWbnO/~1/UcLx/~1/xWrNmU+U/~0/GW" }, { "type": "encryption", "pointer": "/BmSUWy9Pc/~0/dF/~0/~0/Lyydj4s" }, { "type": "encryption", "pointer": "/yL7dQwK/mhy4u,SyP/~0/hCOHg9wn" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ad ut", "highlightString": "velit" }, { "key": "adipisicing nulla magna cupidatat", "highlightString": "veniam sunt" }, { "key": "esse ullamco", "highlightString": "dolore pariatur anim sint" }, { "key": "reprehenderit", "highlightString": "incididunt dolor esse id" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "e28f" ], "complete": [ "workflow_start", "e28f", "workflow_start", "workflow_start" ], "error": [ "workflow_start", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "e28f", "type": "loop" } ] }, "serverId": "qui deserunt ipsum nisi consectetur", "start_time": "2024-10-18T05:18:05.706Z", "end_time": -94536693.20704186, "finish_state": "failure", "retrySettings": null, "type": "manual", "view": "est" } }, "parent": { "job": "irure nisi aliqua", "task": "ad Duis mollit", "iteration": 38574658.550949425, "element": 17644693.359418496 }, "errorHandler": null, "groups": [ { "_id": "42ba5e8c456547c2093fc69c", "provenance": "tempor ut dolor aliqua mollit", "name": "in do", "description": "Lorem dolore velit in", "memberOf": [ { "groupId": "f38738345602269c38630065", "aaaManaged": false }, { "groupId": "bd84d0beeed10c80f5d4caf9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eu exercitation" } ], "inactive": true, "_meta": { "created": "1948-08-24T08:41:08.472Z", "updated": "1957-07-27T10:42:59.769Z", "migrationVersion": 75693722 } } ], "watchers": [ "Pronghorn", null, null ], "metrics": { "start_time": -24082826.356236666, "progress": 0.00006638186305285565, "end_time": 5603859.389030591, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }