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 imported 3 of 4 documents", "data": { "_id": "fdf0fb84f5183d6bfb4ba8eb", "font_size": -39656875, "type": "automation", "created": "2009-01-19T06:19:04.476Z", "last_updated": "1985-04-11T14:49:04.696Z", "createdVersion": "997.709.2", "lastUpdatedVersion": "9729.54632322262.05542038816-9138.3643424.4146723090", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 7291997, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -93375328.66706155, "sla": -44307285.943142414, "decorators": [ { "type": "encryption", "pointer": "/decN995Fr/JhNtt8e1ACO/B/~1/~0/MNh2Lsor+/Xj345X/OIgsj3YDYLN/SHI2m.bM" }, { "type": "encryption", "pointer": "/~1/w.nCyxUl/~1/~1/~0/k3A8/b/BRcBbEq/hlxK/~1/~0" }, { "type": "encryption", "pointer": "/Gtke" }, { "type": "encryption", "pointer": "/gQ/~1/~0/~1/~0/IC-6/ev9,N1kgaK/tBVIoi9/D" } ], "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 } ], "warnings": [ { "task": "e28f", "name": "myCoolDocumentName", "message": "minim Ut nostrud pariatur" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "aute officia" } ], "ancestors": [ "cdc324f8b3d1843038ec61d4", "760c5139ee65f736b3df4a6b", "7e023656be83d350f16122b4", "39f771b93d164eb7d904641c", "d7d116e2cc72f907971fb887" ], "validationErrors": [ { "keyword": "quis velit minim", "dataPath": "aliqua sunt", "schemaPath": "anim amet Excepteur", "message": "incididunt velit exercitation labore" }, { "keyword": "magna", "dataPath": "esse", "schemaPath": "ad reprehenderit est et", "message": "aliquip non" }, { "keyword": "dolore amet in ex", "dataPath": "non amet reprehenderit commodo incididunt", "schemaPath": "anim quis aliqua ut", "message": "qui Duis commodo in" }, { "keyword": "id cillum", "dataPath": "est minim adipisicing", "schemaPath": "incididunt eiusmod consectetur laborum est", "message": "reprehenderit aute" }, { "keyword": "mollit non Lorem est", "dataPath": "consequat non Excepteur ipsum", "schemaPath": "sint reprehenderit", "message": "sit ullamco do magna" } ], "created_by": null, "last_updated_by": "e703f895a07289659da5f6ce", "tasks": { "workflow_start": { "x": -63068239.916284874, "y": 76386681.60831565, "gridCoordinate": { "x": 99637732.9949806, "y": 60516484.51364118 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -88971518.92159072, "finish_state": "failure", "user": "c49e41fd85290efa268dbec8" }, "groups": [ "default", "db158414f8ddec99ac65a82e", "5a51a4b4f2e7fdcf65361b21", { "_id": "82eb52d1b5a5950178943c20", "provenance": "nulla sit in in", "name": "dolore elit", "description": "magna fugiat reprehenderit in", "memberOf": [ { "groupId": "6360f4d3b04254473b95c893", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud reprehenderit qui et" } ], "inactive": true, "_meta": { "created": "1955-04-02T12:51:17.558Z", "updated": "1965-09-14T22:39:54.516Z", "migrationVersion": 11604329 } }, "c4bfd830940225fbfd32d3db" ], "iterations": [ "dcAf378f-Ae22-FA0f-04ED-D73Bae7Fb2EE", "D18AAda9-34AD-C5B9-baD2-c01279d7448f", "2AAA7dAf-1116-Aa1c-a46a-F203D43e69DC" ] }, "workflow_end": { "x": -51553840.58855801, "y": -96753098.55629344, "gridCoordinate": { "x": -33946270.28924782, "y": 76946886.45846188 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "3a1f", "3a1f", "workflow_end", "workflow_end" ], "complete": [ "workflow_start", "3a1f", "error_handler" ], "error": [ "workflow_start", "error_handler", "e28f", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 88640546.41990817, "run_time": -61662947.540453896 }, "groups": [ { "_id": "d0b784e88853ec47b039fb85", "provenance": "exercitation mollit", "name": "reprehenderit in Duis", "description": "in mollit ad elit", "memberOf": [ { "groupId": "08b4200d218b9af9009efad3", "aaaManaged": true }, { "groupId": "53629197812d831f3e456676", "aaaManaged": false }, { "groupId": "82425f982ea8bde054481973", "aaaManaged": false }, { "groupId": "c4e731d7e34cd3c1c2ee4706", "aaaManaged": false }, { "groupId": "7f62cbcce960445b6b1b3002", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad" }, { "roleId": "enim velit ullamco quis eiusmod" }, { "roleId": "nulla" }, { "roleId": "in laboris sed" } ], "inactive": false, "_meta": { "created": "1981-05-18T05:33:02.405Z", "updated": "1975-01-23T06:12:50.762Z", "migrationVersion": 15385121 } }, "default", "0be5c2530a22f2c3353259ca", "default" ], "iterations": [] }, "error_handler": { "x": 17718028.792978883, "y": -1189440.282801032, "gridCoordinate": { "x": 40977770.166225284, "y": 33360959.892689615 }, "name": "childJob", "location": "Adapter", "locationType": "et fugiat nisi sit exercitation", "app": "reprehenderit", "canvasName": "consequat id elit labore", "displayName": "consectetur cupidatat ullamco labore", "summary": "Ut", "description": "tempor non aute ex", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ZVZgS/he1RSJw/~1/~1/~1/f/omsJ9E" }, { "type": "encryption", "pointer": "/~0/zF/JdgHp/F/qAliJ/l/~0/QnQqI+U" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolore sit sed", "highlightString": "ex" }, { "key": "enim laborum pariatur sed laboris", "highlightString": "officia Excepteur non ut" }, { "key": "sunt", "highlightString": "sint Ut eu ex" } ], "status": "running", "previous": { "incomplete": [ "error_handler" ], "complete": [ "workflow_start" ], "error": [ "e28f", "workflow_start", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "adipisicing nisi in", "start_time": "2025-05-06T15:58:17.073Z", "end_time": 97810456.6843209, "finish_state": "success", "retrySettings": { "state": [ "failure", "error", "success", "error" ], "autoRetry": true, "limit": 71908319, "delay": 69800339, "count": 69734630, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", "default", "9041650a57d88f844b265b88", "default" ], "iterations": [ "01aF6eaE-89cA-5EDf-2F7c-BdDbFb2916BE" ] }, "b": { "actor": null, "groups": [ "default" ], "iterations": [], "x": 80727771.09222904, "y": -32394155.663964868, "gridCoordinate": { "x": -65439025.03494739, "y": 81547817.16232109 }, "name": "Ut laboris aute ea", "location": "Adapter", "locationType": null, "app": "reprehenderit exercitation", "canvasName": "ea nostrud occaecat proident", "displayName": "irure occaecat Lorem consectetur", "summary": "magna Duis", "description": "est qui occaecat aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/~0/~1/~1/~1/XWj8z/~1/RWEmDDNiNGy/~0" }, { "type": "encryption", "pointer": "/~0/W/caSa4/DAY3d1hm/~0/i.zSsgmPFl/CpDXvPnm/hGfc/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "enim", "highlightString": "sit" }, { "key": "laborum labore aliqua velit", "highlightString": "minim veniam in" }, { "key": "ut", "highlightString": "sint id aliquip est Ut" }, { "key": "do", "highlightString": "ut occaecat labore ad Lorem" }, { "key": "Duis", "highlightString": "non" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "3a1f", "error_handler", "workflow_end", "3a1f" ], "complete": [ "e28f", "workflow_end", "workflow_start" ], "error": [ "workflow_end", "e28f", "workflow_start", "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "amet magna", "start_time": "2009-03-08T15:11:14.27Z", "end_time": -92529807.42468213, "finish_state": "failure", "retrySettings": null, "type": "manual", "view": "elit consectetur voluptate officia" } }, "parent": { "job": "in", "task": "officia", "iteration": 82517751.8836233, "element": 12616530.110124245 }, "errorHandler": null, "groups": [ { "_id": "41ed25b3af795f7cb80892b6", "provenance": "exercitation mollit dolor officia sed", "name": "in culpa", "description": "dolore laborum aute", "memberOf": [ { "groupId": "6d86b36ec07248070fe8dc54", "aaaManaged": true }, { "groupId": "28c74eb1bee31f3204a73553", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea elit" }, { "roleId": "dolor deserunt occaecat pariatur" } ], "inactive": false, "_meta": { "created": "2016-11-07T10:28:19.217Z", "updated": "1981-02-20T15:45:20.04Z", "migrationVersion": 52016123 } }, "719101d220bb3aaf729ae9b3", { "_id": "67cb57395dab2f829953fe1d", "provenance": "sint sed qui occaecat in", "name": "et velit laboris irure Lorem", "description": "eiusmod laboris", "memberOf": [ { "groupId": "f44f0a07bc59c68ba9ca5b4f", "aaaManaged": false }, { "groupId": "d982d04ce91e4e171a992249", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Ut anim quis sed" }, { "roleId": "fugiat dolor velit" }, { "roleId": "ut eiusmod" } ], "inactive": false, "_meta": { "created": "1979-04-26T09:10:51.077Z", "updated": "2015-05-04T18:20:10.592Z", "migrationVersion": -95676072 } } ], "watchers": [ null ], "metrics": { "start_time": 5303345.42010808, "progress": 0.7451090583336393, "end_time": 11027043.165791243, "user": { "_id": "6982f61e4e5ea90e89621f62", "provenance": "consectetur in", "username": "ut officia", "firstname": "aute deserunt", "memberOf": [ { "groupId": "d65639668fa4594da06dedee", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris" }, { "roleId": "in reprehenderit dolore" }, { "roleId": "Excepteur" }, { "roleId": "adipisicing amet labore consectetur irure" } ], "inactive": true, "lastLogin": "1955-09-29T13:14:07.816Z", "_meta": { "created": "1968-07-28T11:43:16.935Z", "updated": "1996-12-04T14:24:19.205Z", "migrationVersion": 58675961 }, "email": "voluptate cupidatat nostrud" }, "owner": { "_id": "a179ca2851cbbe04e6b160dd", "provenance": "dolor quis amet sit dolore", "username": "ea", "firstname": "qui aute sed ullamco", "memberOf": [ { "groupId": "645785afee5c1099f7007cbd", "aaaManaged": false }, { "groupId": "87987e5843dfcd1b9dfa3522", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur" } ], "inactive": false, "lastLogin": "1953-09-11T00:22:43.781Z", "_meta": { "created": "2005-11-28T22:04:03.638Z", "updated": "2011-04-21T12:26:22.29Z", "migrationVersion": -8252683 }, "email": "consectetur ea ex" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }