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": "de89f8afa1086f6cc9b13b9c", "font_size": -1173208, "type": "resource:action", "created": "1991-08-26T22:12:44.063Z", "last_updated": "1964-02-20T14:43:35.024Z", "createdVersion": "0333181636.17457352894.353", "lastUpdatedVersion": "3354.786021062.51615", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 22917920, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -74498131.5558602, "sla": -91504226.76310627, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/JFdhLBwCK/B6P" }, { "type": "encryption", "pointer": "/~0/v/LmtjrzPij/~0/N0o/c8,/TsPi4jk/AMEnZ+Q/b+ezC/~1/SGrmY-Mot,S/mmBeUIfzQkJ/~0" } ], "status": "canceled", "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": "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "laborum" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "nostrud veniam" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "sint Excepteur" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "tempor anim", "dataPath": "do commodo", "schemaPath": "Ut", "message": "Duis commodo" }, { "keyword": "consectetur nulla anim dolore in", "dataPath": "dolore sed velit officia in", "schemaPath": "enim sed dolor occaecat dolore", "message": "veniam Excepteur voluptate" }, { "keyword": "quis occaecat fugiat culpa id", "dataPath": "quis reprehenderit officia", "schemaPath": "ipsum sunt minim ea", "message": "in" } ], "created_by": "43cbbb23960a8c837fd96af1", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -62763763.28505746, "y": 55763332.08301118, "gridCoordinate": { "x": -16729481.017642379, "y": 57518041.21039447 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 46529196.370226264, "finish_state": "failure", "user": "ae28efc5dba994496c4b3a37" }, "groups": [ "090528ff126cc54580fe904e", { "_id": "0e2eae425f97ad97438e8762", "provenance": "anim deserunt aliqua proident dolor", "name": "consequat qui elit", "description": "amet", "memberOf": [ { "groupId": "3b446dd640f556cb9873def2", "aaaManaged": false }, { "groupId": "7533f2ec8064f6091ac4e0b9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia pariatur fugiat" }, { "roleId": "Ut culpa minim commodo reprehenderit" }, { "roleId": "laboris ad nisi deserunt sint" }, { "roleId": "voluptate sit" }, { "roleId": "id ipsum dolore" } ], "inactive": false, "_meta": { "created": "2002-07-27T15:04:58.163Z", "updated": "1973-05-06T06:41:47.823Z", "migrationVersion": -34582472 } }, "367f192fd8dc4319c93e0d83", "default" ], "iterations": [] }, "workflow_end": { "x": 4765830.749491155, "y": 51690493.28401521, "gridCoordinate": { "x": 4394558.009530187, "y": -11388587.321368828 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "3a1f", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "workflow_end", "workflow_end" ] }, "metrics": { "end_time": -82601236.19974373, "run_time": -13858764.53195776 }, "groups": [ { "_id": "64edc4cb0babf41dbbfa284b", "provenance": "Lorem", "name": "culpa nostrud Lorem aute", "description": "veniam anim aliqua irure nisi", "memberOf": [ { "groupId": "fe2d91e63c86f51f23377b17", "aaaManaged": false }, { "groupId": "11110e7296e79fca9eaa5f49", "aaaManaged": true }, { "groupId": "56fdda358e210155dce846a7", "aaaManaged": false }, { "groupId": "cb6ec254129f1e3f4fe9e34f", "aaaManaged": true }, { "groupId": "0e6acc7ef9825c4fd16fa0d3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute do sint" }, { "roleId": "culpa" }, { "roleId": "qui" }, { "roleId": "esse" }, { "roleId": "ut" } ], "inactive": true, "_meta": { "created": "1999-12-21T11:08:26.579Z", "updated": "1954-08-10T03:36:27.914Z", "migrationVersion": -62011132 } }, "af20c0f2e5aea30b8530035c", "dfe9fa997e8aeee4a727b92f", "e112351a6ec1c30020ab1229", { "_id": "0542928ba8b1c235b68a9c90", "provenance": "deserunt Excepteur incididunt ex eu", "name": "laboris consectetur", "description": "id minim ex cupidatat", "memberOf": [ { "groupId": "f637f215606a84b166cc3cd4", "aaaManaged": false }, { "groupId": "ab08cebdb01d09866de7abc4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla" }, { "roleId": "dolore ut in mollit" }, { "roleId": "dolor Lorem reprehenderit laboris" }, { "roleId": "ea dolor" } ], "inactive": false, "_meta": { "created": "1950-04-10T02:07:39.537Z", "updated": "2004-05-22T15:41:17.047Z", "migrationVersion": -622397 } } ], "iterations": [ "AdfEd69a-4a77-6aFa-10fd-aDA0A5CA7B7F", "3EaA0CED-eFD1-eD48-0798-647bF024Ceb5", "dbFD2050-6CcE-7cE6-Ff26-38fbBE3Af364" ] }, "error_handler": { "x": -69179738.10053843, "y": 87534171.32436004, "gridCoordinate": { "x": -9274585.59634, "y": -43836149.864849135 }, "name": "childJob", "location": "Application", "locationType": null, "app": "in ipsum irure culpa quis", "canvasName": "dolore", "displayName": "eiusmod", "summary": "quis do ad", "description": "nostrud reprehenderit aliquip", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/KocYPOnf/~0/~1/H-tZn7wd-/~1/~1/ImuC2tE" }, { "type": "encryption", "pointer": "/GLc9OJnpk.5/~0/l/dz/~0" }, { "type": "encryption", "pointer": "/Xq/XXgE5SF9/~1/CwkvW" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "fugiat velit labore cupidatat esse", "highlightString": "ut sed proident" }, { "key": "aliqua fugiat", "highlightString": "magna" }, { "key": "Excepteur", "highlightString": "enim fugiat" } ], "status": "scheduled", "previous": { "incomplete": [ "3a1f", "workflow_end", "error_handler" ], "complete": [ "workflow_start", "workflow_end", "3a1f" ], "error": [ "workflow_end", "e28f", "3a1f", "error_handler", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "consectetur enim culpa", "start_time": "1984-11-16T18:00:27.556Z", "end_time": -92533831.16162448, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default" ], "iterations": [ "84267aDE-BfA1-c8D5-0a36-fBE0dA272249", "e2fbcD57-3a7C-A484-9BFA-5bd49Ab85f9B" ] }, "1cf": { "actor": "job", "groups": [ "40070332a79b19f05eab668e", "8d53d20e6e47cd95facde188", "default" ], "iterations": [], "x": 24265073.826088652, "y": 7772190.830464393, "gridCoordinate": { "x": -92336985.79358767, "y": 18477045.60738866 }, "name": "enim Duis aliqua", "location": "Application", "locationType": null, "app": "ad commodo ullamco minim quis", "canvasName": "veniam voluptate irure consectetur", "displayName": "minim qui nulla sunt", "summary": "sed voluptate Ut aute consequat", "description": "nulla", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/UwX-DRIs/Vba7FVhE/~0/tk0-0cU" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "amet anim ad sit", "highlightString": "voluptate nisi labore fugiat" }, { "key": "in occaecat magna adipisicing", "highlightString": "Duis ut exercitation" }, { "key": "ad", "highlightString": "est velit fugiat nisi" }, { "key": "enim culpa irure incididunt nostrud", "highlightString": "dolore" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "error_handler" ], "complete": [ "workflow_start", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "workflow_start", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" } ] }, "serverId": "consectetur Excepteur aliquip mollit", "start_time": "2020-08-23T06:02:34.67Z", "end_time": 93192963.87639952, "finish_state": "failure", "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 61235989, "delay": 10129449, "count": 87421249, "finishedRetrying": false }, "type": "manual", "view": "ex sit" } }, "parent": { "task": "fugiat veniam velit esse dolore", "iteration": -47741459.57609144, "element": -5994130.894039214 }, "errorHandler": { "actor": "job", "groups": [ { "_id": "8689f99cab122dfbc766e393", "provenance": "eu magna mollit esse anim", "name": "occaecat aliquip sint", "description": "incididunt culpa dolor", "memberOf": [ { "groupId": "c16aea4c291ba4bd428538b7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis" }, { "roleId": "non" }, { "roleId": "fugiat sunt" } ], "inactive": true, "_meta": { "created": "1952-06-23T05:41:13.157Z", "updated": "1993-10-25T16:50:20.018Z", "migrationVersion": -64974748 } } ], "iterations": [], "x": 46180655.14094171, "y": 77443753.65246043, "gridCoordinate": { "x": 59728191.075180024, "y": -99834072.9809895 }, "name": "ipsum eu nostrud", "location": "Broker", "locationType": null, "app": "Lorem incididunt aute irure aliqua", "canvasName": "fugiat occaecat ullamco", "displayName": "officia anim consequat ut commodo", "summary": "est qui consectetur", "description": "ea in amet nulla in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/t/haN32Et/~0/~0/~0/UW6y.vAKW/N,5/h81" }, { "type": "encryption", "pointer": "/dFr5aeMD98/Igsp3a8fB/~0/i-P" }, { "type": "encryption", "pointer": "/ImR/6/OoM/~1/z7d5CZjPH/OttIZJq/lb/~0/~1/~1/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "Duis pariatur minim aliqua", "highlightString": "aliqua nisi elit" }, { "key": "adipisicing occaecat esse aliqua", "highlightString": "ex reprehenderit" } ], "status": "failure", "previous": { "incomplete": [ "workflow_end", "error_handler", "error_handler", "e28f", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "e28f", "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "sint labore incididunt", "start_time": "1977-11-23T10:40:56.139Z", "end_time": 36591393.45080683, "finish_state": "error", "retrySettings": { "state": [ "failure", "error", "error", "failure" ], "autoRetry": true, "limit": 58005707, "delay": 50421251, "count": 29591949, "finishedRetrying": true }, "type": "manual", "view": "cillum" }, "groups": [ "default" ], "watchers": [ "Pronghorn" ], "metrics": { "start_time": -61130109.219560325, "progress": 0.8329818985287298, "end_time": 53737899.842264354, "user": { "_id": "b069bac5ce433252344357f7", "provenance": "exercitation amet aliqua", "username": "esse", "firstname": "dolor qui dolore ea anim", "memberOf": [ { "groupId": "35141c66ad2b72fc87313b31", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex minim veniam qui" }, { "roleId": "sed labore" } ], "inactive": false, "lastLogin": "1953-01-14T06:51:56.519Z", "_meta": { "created": "1947-01-08T18:47:03.906Z", "updated": "2011-10-21T01:01:04.412Z", "migrationVersion": 89976210 }, "email": "irure" }, "owner": "d9d3dbd25a34c4207146e676" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }