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": "6cdb2408e7239b75e6a0f3a5", "font_size": 17791471, "type": "automation", "created": "2010-10-14T21:58:21.855Z", "last_updated": "1974-07-10T14:31:21.787Z", "createdVersion": "3857678.2780719794.108", "lastUpdatedVersion": "93413861059.7629051586.47788", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -65798524, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 86277470.13244757, "sla": 22113269.04387337, "decorators": [ { "type": "encryption", "pointer": "/jg-8SuXWw-T/LsrA,/~0/~1/~0/~0" }, { "type": "encryption", "pointer": "/TS8UqjC4o,K/~0/~0/~1/~0/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/Ha-/vz/QZ" }, { "type": "encryption", "pointer": "/W7/~1/~1/y" } ], "status": "error", "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "anim non ut", "dataPath": "sit cupidatat occaecat exercitation irure", "schemaPath": "consequat veniam do ut", "message": "consequat" }, { "keyword": "Lorem", "dataPath": "nostrud in", "schemaPath": "dolore dolor aliquip", "message": "ut tempor" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 67533605.34700707, "y": 99197747.72469947, "gridCoordinate": { "x": 72393900.04317671, "y": 11831769.973504752 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -16452389.419723362, "finish_state": "success", "user": null }, "groups": [ { "_id": "abeb7f84a897e32a7ef3695d", "provenance": "in dolore commodo anim", "name": "ut", "description": "culpa dolor quis", "memberOf": [ { "groupId": "6e33f432c0f4d00ad88ed88d", "aaaManaged": false }, { "groupId": "a9d32791e7098a4e0a9e6919", "aaaManaged": true }, { "groupId": "fb400352e604a4a58de4c0b6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur" }, { "roleId": "in laborum incididunt velit" }, { "roleId": "commodo voluptate dolor cillum sint" }, { "roleId": "ut id aliqua" } ], "inactive": true, "_meta": { "created": "1978-08-18T03:11:44.683Z", "updated": "1992-08-25T23:50:18.998Z", "migrationVersion": 87677385 } }, "576e344583f1c98ffe40da2b" ], "iterations": [ "B6dfFeAC-92e9-4cDB-C5e1-BF034675fAdb" ] }, "workflow_end": { "x": -81484516.41888772, "y": -31581521.959470794, "gridCoordinate": { "x": -72426870.91734643, "y": 35906788.0702647 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "workflow_start", "3a1f" ], "error": [ "workflow_end", "error_handler" ] }, "metrics": { "end_time": -66272800.795928076, "run_time": -68244816.13034475 }, "groups": [ "default" ], "iterations": [ "45E8c509-8FbF-CaA2-2Fff-7b9FE5ddf7B5" ] }, "error_handler": { "x": 32921307.33539684, "y": -54129095.20363507, "gridCoordinate": { "x": 85461540.83929607, "y": 5861425.517972663 }, "name": "childJob", "location": "Application", "locationType": "cillum anim sed", "app": "laboris ex", "canvasName": "Excepteur", "displayName": "est", "summary": "ut sed aute", "description": "sunt cillum dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/IOcPr/Z28MwbX/~0/~1/~1/~1/VBY0zqY/~0" }, { "type": "encryption", "pointer": "/dSJm/~1/~1" }, { "type": "encryption", "pointer": "/~0/o9sh-BW1Tbk/~0/~0/~1" }, { "type": "encryption", "pointer": "/qfNAHcNgb/wUVgS9XK/aYTVD/Rku+2r/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "eu", "highlightString": "incididunt labore occaecat aliquip tempor" }, { "key": "Ut in cillum velit laboris", "highlightString": "qui aute enim" }, { "key": "in mollit", "highlightString": "fugiat deserunt Duis velit culpa" }, { "key": "amet occaecat", "highlightString": "voluptate do ut in" }, { "key": "Ut", "highlightString": "veniam in ad adipisicing" } ], "status": "failure", "previous": { "incomplete": [ "workflow_end", "workflow_start", "workflow_end", "3a1f", "e28f" ], "complete": [ "3a1f", "workflow_start", "error_handler", "error_handler", "workflow_end" ], "error": [ "e28f", "3a1f", "error_handler", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "cillum magna qui aute amet", "start_time": "1964-07-02T15:02:41.346Z", "end_time": -91015651.01959306, "finish_state": "success", "retrySettings": { "state": [ "failure", "error", "failure", "error", "success" ], "autoRetry": true, "limit": 98013271, "delay": 59528302, "count": 50275444, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "b1abfc7c7989a27878d27010", "default", { "_id": "e9da75e5116ccaa40ca7c824", "provenance": "proident deserunt", "name": "adipisicing eiusmod", "description": "reprehenderit ut nulla", "memberOf": [ { "groupId": "2543945607fcd7638ff56056", "aaaManaged": true }, { "groupId": "9235d4efdc0ee069ea027218", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit enim" }, { "roleId": "proident laborum incididunt adipisicing" }, { "roleId": "dolor irure ipsum" } ], "inactive": true, "_meta": { "created": "1972-05-26T02:06:23.223Z", "updated": "2008-03-29T16:14:05.052Z", "migrationVersion": 51929529 } } ], "iterations": [] }, "2c": { "actor": { "_id": "54949effe2dbde0ab229b088", "provenance": "aliqua laborum", "username": "nostrud in aliqua", "firstname": "ut", "memberOf": [ { "groupId": "fe448d4dd161a9f95a64133b", "aaaManaged": true }, { "groupId": "f20cb891d8c5f8632cc58f9b", "aaaManaged": false }, { "groupId": "97eba49c5821c8b6096d4e38", "aaaManaged": true }, { "groupId": "710daa668415dc89841905ea", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor ex velit elit ad" }, { "roleId": "nisi culpa aliqua" } ], "inactive": false, "lastLogin": "1980-08-12T10:21:42.01Z", "_meta": { "created": "1950-05-22T11:45:05.026Z", "updated": "1999-04-17T02:24:38.911Z", "migrationVersion": 21083170 }, "email": "ut magna in" }, "groups": [ { "_id": "31ccaf329c50351e3de2d07b", "provenance": "quis velit do veniam", "name": "officia id nisi cillum", "description": "in laborum", "memberOf": [ { "groupId": "24add1537d38ffb0e1549ae1", "aaaManaged": false }, { "groupId": "da34981ee586ab93c3c8cb3d", "aaaManaged": true }, { "groupId": "3db579f6317aef1d7052103b", "aaaManaged": true }, { "groupId": "d9a6e1ef2781874b8c3c99f4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum deserunt" }, { "roleId": "labore quis dolore" }, { "roleId": "Lorem pariatur consequat" } ], "inactive": true, "_meta": { "created": "2000-10-25T00:15:03.54Z", "updated": "1968-07-25T08:17:36.361Z", "migrationVersion": 82585599 } }, "default", "079b6a4f22c8170d697009ee", { "_id": "b1dd3ac88a43675c6249edd0", "provenance": "ut ea pariatur labore", "name": "commodo eu sit laboris tempor", "description": "id", "memberOf": [ { "groupId": "55fdc17e8616c8e95e6ebd7a", "aaaManaged": true }, { "groupId": "da3ae4fe187246e98a832fe9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa incididunt ut et" } ], "inactive": false, "_meta": { "created": "2000-10-21T05:24:19.107Z", "updated": "2006-01-10T11:33:25.498Z", "migrationVersion": -68805806 } }, "default" ], "iterations": [ "962d1203-BfAc-FbF8-b71B-fb85cc63E1CC" ], "x": 18783177.73180096, "y": -29691519.297744498, "gridCoordinate": { "x": 38272686.515678346, "y": -51971072.12890399 }, "name": "pending", "summary": "sit aliqua voluptate esse", "description": "ad" } }, "parent": { "job": "in", "task": "esse proident ea Excepteur aute", "iteration": -18989288.78842078, "element": -99366910.78993541 }, "errorHandler": { "actor": "job", "groups": [ "29e0f1915e95d950465a395f", "c4ce1b27529be8a497bde3fa" ], "iterations": [ "c81D1aAa-1Fdd-f1EB-F9cA-A48F4fC665e2", "42a088DC-5C51-9f9E-aB14-BDFafcbecDdF", "1f4A3B44-F439-2fcb-BE12-F11Fea39fdcc", "0FF0B5b0-cFED-3DDc-049F-Edc91F990D2f" ], "x": -5598406.3854025155, "y": 50970078.34672499, "gridCoordinate": { "x": 47226414.8740173, "y": -22384316.434733614 }, "name": "pending", "summary": "eu et reprehenderit dolor nisi", "description": "nisi" }, "groups": [ "default", { "_id": "7938d203802ac6ba5c581f90", "provenance": "irure in aute ullamco sint", "name": "dolore ex sunt", "description": "dolor aliqua ullamco laborum nulla", "memberOf": [ { "groupId": "dcaabdad2ade0a7fac8262bb", "aaaManaged": true }, { "groupId": "680256b5596cf94a6d851bf1", "aaaManaged": false }, { "groupId": "9201c43e28fd34b332827031", "aaaManaged": false }, { "groupId": "6ca030adc11e8c84566b30c1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do" }, { "roleId": "in mollit nisi non" }, { "roleId": "quis" }, { "roleId": "culpa" } ], "inactive": false, "_meta": { "created": "2024-08-13T06:37:02.941Z", "updated": "1983-11-03T00:26:50.938Z", "migrationVersion": 12591388 } } ], "watchers": [ { "_id": "3e21291824f4b7351cb437c8", "provenance": "quis", "username": "aliqua sint reprehenderit", "firstname": "ipsum consequat dolore tempor irure", "memberOf": [ { "groupId": "ec5db680cb75d66f72ace2c0", "aaaManaged": false }, { "groupId": "84551e12cd6a17d0289620b8", "aaaManaged": false }, { "groupId": "70749b312330b4baab421b7a", "aaaManaged": true }, { "groupId": "a5a6c9712ea07637eb43407f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim deserunt in" }, { "roleId": "deserunt est elit" }, { "roleId": "quis amet officia esse ullamco" } ], "inactive": true, "lastLogin": "2025-04-02T23:37:40.948Z", "_meta": { "created": "2012-01-16T09:01:28.51Z", "updated": "1978-07-23T14:16:01.78Z", "migrationVersion": 49981380 }, "email": "officia veniam" }, null, { "_id": "525bf861781ffa00869e9cd1", "provenance": "dolore laboris Lorem", "username": "ipsum labore incididunt qui et", "firstname": "nostrud est dolore sint in", "memberOf": [ { "groupId": "22ae5bc6ec12351d5738a424", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit" }, { "roleId": "ad" }, { "roleId": "occaecat adipisicing" }, { "roleId": "amet cillum veniam aliqua Duis" } ], "inactive": false, "lastLogin": "2003-03-16T10:46:53.829Z", "_meta": { "created": "2018-11-09T23:00:58.141Z", "updated": "2015-10-06T17:11:50.969Z", "migrationVersion": 67445681 }, "email": "non" } ], "metrics": { "start_time": -93689140.9661968, "progress": 0.655448659645419, "end_time": -63178956.417925395, "user": { "_id": "177674091bcf269b230cc504", "provenance": "sed irure in nostrud", "username": "adipisicing non culpa", "firstname": "sit sed sunt dolore", "memberOf": [ { "groupId": "d1e654bb49d43e72ccabb443", "aaaManaged": true }, { "groupId": "1ed5314672a886616d977b58", "aaaManaged": false }, { "groupId": "7d795acfc2ca0983412ad9d8", "aaaManaged": true }, { "groupId": "feaab1ce9c7779393c48caca", "aaaManaged": true }, { "groupId": "93b05b6c3017959bbea9fdfd", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum" }, { "roleId": "ut aliquip fugiat" } ], "inactive": true, "lastLogin": "2021-05-02T00:37:12.42Z", "_meta": { "created": "2006-05-14T02:16:24.88Z", "updated": "1957-09-23T07:38:40.131Z", "migrationVersion": 66878825 }, "email": "incididunt id et cillum" }, "owner": { "_id": "fc11dd6566c514b8eed1fdb9", "provenance": "dolor nulla Excepteur sint", "username": "tempor sint cupidatat ullamco", "firstname": "ullamco labore", "memberOf": [ { "groupId": "964b03767f7ba19aeefb81d8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi voluptate deserunt sit" }, { "roleId": "Lorem" }, { "roleId": "do commodo laboris" }, { "roleId": "ea" }, { "roleId": "labore laboris nulla consectetur mollit" } ], "inactive": true, "lastLogin": "1992-09-10T20:39:14.018Z", "_meta": { "created": "1994-03-14T19:57:55.79Z", "updated": "1983-02-11T22:44:16.826Z", "migrationVersion": 83303310 }, "email": "mollit qui" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }