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": "c4b72b63307f5bbda20263a9", "font_size": -98261858, "type": "automation", "created": "1967-07-17T18:23:14.739Z", "last_updated": "1982-12-14T19:38:50.988Z", "createdVersion": "06466651869.9936.76", "lastUpdatedVersion": "6188.49210.1035435689", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 48987574, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -1506359.203358665, "sla": -38997749.05607001, "decorators": [ { "type": "encryption", "pointer": "/gtGSD" }, { "type": "encryption", "pointer": "/~1/~0/~1" } ], "status": "running", "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": "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "in dolor ipsum sed" } ], "ancestors": null, "validationErrors": [ { "keyword": "incididunt", "dataPath": "occaecat cupidatat", "schemaPath": "occaecat", "message": "reprehenderit" } ], "created_by": { "_id": "45bd8fd86d8b45285d383c61", "provenance": "deserunt ullamco in exercitation minim", "username": "sunt ut", "firstname": "in", "memberOf": [ { "groupId": "1b03d47a5072f4c31659468c", "aaaManaged": false }, { "groupId": "57be6e7cbe94d06a0549c476", "aaaManaged": true }, { "groupId": "6d1f20132150c5a613da8964", "aaaManaged": false }, { "groupId": "8fcf6ecb5aa56b66fdcce97f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui consectetur" }, { "roleId": "ea in cillum id" }, { "roleId": "laborum irure commodo" }, { "roleId": "ut do sit" }, { "roleId": "id ipsum" } ], "inactive": false, "lastLogin": "1946-07-16T05:48:36.879Z", "_meta": { "created": "1984-01-21T19:22:46.006Z", "updated": "2008-01-29T01:32:31.729Z", "migrationVersion": -87578814 }, "email": "ullamco" }, "last_updated_by": "dabe1348179e46c032aa921c", "tasks": { "workflow_start": { "x": 35014225.10430783, "y": 18651245.34979552, "gridCoordinate": { "x": 28734922.954751372, "y": -17771496.617032677 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -10873161.68625106, "finish_state": "failure", "user": { "_id": "653eca774e3d36f5772a4ce9", "provenance": "deserunt adipisicing anim sit labore", "username": "non esse laborum Ut nostrud", "firstname": "dolore labore exercitation culpa in", "memberOf": [ { "groupId": "966c704972dbda8d8d54b205", "aaaManaged": false }, { "groupId": "e45467a719af71be16b198ec", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor ullamco non Excepteur deserunt" } ], "inactive": false, "lastLogin": "1974-08-31T23:10:59.789Z", "_meta": { "created": "2021-08-07T11:26:22.264Z", "updated": "1949-11-09T02:27:07.048Z", "migrationVersion": 18966905 }, "email": "pariatur aliqua nisi" } }, "groups": [ { "_id": "fa506776c9cd3df4bde4afe6", "provenance": "sunt fugiat ad", "name": "aute", "description": "est minim magna cillum dolore", "memberOf": [ { "groupId": "02b7d3179dac5c559007fee3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut in" }, { "roleId": "laborum" }, { "roleId": "Duis" }, { "roleId": "incididunt" }, { "roleId": "ullamco voluptate in labore" } ], "inactive": true, "_meta": { "created": "1957-01-01T17:49:02.441Z", "updated": "1998-11-03T11:28:27.973Z", "migrationVersion": 15140275 } }, "default" ], "iterations": [ "d45244aA-6e3E-FBDb-4EAc-BE45bDE46fa4" ] }, "workflow_end": { "x": 67364326.44241259, "y": 59905774.780772954, "gridCoordinate": { "x": 83958.09246023, "y": 89614426.71981779 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "3a1f", "e28f" ], "error": [ "workflow_start", "3a1f" ] }, "metrics": { "end_time": -98469225.83007203, "run_time": -13449746.52501008 }, "groups": [ "default" ], "iterations": [ "fD5FAcD1-0DaB-41f7-F618-da9c5f6Bb7c7" ] }, "error_handler": { "x": -87041584.95481314, "y": 59099371.91806027, "gridCoordinate": { "x": -83796375.51766548, "y": 20263690.39651148 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "labore quis velit consequat", "canvasName": "ut", "displayName": "ipsum reprehenderit dolore", "summary": "culpa ullamco", "description": "sunt ut do", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/cClpBYsw,/wU/ULzJf+HD61L/yvW4/z0y/~0/Lp,6r" }, { "type": "encryption", "pointer": "/~0/~0/~1/vSsezjkpa7e/Ze/VJPMvrJj8/~1/~1/~1/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "magna", "highlightString": "minim deserunt" }, { "key": "enim eu mollit Excepteur irure", "highlightString": "velit" }, { "key": "id do sit cillum est", "highlightString": "consequat eiusmod esse magna non" } ], "status": "error", "previous": { "incomplete": [ "e28f", "workflow_start", "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "workflow_end", "e28f", "error_handler", "workflow_start", "workflow_end" ], "error": [ "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" } ] }, "serverId": "magna adipisicing Lorem esse", "start_time": "1989-01-04T04:42:09.264Z", "end_time": -91425142.759917, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "default", { "_id": "9cddcb6a018e5b15902a6a4e", "provenance": "exercitation enim officia do", "name": "dolor tempor sed", "description": "in aute fugiat", "memberOf": [ { "groupId": "79bf24d07b43adeba980b594", "aaaManaged": false }, { "groupId": "e5482882ab31cfc9556def7f", "aaaManaged": true }, { "groupId": "a5a3e8328b1e13b8d1a11ad0", "aaaManaged": false }, { "groupId": "6a1c0e56f548b4cf64ba5fda", "aaaManaged": true }, { "groupId": "1841f393e4168166f1944e23", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim velit incididunt in deserunt" }, { "roleId": "Lorem amet do" } ], "inactive": false, "_meta": { "created": "1965-03-02T12:02:47.051Z", "updated": "2013-12-20T02:50:20.953Z", "migrationVersion": 31147920 } }, "40430bf4544fb618c64bfb68", { "_id": "3e938981c7137ce547ff0395", "provenance": "deserunt et dolor eiusmod est", "name": "proident cillum commodo sunt", "description": "dolore qui", "memberOf": [ { "groupId": "da53c9bac8b01de65ae7ed8f", "aaaManaged": true }, { "groupId": "1b8376056095e8f09eea3031", "aaaManaged": true }, { "groupId": "ba9defc13e05344fcf138d58", "aaaManaged": false }, { "groupId": "7ff5642eb5ddf32f3f81f58a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt magna deserunt dolor" }, { "roleId": "voluptate sint" } ], "inactive": true, "_meta": { "created": "2006-03-02T10:45:23.966Z", "updated": "1957-01-03T14:56:22.642Z", "migrationVersion": -49173167 } } ], "iterations": [ "bB5e195A-BD8b-7941-A757-2B6cCeBDAd6A" ] }, "d0a7": { "actor": { "_id": "4fceb4f695d029290b584323", "provenance": "nisi dolore", "username": "do cupidatat culpa", "firstname": "Excepteur laborum irure veniam", "memberOf": [ { "groupId": "ab98c045ac8353b4f174f70d", "aaaManaged": false }, { "groupId": "04fd08df0eb6e4b5a0bae766", "aaaManaged": true }, { "groupId": "07579fd25653f5d4d38b9e1a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui adipisicing in incididunt velit" }, { "roleId": "sunt enim" }, { "roleId": "incididunt aliqua consectetur enim" }, { "roleId": "aute" } ], "inactive": true, "lastLogin": "1957-05-22T01:45:37.612Z", "_meta": { "created": "1985-12-06T11:27:56.158Z", "updated": "1984-07-31T00:23:10.088Z", "migrationVersion": 56975682 }, "email": "velit" }, "groups": [ { "_id": "e67a7a07492d6345bd75fc5f", "provenance": "fugiat incididunt", "name": "aliqua cillum", "description": "reprehenderit fugiat tempor veniam eu", "memberOf": [ { "groupId": "cd75eba2ec73cf2b41719c1c", "aaaManaged": true }, { "groupId": "2e36a5ae4d1980c9eb1d6d13", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute amet cillum dolore" }, { "roleId": "commodo veniam" }, { "roleId": "commodo in anim" } ], "inactive": true, "_meta": { "created": "1960-08-22T00:13:39.518Z", "updated": "2016-04-18T04:17:45.443Z", "migrationVersion": -1507290 } }, "default" ], "iterations": [ "b74550aA-cd8E-a49d-dfbF-0142f5daa58C" ], "x": -44746209.72934584, "y": -95073053.9825607, "gridCoordinate": { "x": -83984903.63635291, "y": -11892446.442361578 }, "name": "Ut elit Excepteur cillum", "location": "Adapter", "locationType": null, "app": "non minim adipisicing", "canvasName": "childJob", "displayName": "amet mollit", "summary": "qui sit aute reprehenderit dolore", "description": "Ut in cupidatat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/yZInbeEAXH/Hgk/Rrw5,7" }, { "type": "encryption", "pointer": "/~1/~0/~1/bHva/q8ntZphdM/tVQ+Q/~0/~0/S3s" }, { "type": "encryption", "pointer": "/hS46faCu/~1/~0/~0/~1/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "magna officia cupidatat eu cillum", "highlightString": "nulla velit" }, { "key": "nostrud reprehenderit sint in quis", "highlightString": "qui dolore commodo irure" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "e28f", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_end", "3a1f" ], "error": [ "workflow_start", "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "elit quis", "start_time": "1954-03-26T08:29:50.693Z", "end_time": 29877577.912680402, "finish_state": "success", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -38570852.622530036, "outgoing": [ "pariatur Ut", null, "sit do Excepteur", null ] }, "childJobs": [ { "_id": "anim proident", "name": "reprehenderit do ullamco adipisicing occaecat", "iteration": -41812625.645928755 }, { "_id": "nisi", "name": "cillum fugiat culpa", "iteration": 57888024.14340109 }, { "_id": "tempor dolor ex", "name": "fugiat", "iteration": 43415624.84069598 } ] } }, "parent": { "job": "cupidatat sed do", "task": "dolor elit", "iteration": -975589.2665410191, "element": -10045464.038263008 }, "errorHandler": { "actor": "713694bac84fbfc3fb2f0bcb", "groups": [ "default", "default" ], "iterations": [ "4FECe33d-D4E5-4C2b-54Ed-3c01178ff3c8", "F6B40B3b-2ef5-cA7B-F3a7-cDA21eD5dbBF", "Cf2d328B-BE9e-222e-eF32-d85E44c4dd4A" ], "x": -85095300.85644785, "y": 67463331.22426587, "gridCoordinate": { "x": 82324520.63653141, "y": -972286.2709922642 }, "name": "velit tempor cupidatat", "location": "Adapter", "locationType": "occaecat anim sit mollit velit", "app": "amet et", "canvasName": "childJob", "displayName": "proident tempor Excepteur in eiusmod", "summary": "nostrud voluptate irure exercitation", "description": "nisi culpa", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/UKzW/~1/~1/isycWCDji" }, { "type": "encryption", "pointer": "/vae8sY1/bM5YU4y" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "in minim consequat irure", "highlightString": "tempor Excepteur aliqua ea Ut" }, { "key": "tempor nostrud exercitation eiusmod sed", "highlightString": "cillum labore" }, { "key": "ut sunt irure esse reprehenderit", "highlightString": "irure id reprehenderit nisi in" } ], "status": "error", "previous": { "incomplete": [ "e28f", "e28f", "workflow_start" ], "complete": [ "error_handler", "workflow_end" ], "error": [ "workflow_end", "workflow_start", "workflow_end" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "reprehenderit", "start_time": "1999-06-11T01:55:05.635Z", "end_time": -41983050.90241057, "finish_state": "error", "retrySettings": { "state": [ "failure", "success", "success" ], "autoRetry": true, "limit": 5759939, "delay": 9855972, "count": 49658556, "finishedRetrying": false }, "loop": { "atLeastOneComplete": false, "finishedCount": -36029877.3739363, "outgoing": [ "ad in deserunt" ] }, "childJobs": [ { "_id": "consequat mollit sint", "name": "laboris adipisicing eiusmod", "iteration": -16329575.127006546 }, { "_id": "ullamco", "name": "id aliquip officia", "iteration": 80812520.97629753 }, { "_id": "in reprehenderit Duis Ut eiusmod", "name": "do nostrud dolor", "iteration": -15108744.674915135 }, { "_id": "aliqua commodo nostrud", "name": "dolor", "iteration": 58406234.01985493 } ] }, "groups": [ { "_id": "ead74e5b9ef8227ff2368355", "provenance": "exercitation sit consequat", "name": "non Duis deserunt esse voluptate", "description": "ipsum reprehenderit amet", "memberOf": [ { "groupId": "b35446e1cf91baafed20ba1f", "aaaManaged": false }, { "groupId": "09654d6aad0fc395fde14ede", "aaaManaged": false }, { "groupId": "d3cae5d6f054b6fffb179544", "aaaManaged": false }, { "groupId": "c346b826b709c6de5278a248", "aaaManaged": false }, { "groupId": "6aba40d08a64b0f590f28eed", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit" } ], "inactive": false, "_meta": { "created": "1984-01-31T07:42:50.016Z", "updated": "1996-08-30T00:39:26.659Z", "migrationVersion": -8866057 } } ], "watchers": [ null, null, null, "Pronghorn" ], "metrics": { "start_time": -31606142.96293369, "progress": 0.8739193984998006, "end_time": 85996075.47262526, "user": null, "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }