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": "8d5625fb35a56ef42a842d31", "font_size": 58917313, "type": "automation", "created": "1961-09-06T13:14:05.066Z", "last_updated": "2005-03-20T22:21:23.617Z", "createdVersion": "8484569938.9590470.46008", "lastUpdatedVersion": "53546837.3270692569.8672673", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 67067792, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 80850461.81845617, "sla": -84419226.39509124, "decorators": [ { "type": "encryption", "pointer": "/~1/YW/gUX./ik5JQe0F,/~1/f3QNw" } ], "status": "incomplete", "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": "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": "ut in Excepteur pariatur dolore" } ], "ancestors": [ "0c364365652ff87075ad6c39", "e0c7a0800952be2bfedc36df", "5d366bbef43d3451aa24eb1b", "aae541244e1824c6cf856cf9", "b67f46cf89ad0e6993bd544a" ], "validationErrors": [ { "keyword": "fugiat", "instancePath": "in", "schemaPath": "occaecat", "message": "Duis sed non Lorem pariatur" }, { "keyword": "culpa in", "instancePath": "in pariatur occaecat", "schemaPath": "enim commodo", "message": "laboris ullamco non sed" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 55286138.12165779, "y": -48096136.08314916, "gridCoordinate": { "x": 17163820.43455158, "y": -90326511.48546322 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -22781909.52872978, "finish_state": "error", "user": "Pronghorn" }, "groups": [ { "_id": "aae5bf61d5da14cf0bd550ad", "provenance": "et qui reprehenderit", "name": "velit dolore qui id", "description": "aute et eu", "memberOf": [ { "groupId": "0e94687effaa59e220a1ca8f", "aaaManaged": false }, { "groupId": "7c456851d9c11b670d24e9a3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui" }, { "roleId": "do et mollit nostrud qui" } ], "inactive": false, "_meta": { "created": "2025-02-16T14:17:09.65Z", "updated": "1949-08-02T15:48:29.703Z", "migrationVersion": -28778161 } }, { "_id": "50114d6259d03de2d6788e58", "provenance": "commodo", "name": "in cillum et laboris amet", "description": "non amet laboris nisi Ut", "memberOf": [ { "groupId": "67f511d3310be1d49d9af4ef", "aaaManaged": true }, { "groupId": "448b9ea2471d10727d06c93b", "aaaManaged": true }, { "groupId": "28c84403b4c5787532c8116d", "aaaManaged": true }, { "groupId": "993cf0bfbb225cd79a00727f", "aaaManaged": false }, { "groupId": "70e489f6058031e7ee9ea518", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod qui irure dolor" } ], "inactive": false, "_meta": { "created": "1992-12-30T22:17:45.46Z", "updated": "1984-08-09T10:22:27.627Z", "migrationVersion": 40206037 } }, "ae559db4c333a631a233796e", "default" ], "iterations": [ "23fc1775-5e3E-97de-d672-A080E006FD1a" ] }, "workflow_end": { "x": 41023990.91696465, "y": 1924661.8555758, "gridCoordinate": { "x": 24795259.27432622, "y": 87329252.59464598 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler", "workflow_start", "workflow_end" ], "complete": [ "error_handler", "e28f", "3a1f", "workflow_end" ], "error": [ "workflow_start", "error_handler", "e28f", "error_handler", "workflow_start" ] }, "metrics": { "end_time": -28508150.257508367, "run_time": 16198524.274767935 }, "groups": [ { "_id": "4b9af1c5977860d1b37a7d9c", "provenance": "et ullamco", "name": "eiusmod", "description": "labore culpa", "memberOf": [ { "groupId": "b19b2ed2d382430c5b7ed813", "aaaManaged": false }, { "groupId": "55704fb6fbfbfa57ebd589c4", "aaaManaged": false }, { "groupId": "fa4fd29f6e6a6c49b585c57a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore eu" }, { "roleId": "exercitation" }, { "roleId": "ut ipsum" }, { "roleId": "ut proident aute eiusmod" }, { "roleId": "sed culpa" } ], "inactive": false, "_meta": { "created": "2019-07-29T01:23:24.438Z", "updated": "1963-11-21T20:01:40.28Z", "migrationVersion": -30404166 } } ], "iterations": [ "f8DCcB86-e55c-eBBb-72A7-d7C908CEC76D" ] }, "error_handler": { "x": -52388265.63818302, "y": 5820414.388379186, "gridCoordinate": { "x": 51721995.91090837, "y": -78119913.11527912 }, "name": "childJob", "location": "Adapter", "locationType": "reprehenderit", "app": "ipsum laborum", "canvasName": "do laborum non tempor", "displayName": "ea", "summary": "ullamco culpa", "description": "ipsum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ip,o/~1/~1/~1/~0/D6rMpWu" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "do magna anim quis occaecat", "highlightString": "exercitation" }, { "key": "in est aute commodo", "highlightString": "ex fugiat dolor aliqua" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "workflow_end", "3a1f", "workflow_start", "error_handler" ], "complete": [ "workflow_start", "e28f", "workflow_start", "workflow_end", "workflow_start" ], "error": [ "3a1f", "3a1f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "ad minim ullamco", "start_time": "1983-02-06T22:57:40.293Z", "end_time": -90174544.35838674, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "51e037642ba3faaccc6bd1e3", "default" ], "iterations": [ "6aF7b1E0-5e7d-7c02-b5Ca-7e6F6DE46AF4", "E01C383E-E8B1-D8cC-1B5C-7a21C0BDDEFf" ] }, "b5": { "actor": "7c59c890b74d789dfd24bac9", "groups": [ "18d7568aba8f924bd42f7264", "default" ], "iterations": [ "57c052A2-9360-Dc92-81AB-7EbC0DBaD96e" ], "x": 30709009.99461128, "y": -92618949.63148206, "gridCoordinate": { "x": 21339637.94947791, "y": 59318074.14335215 }, "name": "aliqua ullamco reprehenderit", "location": "Application", "locationType": "ipsum minim Excepteur cillum elit", "app": "anim sunt ut quis enim", "canvasName": "dolor sit eiusmod culpa", "displayName": "aliquip fugiat enim ut labore", "summary": "et", "description": "sit et ea", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Gc8TXXV6/~1/~1/gPplr/EqM/w9Q/~1/~0" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/mKK6d/~0/~1/~0/N4T8MKr/JO/BxLbm/~0" }, { "type": "encryption", "pointer": "/~0/n/HUUiQJl/U4R.wI1" }, { "type": "encryption", "pointer": "/~0/fa/~0/iiYADbINYh" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "incididunt culpa", "highlightString": "amet sunt ipsum laborum velit" }, { "key": "irure", "highlightString": "ipsum minim nulla laboris in" }, { "key": "Ut", "highlightString": "commodo irure adipisicing" } ], "status": "running", "previous": { "incomplete": [ "3a1f", "workflow_start", "workflow_end" ], "complete": [ "3a1f" ], "error": [ "workflow_start", "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" } ] }, "serverId": "mollit cillum Lorem ex commodo", "start_time": "1964-07-16T02:23:56.505Z", "end_time": -37925824.2608417, "finish_state": "failure", "retrySettings": null, "type": "manual", "view": "occaecat enim nisi in" } }, "parent": { "job": "elit qui consequat et laboris", "task": "aliquip elit laboris non", "iteration": 91704963.20813525, "element": -75148839.98550066 }, "errorHandler": { "actor": "Pronghorn", "groups": [ { "_id": "e185a4e224eef8422ec052b0", "provenance": "in commodo quis", "name": "magna nisi non ullamco", "description": "nostrud eu consectetur", "memberOf": [ { "groupId": "a89814737e871d2a59b37049", "aaaManaged": false }, { "groupId": "e3f386fc1bfe01e3359d505d", "aaaManaged": true }, { "groupId": "05dc627df58cf7c9812e94fa", "aaaManaged": true }, { "groupId": "888e53848c49f810acec0f16", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore Ut aliqua" }, { "roleId": "dolor qui" }, { "roleId": "fugiat eu Excepteur" } ], "inactive": false, "_meta": { "created": "1989-03-15T15:20:24.725Z", "updated": "2000-05-25T16:56:29.234Z", "migrationVersion": -96146605 } }, "default", "6776ff3f724f798f5b99d79e", "default" ], "iterations": [ "09E88583-DbCd-befA-110C-4d22cBCfA236" ], "x": 42090644.11819044, "y": 58769300.30572316, "gridCoordinate": { "x": 27229073.592716977, "y": -62547694.50587836 }, "name": "dolore", "location": "Adapter", "locationType": null, "app": "amet est minim quis in", "canvasName": "velit", "displayName": "nostrud do ad ex", "summary": "anim in enim", "description": "anim dolor deserunt tempor qui", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Z97QZjs" }, { "type": "encryption", "pointer": "/~0/~0/~1/~1/i6BK9dvg/pz5gYCb/~1/zR/~1/~1/ElUdOtjV" }, { "type": "encryption", "pointer": "/pw28RDPv/nBmi/oi4,1LYF+CL/~0" }, { "type": "encryption", "pointer": "/BcmWBV7r" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "consectetur dolor deserunt magna", "highlightString": "cillum dolor pariatur ut" }, { "key": "velit reprehenderit quis", "highlightString": "do id in" } ], "status": "incomplete", "previous": { "incomplete": [ "3a1f", "workflow_start" ], "complete": [ "error_handler", "workflow_end", "workflow_start", "workflow_start", "3a1f" ], "error": [ "workflow_start", "workflow_end", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "do Excepteur laboris ad Lorem", "start_time": "1968-07-02T11:19:53.994Z", "end_time": 83558944.6959543, "finish_state": "error", "retrySettings": null, "type": "manual", "view": "Excepteur" }, "groups": [ { "_id": "88b9924006ddc82ebe2eb53a", "provenance": "tempor laborum", "name": "consectetur nisi est", "description": "cillum", "memberOf": [ { "groupId": "0884106938f644a64c3dee23", "aaaManaged": true }, { "groupId": "a8103c66a51df306043df309", "aaaManaged": true }, { "groupId": "f8e92a2e3337cec6b7ebb713", "aaaManaged": true }, { "groupId": "de5e50ca75cd8ad1e93a7005", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "commodo" }, { "roleId": "occaecat magna non dolore elit" }, { "roleId": "dolore Duis pariatur quis Excepteur" }, { "roleId": "commodo aliquip non nisi dolore" } ], "inactive": false, "_meta": { "created": "1985-05-01T19:05:47.487Z", "updated": "1980-03-24T06:10:51.611Z", "migrationVersion": -10654844 } }, "59090df1294f537aaa0cb0ac" ], "watchers": [ null ], "metrics": { "start_time": -70185610.05341625, "progress": 0.6991168695038579, "end_time": -43387849.868331194, "user": "Pronghorn", "owner": "02389b06615a3510f0676f6b" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }