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 retrieved search results", "data": { "_id": "df0b314c37bd5b24aa40c44a", "uuid": "1a8c8a17-44f1-873d-6de6-2f2f45693418", "font_size": -16743399, "type": "automation", "created": "1998-07-24T18:16:07.926Z", "last_updated": "1972-10-21T06:42:52.443Z", "createdVersion": "4.3213940.840315868", "lastUpdatedVersion": "511.917.094711264-3459.9857156748.04.4822950611", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -18287563, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 44526617.201970845, "sla": 41348442.15423158, "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/KCcDmuD.X./~0/vFs/~0/~0/~1" } ], "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": "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": "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": "et dolore" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "dolor esse velit do commodo" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "Duis" } ], "ancestors": null, "validationErrors": [ { "keyword": "dolor laborum in velit voluptate", "instancePath": "do", "schemaPath": "ad amet", "message": "sit in aute tempor" }, { "keyword": "deserunt pariatur voluptate velit", "instancePath": "sunt exercitation ullamco ad adipisicing", "schemaPath": "nulla", "message": "do" }, { "keyword": "dolore", "instancePath": "ut incididunt consectetur dolor", "schemaPath": "elit ipsum et", "message": "ex exercitation in" }, { "keyword": "sunt", "instancePath": "deserunt aute nostrud", "schemaPath": "proident", "message": "adipisicing esse ad dolore aliqua" } ], "created_by": null, "last_updated_by": null, "tasks": { "workflow_start": { "x": -5170508.513408259, "y": 38456706.85710129, "gridCoordinate": { "x": 31850049.36214018, "y": -91501286.59785804 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -75924341.27920908, "finish_state": "failure", "user": null }, "groups": [ "f445a39d9834bf5852e19fe3", { "_id": "2b1c597c7fc09ce7c59e221a", "provenance": "sed ut", "name": "in proident laboris dolore ullamco", "description": "consequat aute", "memberOf": [ { "groupId": "006f0d71b2cd5c66a8b8bb61", "aaaManaged": false }, { "groupId": "3c8cd603ef8ee7fafdebb40e", "aaaManaged": false }, { "groupId": "be298a5d89935aabb9d12fd9", "aaaManaged": true }, { "groupId": "386ab2823f14688d961bbc94", "aaaManaged": false }, { "groupId": "fb6b0287776e229f7c3efbd0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et sunt do anim" } ], "inactive": true, "_meta": { "created": "1996-07-30T21:12:16.689Z", "updated": "1991-06-15T09:47:57.944Z", "migrationVersion": 47372641 } }, { "_id": "d7b71189f90f07b7ae1a1cfa", "provenance": "sed", "name": "Lorem et", "description": "aliquip anim in aute consectetur", "memberOf": [ { "groupId": "2c73bfaaee226a6e0b050c63", "aaaManaged": true }, { "groupId": "c099e11acd7d58a2607da9ed", "aaaManaged": false }, { "groupId": "768d9acddd153a7063489159", "aaaManaged": false }, { "groupId": "4dc219737e805352c5914aa9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore" }, { "roleId": "fugiat" }, { "roleId": "commodo" }, { "roleId": "Duis sit" } ], "inactive": false, "_meta": { "created": "1970-06-14T16:06:39.331Z", "updated": "2022-12-01T12:18:30.892Z", "migrationVersion": 59587132 } } ], "iterations": [ "cC08208F-A791-BeCE-FFAA-7CeBC374Aeac", "e92c6AC9-CA91-D90f-a9aF-fd9bdb7e20B9", "d663a47B-a77e-62b9-2b2a-b899b098fE4A" ] }, "workflow_end": { "x": -18771942.983501375, "y": 55338045.64981592, "gridCoordinate": { "x": -53535436.111138426, "y": -60627815.28313632 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "e28f", "workflow_end", "workflow_start", "error_handler" ], "complete": [ "e28f" ], "error": [ "error_handler", "3a1f", "workflow_end", "error_handler" ] }, "metrics": { "end_time": 46308512.263924986, "run_time": 89778601.79861587 }, "groups": [ "default", { "_id": "00ed32bfffea39104176d4c2", "provenance": "in ut Lorem", "name": "elit Excepteur amet consequat", "description": "labore elit", "memberOf": [ { "groupId": "33a9b7c12780b818360ca5c0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor labore ut in" }, { "roleId": "dolore minim velit ullamco anim" } ], "inactive": false, "_meta": { "created": "1990-10-08T01:27:16.996Z", "updated": "2019-06-02T05:37:43.438Z", "migrationVersion": -58821957 } }, { "_id": "1750e91ad084d8d1e06ae05e", "provenance": "fugiat officia", "name": "elit dolor ad irure", "description": "in cillum dolore", "memberOf": [ { "groupId": "503605fb14dc5f0932a6cee8", "aaaManaged": true }, { "groupId": "866e0f3ad3f545430e909e32", "aaaManaged": false }, { "groupId": "cf4cec6436a521e1e3b1f792", "aaaManaged": false }, { "groupId": "fbad074f7e51b2d420637e41", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed consectetur magna" }, { "roleId": "veniam sed ut" } ], "inactive": true, "_meta": { "created": "1991-11-08T09:20:00.642Z", "updated": "1996-08-14T04:02:16.978Z", "migrationVersion": 73391865 } } ], "iterations": [ "1368D3c0-C08C-a1d9-a3f9-dB20bcEdC1b2" ] }, "error_handler": { "x": -37861261.34106822, "y": 64270250.975020945, "gridCoordinate": { "x": 45156842.85838044, "y": -67378263.55050758 }, "name": "childJob", "location": "Application", "locationType": "in Duis sit mollit", "app": "proident culpa", "canvasName": "nulla dolor", "displayName": "dolor sed dolor", "summary": "Excepteur consequat", "description": "fugiat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/TES/~1/qFbgER/I2dzAKo6/vwbcPWGD8oX/~0/LyJiXo/vSGdip/C" }, { "type": "encryption", "pointer": "/AlqE2/~1/~0/~0/RKZr/~0/rW5nW/L/yXHA9g9W" }, { "type": "encryption", "pointer": "/fiFR/lo5a7Ik/~0/SnEmky+/nZclOih/~0/~0/~0/~0/~0/aNdGr" }, { "type": "encryption", "pointer": "/DcVZZ0/~0/~0/~0/J19S8MoZ/~0/cmmTSipfE" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "nisi Ut eu amet", "highlightString": "veniam ex" }, { "key": "consectetur in tempor laborum culpa", "highlightString": "dolore" }, { "key": "aliquip", "highlightString": "commodo" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "error_handler", "error_handler" ], "complete": [ "workflow_start", "3a1f", "workflow_start" ], "error": [ "error_handler", "workflow_end", "error_handler", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "et deserunt", "start_time": "2025-06-26T19:16:30.682Z", "end_time": 73757597.50477594, "finish_state": "failure", "retrySettings": { "state": [ "error", "failure", "success", "success", "error" ], "autoRetry": false, "limit": 23652798, "delay": 58780739, "count": 81163459, "finishedRetrying": false }, "type": "operation", "actor": "e8120291680efaf404295332", "groups": [ { "_id": "15fc7424e986b7b471729326", "provenance": "sit ea enim", "name": "sunt Duis ipsum est", "description": "quis est", "memberOf": [ { "groupId": "bcb7f08ebd80cb6b8e460af1", "aaaManaged": false }, { "groupId": "57dccecc8abf80566ebcad01", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut ullamco laboris in ad" }, { "roleId": "cillum" } ], "inactive": false, "_meta": { "created": "2011-11-26T02:47:38.875Z", "updated": "1992-12-01T14:25:35.721Z", "migrationVersion": -75969259 } }, { "_id": "1793832b42da394c242e89fa", "provenance": "in occaecat Excepteur", "name": "et dolor", "description": "aute aliquip minim occaecat", "memberOf": [ { "groupId": "9ef424975de25b2ec29dc685", "aaaManaged": true }, { "groupId": "3815d5a6f43f1f98aff6955f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit ullamco nisi" }, { "roleId": "Ut proident magna anim" } ], "inactive": true, "_meta": { "created": "1977-10-27T13:24:10.265Z", "updated": "1968-05-09T00:20:41.206Z", "migrationVersion": -77661866 } } ], "iterations": [] }, "d93c": { "actor": { "_id": "0bd639842adb84790995c3a1", "provenance": "non esse velit amet", "username": "mollit ex qui consectetur", "firstname": "sunt quis reprehenderit", "memberOf": [ { "groupId": "cb0a9c51a9e60171f94e552a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui mollit irure" }, { "roleId": "laborum do" }, { "roleId": "tempor voluptate consequat nostrud qui" } ], "inactive": true, "lastLogin": "1995-12-31T23:21:25.624Z", "_meta": { "created": "1994-06-18T06:38:32.772Z", "updated": "1972-10-04T21:04:18.488Z", "migrationVersion": -16727909 }, "email": "exercitation" }, "groups": [ "a3a961672dd0cdca2e8effed", "1e15c94db5e92fc054b0441b", { "_id": "c104191ee816424abd079f3c", "provenance": "irure", "name": "culpa tempor proident sint", "description": "velit esse consequat voluptate", "memberOf": [ { "groupId": "10334c2660075fbd0dbe4372", "aaaManaged": false }, { "groupId": "094a86459e27e9f8e0a1cc81", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse" }, { "roleId": "adipisicing veniam magna eiusmod" }, { "roleId": "sunt" }, { "roleId": "aliqua irure ex Duis" } ], "inactive": true, "_meta": { "created": "2018-09-20T05:25:32.875Z", "updated": "1996-08-05T06:01:56.378Z", "migrationVersion": -38802504 } }, "default" ], "iterations": [ "4C7aCba5-ef86-2a78-cdcd-DaBd1eB3E2C1", "3CbaEd61-CBEF-Bd90-4cf0-bb3993f04022" ], "x": -26759806.289314806, "y": 73299971.28002116, "gridCoordinate": { "x": 81621815.40527031, "y": -72067103.53014927 }, "name": "pending", "summary": "officia culpa nisi ipsum", "description": "reprehenderit dolore commodo Ut consectetur" } }, "parent": { "job": "et ut Excepteur adipisicing", "task": "ea incididunt", "iteration": -63701795.967791244, "element": 98666852.660523 }, "errorHandler": { "actor": "job", "groups": [ "81f2fe7ad68d205f7b00c0c9", "default", { "_id": "d4194046273deb76d99b7449", "provenance": "aute ut proident enim", "name": "incididunt irure", "description": "labore laboris velit", "memberOf": [ { "groupId": "b688a69b17523f456bd44e98", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure" }, { "roleId": "consequat in minim ullamco" }, { "roleId": "cupidatat minim in voluptate" }, { "roleId": "aliquip" } ], "inactive": true, "_meta": { "created": "1955-11-30T17:09:22.851Z", "updated": "1955-06-13T04:00:38.301Z", "migrationVersion": 22431984 } }, { "_id": "3e23ec627cd2bbe4cd5b1719", "provenance": "deserunt laborum Duis anim", "name": "deserunt", "description": "officia Duis reprehenderit commodo in", "memberOf": [ { "groupId": "18042cb3e04a5b5dc56f4ce8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in sunt consequat" }, { "roleId": "tempor voluptate quis elit do" }, { "roleId": "culpa amet ipsum" } ], "inactive": false, "_meta": { "created": "2007-06-08T09:04:54.508Z", "updated": "1979-12-07T14:20:53.235Z", "migrationVersion": 6253484 } } ], "iterations": [], "x": 99764800.59433034, "y": -54947478.34220064, "gridCoordinate": { "x": 69451013.6163801, "y": 92396166.2826184 }, "name": "pending", "summary": "deserunt nostrud", "description": "ullamco eiusmod enim" }, "groups": [ "default", "9519cfb56df9619688e07ea1", { "_id": "6ade4966758d6c3d3bdc757e", "provenance": "elit in Lorem", "name": "sed in occaecat tempor enim", "description": "elit aliquip", "memberOf": [ { "groupId": "ea42372c080d2f1778d72828", "aaaManaged": false }, { "groupId": "014211f69b14753707f479c1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non irure" }, { "roleId": "eu" }, { "roleId": "eiusmod elit occaecat" } ], "inactive": false, "_meta": { "created": "1978-01-10T12:51:34.545Z", "updated": "2019-05-15T22:51:08.087Z", "migrationVersion": 39395648 } }, "b3f80add323910a09b8b7aa6", "3af2e5f8845d0c3c3e8b9c03" ], "watchers": [ "Pronghorn", { "_id": "e48c711dd028122287e49213", "provenance": "consectetur", "username": "do", "firstname": "nisi", "memberOf": [ { "groupId": "93f7297a99c863ae44841ab4", "aaaManaged": true }, { "groupId": "1954683518ff70145a801085", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat aliqua tempor" }, { "roleId": "officia incididunt id cillum dolor" }, { "roleId": "aliquip" }, { "roleId": "adipisicing eiusmod" }, { "roleId": "irure veniam voluptate velit in" } ], "inactive": true, "lastLogin": "1967-01-16T20:56:17.724Z", "_meta": { "created": "2017-06-14T21:57:30.254Z", "updated": "2025-10-25T23:27:31.04Z", "migrationVersion": 65067978 }, "email": "sunt qui" } ], "metrics": { "start_time": 72374213.33123043, "progress": 0.7034810491023646, "end_time": 11050412.6700266, "user": { "_id": "28a315fc91e23abaf929105c", "provenance": "ullamco sunt aute", "username": "elit aliqua enim", "firstname": "sint elit cillum", "memberOf": [ { "groupId": "ce6b33fe678f3f4aa225131a", "aaaManaged": false }, { "groupId": "445e5993619debd829d5d92d", "aaaManaged": false }, { "groupId": "69d8627dcbb0b8105562102a", "aaaManaged": true }, { "groupId": "6cabb3ac8ed705be2056b89d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea nulla est esse" } ], "inactive": true, "lastLogin": "2023-05-22T18:22:24.009Z", "_meta": { "created": "1989-07-06T02:53:29.294Z", "updated": "2018-12-03T15:50:36.489Z", "migrationVersion": 99361697 }, "email": "laboris dolore ut veniam" }, "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }