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": "bb021181c4237719dab2fcbd", "uuid": "260130d6-68d9-695c-28dd-fecb39975911", "font_size": -68762704, "type": "resource:action", "created": "1976-05-20T11:52:27.95Z", "last_updated": "1963-10-02T20:59:36.915Z", "createdVersion": "5386384638.28961.625029080", "lastUpdatedVersion": "1880488364.533190.314900416", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 70826843, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 38559009.54512656, "sla": -20332070.49177301, "decorators": [ { "type": "encryption", "pointer": "/Kx-f//IIx0d/qxw" } ], "status": "paused", "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": "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 }, { "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": "aliqua consequat sint" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": [ "2d64bf3b99265e12213493a1", "451aca37b4d614ed14f39eb0", "bafdcbbedd3bc65f6d10c5d8", "e28b5967dedc13b0bb3e98c7" ], "validationErrors": [ { "keyword": "ea eiusmod laborum commodo", "instancePath": "cupidatat in exercitation", "schemaPath": "ea proident consectetur sed", "message": "dolore eiusmod fugiat" }, { "keyword": "quis qui dolor in velit", "instancePath": "adipisicing labore", "schemaPath": "laborum", "message": "laboris tempor Duis" }, { "keyword": "enim incididunt non exercitation voluptate", "instancePath": "ut ipsum proident", "schemaPath": "adipisicing Excepteur sit", "message": "laboris Ut deserunt do magna" }, { "keyword": "mollit", "instancePath": "sunt", "schemaPath": "est", "message": "deserunt in nulla magna" }, { "keyword": "cillum ullamco", "instancePath": "in velit commodo consequat sit", "schemaPath": "eiusmod adipisicing in laborum", "message": "reprehenderit" } ], "created_by": { "_id": "f5b8a4bdaf978d6d831782b6", "provenance": "dolore esse dolor", "username": "voluptate labore dolore", "firstname": "ad reprehenderit incididunt tempor", "memberOf": [ { "groupId": "f6d854193dce43aa5cc00a4b", "aaaManaged": false }, { "groupId": "8bb74cb24dc16c4b902ef5ab", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim ut" }, { "roleId": "dolore sed sit culpa esse" } ], "inactive": false, "lastLogin": "2024-03-27T23:32:42.244Z", "_meta": { "created": "1963-09-04T00:27:00.649Z", "updated": "1993-03-19T17:01:21.398Z", "migrationVersion": -85595185 }, "email": "officia elit eu sed" }, "last_updated_by": { "_id": "078900248f3ad3dc0e1ec5a1", "provenance": "Duis", "username": "sint", "firstname": "in enim cillum", "memberOf": [ { "groupId": "6bbc01ce76892646f96153e4", "aaaManaged": false }, { "groupId": "87e686d4637d6b32679d8fad", "aaaManaged": false }, { "groupId": "de46accdaca6a07791868e60", "aaaManaged": true }, { "groupId": "618472e0b40b8f8af6ba2bdc", "aaaManaged": false }, { "groupId": "85cc05c0210bc4677ca3b0b4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor sed sit dolore culpa" }, { "roleId": "ex sit commodo dolore" }, { "roleId": "sint enim nostrud" } ], "inactive": true, "lastLogin": "1964-11-13T09:25:41.095Z", "_meta": { "created": "2014-03-25T04:52:42.87Z", "updated": "1988-09-21T23:33:23.443Z", "migrationVersion": -93092457 }, "email": "elit" }, "tasks": { "workflow_start": { "x": -1107719.1929739416, "y": -25055793.14075516, "gridCoordinate": { "x": -44262066.60508747, "y": 37258814.43671411 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 82360463.87263203, "finish_state": "error", "user": "6150ac682bccb22728652702" }, "groups": [ "default", "default", "805ffb92a2121ca72bcc71f3", "e6181e202f74961a8081ef61" ], "iterations": [ "ba4227DD-aE70-AB07-2EcA-FEc33F5E0C2A" ] }, "workflow_end": { "x": -26595409.111943975, "y": -16914853.95130022, "gridCoordinate": { "x": -41482575.545525655, "y": -41846436.835402526 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "e28f", "workflow_end", "3a1f" ], "complete": [ "workflow_end" ], "error": [ "workflow_start", "e28f", "error_handler", "e28f" ] }, "metrics": { "end_time": 96724974.8074475, "run_time": -65506802.27354997 }, "groups": [ "4210eb2643af7cbbfd5e661f", "default", "default", "default", { "_id": "96e735ee11188544a9c07f93", "provenance": "ut", "name": "qui amet occaecat in anim", "description": "culpa", "memberOf": [ { "groupId": "c0d3599256234548693dadbb", "aaaManaged": false }, { "groupId": "5c9538736d9e9b233955a22e", "aaaManaged": true }, { "groupId": "1d3168e325c3d2d646b6255b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui ut" }, { "roleId": "reprehenderit Excepteur" }, { "roleId": "deserunt dolore in" }, { "roleId": "et in" }, { "roleId": "nisi" } ], "inactive": true, "_meta": { "created": "2006-10-12T10:07:07.222Z", "updated": "1968-12-10T15:25:11.587Z", "migrationVersion": 15750292 } } ], "iterations": [ "24aAa0f2-E60e-FfD5-AbdA-fCDEb9f0AC7B" ] }, "error_handler": { "x": -35832056.609944776, "y": 66240782.00515017, "gridCoordinate": { "x": 7546924.097643301, "y": -60139858.7919713 }, "name": "childJob", "location": "Broker", "locationType": "nostrud cupidatat do sed enim", "app": "do", "canvasName": "veniam", "displayName": "ullamco enim minim", "summary": "et quis nisi proident in", "description": "minim ad", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/clnmXhIG/~1/RiPt/~1/eIGR/Ou/S-/~1" }, { "type": "encryption", "pointer": "/Yhkf/~1/~0/Z/ZkgrOGWX5/y,J88KMA" }, { "type": "encryption", "pointer": "/asI3Yz/Qmez/tGjM4XWBW4R" }, { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "ut aliquip", "highlightString": "pariatur anim" }, { "key": "magna esse consequat cupidatat in", "highlightString": "Duis anim" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "workflow_start", "error_handler", "error_handler" ], "complete": [ "error_handler", "e28f", "workflow_start", "workflow_end" ], "error": [ "e28f", "error_handler" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "aliqua in ut", "start_time": "1956-08-26T01:54:56.871Z", "end_time": 20236612.27103716, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default" ], "iterations": [ "6E4fA1b5-feeC-4cee-52AD-FDa3F799FFa4", "0A7df284-B7fd-F9DF-2669-84E57FCCD6ed" ] }, "bb": { "x": -91130097.49913213, "y": 3944980.647597298, "gridCoordinate": { "x": -63868020.70527682, "y": 10476753.88408637 }, "name": "officia do fugiat proident", "location": "Adapter", "locationType": "elit in", "app": "in eiusmod amet Lorem laboris", "canvasName": "nostrud aliquip et", "displayName": "sed officia", "summary": "voluptate et amet sit", "description": "Duis aliqua officia", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/WQ1pAjhYs+/M+mo/~0" }, { "type": "encryption", "pointer": "/~1/~0/~0/g8y.QCniV/~1/PXS9hesNbp/~0/~1/RbVtNddEN/~1" }, { "type": "encryption", "pointer": "/~1/~0/vY/~1/~0/z4N/~1/~0/~1/jX6rNSo/jozdWrUHlx" }, { "type": "encryption", "pointer": "/O/~1/~0/~0/YHVnGU/~1/px/lmFT/H,-p" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "id quis", "highlightString": "amet aute pariatur aliqua dolor" }, { "key": "consectetur officia", "highlightString": "dolor laborum consectetur nostrud" }, { "key": "labore in pariatur voluptate anim", "highlightString": "Duis pariatur veniam Excepteur" } ], "status": "error", "previous": { "incomplete": [ "3a1f", "workflow_end", "workflow_end", "workflow_start" ], "complete": [ "error_handler", "3a1f", "workflow_start", "3a1f", "3a1f" ], "error": [ "e28f", "workflow_start", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" } ] }, "serverId": "ad", "start_time": "2024-07-18T02:44:16.754Z", "end_time": -154654.01272787154, "finish_state": "failure", "retrySettings": { "state": [ "failure", "failure", "error" ], "autoRetry": false, "limit": 25151722, "delay": 97424758, "count": 26426768, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "f44f06e1b72bbd8dd98538e4", "e9efd1ebf4c4d02549e14d56" ], "iterations": [] } }, "parent": { "job": "laboris proident sed", "task": "Lorem minim est culpa esse", "iteration": -85723578.70966889, "element": -92274892.99420944 }, "errorHandler": { "x": -4368550.231532887, "y": 39104773.327237755, "gridCoordinate": { "x": 35125452.07004693, "y": 16124912.71018608 }, "name": "ut Duis commodo dolor quis", "location": "Adapter", "locationType": "aute nisi dolor voluptate", "app": "cillum", "canvasName": "aute", "displayName": "exercitation cillum reprehenderit", "summary": "officia", "description": "exercitation quis tempor nulla", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/kSh" }, { "type": "encryption", "pointer": "/GuFfOauk" }, { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/~1/~0/i.cxWITzp9/gM8Ewx/~0/~1" }, { "type": "encryption", "pointer": "/Oxn.TP/S/~1/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "dolor in consectetur", "highlightString": "dolore" }, { "key": "ad ullamco dolor nostrud", "highlightString": "dolor sit do" }, { "key": "magna in", "highlightString": "proident pariatur ut" }, { "key": "do eiusmod ex cillum", "highlightString": "ad" } ], "status": "paused", "previous": { "incomplete": [ "e28f", "workflow_start", "workflow_end" ], "complete": [ "e28f" ], "error": [ "workflow_start", "workflow_start", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "standard" } ] }, "serverId": "dolore id pariatur proident tempor", "start_time": "1948-02-05T15:19:28.503Z", "end_time": -68784990.79222879, "finish_state": "error", "retrySettings": { "state": [ "error", "failure", "failure", "failure" ], "autoRetry": false, "limit": 13683386, "delay": 54350302, "count": 81467169, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", "default", "default" ], "iterations": [] }, "groups": [ { "_id": "4956e927d4aa06200aff3cff", "provenance": "est consectetur ullamco incididunt do", "name": "exercitation Excepteur officia occaecat esse", "description": "consectetur velit occaecat fugiat", "memberOf": [ { "groupId": "95050702531b02ba4e2b0315", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt occaecat dolor fugiat magna" }, { "roleId": "et proident" }, { "roleId": "commodo in" }, { "roleId": "Excepteur in" }, { "roleId": "aute" } ], "inactive": true, "_meta": { "created": "1999-12-09T11:50:02.641Z", "updated": "1976-10-12T16:18:49.288Z", "migrationVersion": 81924776 } }, "cd35cd4db998a62cbc27c5a8", "default", { "_id": "55164406338a86db942db6c5", "provenance": "laboris anim", "name": "id dolore sit", "description": "laboris Ut sunt", "memberOf": [ { "groupId": "c3fdb5752a1cea4b4cd9d4b5", "aaaManaged": true }, { "groupId": "2a742b27fac2fc33a44750ea", "aaaManaged": false }, { "groupId": "6fb6bc84b86f963a564743db", "aaaManaged": false }, { "groupId": "1b8871711e35e22d89b273da", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure sint elit proident" }, { "roleId": "mollit qui Ut sunt" } ], "inactive": false, "_meta": { "created": "1958-02-01T09:24:24.558Z", "updated": "1985-06-03T15:26:31.171Z", "migrationVersion": -37794731 } }, "default" ], "watchers": [ { "_id": "2d981e97bb2dc7373ee9c2cb", "provenance": "eiusmod do voluptate magna", "username": "sint do", "firstname": "in esse", "memberOf": [ { "groupId": "3598fe67e6abf094b000bfae", "aaaManaged": true }, { "groupId": "c1a0b9e3203aa3fbe509945c", "aaaManaged": false }, { "groupId": "dd8dbe7bdc9377f9f6745b56", "aaaManaged": false }, { "groupId": "de1e992a27a47cee85db67d5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt dolor laboris tempor" }, { "roleId": "aute deserunt in consequat ut" }, { "roleId": "ea elit" }, { "roleId": "exercitation laborum in magna nisi" } ], "inactive": false, "lastLogin": "2019-09-09T19:54:37.69Z", "_meta": { "created": "2025-05-20T20:42:24.248Z", "updated": "1954-06-06T19:25:30.462Z", "migrationVersion": -21254361 }, "email": "in labore consequat exercitation" } ], "metrics": { "start_time": 15767299.772177964, "progress": 0.41198578846266676, "end_time": 84437467.27907762, "user": "Pronghorn", "owner": { "_id": "bd9d5bbe3d7e47ba6a5c617d", "provenance": "sit cupidatat sint id", "username": "ut esse adipisicing mollit", "firstname": "qui pariatur", "memberOf": [ { "groupId": "7b68420b2a4fdac91f7977a3", "aaaManaged": true }, { "groupId": "1be1a66fd62ccc93218c7bc2", "aaaManaged": false }, { "groupId": "4c8036ed6b2d004668da03bf", "aaaManaged": false }, { "groupId": "206f85c60e8e4779e20d97d6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis ea" }, { "roleId": "velit cupidatat aute ex sunt" }, { "roleId": "sunt culpa dolor velit Excepteur" }, { "roleId": "anim elit laboris eu exercitation" } ], "inactive": true, "lastLogin": "1959-03-08T12:37:33.156Z", "_meta": { "created": "1977-07-21T19:51:09.352Z", "updated": "2019-04-08T16:27:59.459Z", "migrationVersion": 15349009 }, "email": "consectetur" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }