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 retrieved search results", "data": { "_id": "edd41cedbe0716d43f692cf4", "font_size": -62583682, "type": "automation", "created": "2024-05-31T23:24:02.499Z", "last_updated": "2019-06-03T02:21:31.602Z", "createdVersion": "978.34515.09-7963.3987307542.79.6371873", "lastUpdatedVersion": "84.9396.2709-4041.79302556892.3298870.58", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -42389547, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -21094110.222436905, "sla": -80396981.72990853, "decorators": [ { "type": "encryption", "pointer": "/Sw3,0u" }, { "type": "encryption", "pointer": "/~1/nBd,J/m/n8--YWin+r,/~1/Rbfb.pmT+6+/ipuPlaDSST1" } ], "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": "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", "message": "minim cupidatat" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "elit tempor quis nisi", "instancePath": "ullamco minim aliqua", "schemaPath": "laboris consequat culpa ullamco", "message": "consequat nulla" }, { "keyword": "Duis officia", "instancePath": "ipsum consectetur", "schemaPath": "ea", "message": "culpa in ut pariatur" }, { "keyword": "non Excepteur sit velit mollit", "instancePath": "Excepteur enim magna dolore non", "schemaPath": "aliquip laboris", "message": "ut sed in culpa nisi" }, { "keyword": "voluptate", "instancePath": "cupidatat velit", "schemaPath": "adipisicing est", "message": "pariatur" } ], "created_by": "Pronghorn", "last_updated_by": "3d9dbc7a95418f086defb404", "tasks": { "workflow_start": { "x": -88208927.32078405, "y": 98593279.4890604, "gridCoordinate": { "x": -67917540.03180265, "y": -99471947.73995638 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 34216089.80585234, "finish_state": "success", "user": "c19dfa96667a346d41faa211" }, "groups": [ "default", "default" ], "iterations": [] }, "workflow_end": { "x": 5344814.09218061, "y": -12537703.62140365, "gridCoordinate": { "x": -86113579.07563728, "y": -39992314.712807976 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "workflow_start", "error_handler" ], "complete": [ "error_handler" ], "error": [ "e28f" ] }, "metrics": { "end_time": 70191280.2235859, "run_time": -36612245.22233857 }, "groups": [ "e2e4144dc888ab5b7280e600", { "_id": "89664c423553ed300e18f0f5", "provenance": "consectetur", "name": "anim sunt non", "description": "nulla ut", "memberOf": [ { "groupId": "45e8d1cd5b5fb4bf8c2d60ca", "aaaManaged": true }, { "groupId": "a40e01dea73bfe3a177df596", "aaaManaged": true }, { "groupId": "e90941540f73676c50f76d49", "aaaManaged": false }, { "groupId": "dd249abb0d706e2f849bf472", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim amet velit Excepteur et" }, { "roleId": "Ut" } ], "inactive": true, "_meta": { "created": "1971-02-24T18:10:21.3Z", "updated": "1959-05-09T00:26:03.736Z", "migrationVersion": -77616954 } } ], "iterations": [] }, "error_handler": { "x": 95318183.2154522, "y": 425196.42522735894, "gridCoordinate": { "x": -42073788.23039356, "y": 65602178.36551306 }, "name": "childJob", "location": "Broker", "locationType": "nulla sunt", "app": "magna nulla", "canvasName": "aliqua nisi dolor deserunt", "displayName": "do fugiat", "summary": "laborum nostrud tempor", "description": "sit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/NvnP8/K" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "elit", "highlightString": "deserunt" }, { "key": "Duis in", "highlightString": "quis elit" }, { "key": "fugiat elit magna officia incididunt", "highlightString": "nisi deserunt non ut" } ], "status": "failure", "previous": { "incomplete": [ "error_handler" ], "complete": [ "e28f", "e28f", "error_handler" ], "error": [ "workflow_end", "workflow_start", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "ea sunt", "start_time": "1979-08-19T11:42:12.11Z", "end_time": 27794114.266541883, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "804b9c6b2d6a3a111d5c2d9b", "default", "e28c1eed4e0643319a0d1720", "default" ], "iterations": [] }, "f44": { "actor": "Pronghorn", "groups": [ { "_id": "7564b0d69d45f9256a09d942", "provenance": "voluptate Ut", "name": "id irure", "description": "in", "memberOf": [ { "groupId": "52c2823dbd9693611a35ef03", "aaaManaged": false }, { "groupId": "9a79ec72ac5bad699a026cdc", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis" }, { "roleId": "esse commodo ut dolor" }, { "roleId": "dolor deserunt in dolore" }, { "roleId": "commodo magna sint mollit" }, { "roleId": "elit id Ut irure" } ], "inactive": false, "_meta": { "created": "2019-02-17T09:50:23.359Z", "updated": "1958-01-19T14:28:35.886Z", "migrationVersion": -66701188 } }, { "_id": "afcd223dd78893f80ea356a2", "provenance": "minim culpa", "name": "sed nostrud veniam", "description": "officia id ut est proident", "memberOf": [ { "groupId": "5a96a9564c5c982ae40c0352", "aaaManaged": true }, { "groupId": "a551846071b90de1ae49a619", "aaaManaged": true }, { "groupId": "19af264e4774c4b74a3677ea", "aaaManaged": false }, { "groupId": "b6a7a85fb90ed3ce1de94514", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur voluptate ut" }, { "roleId": "in adipisicing" } ], "inactive": true, "_meta": { "created": "2019-01-17T06:27:10.459Z", "updated": "1992-04-22T03:32:31.938Z", "migrationVersion": -92360586 } }, "default", { "_id": "ce0627dc84aaff145656907c", "provenance": "fugiat", "name": "laboris est", "description": "et", "memberOf": [ { "groupId": "78ff3d996e3b5ac608edbd94", "aaaManaged": false }, { "groupId": "8d66d3d5c3e8a4814d5c460c", "aaaManaged": false }, { "groupId": "6ad156a1ca1e85725e420fc9", "aaaManaged": true }, { "groupId": "b0fa096b0e2230e7bedb1486", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum" }, { "roleId": "est pariatur" }, { "roleId": "aliqua veniam in id" } ], "inactive": false, "_meta": { "created": "2022-10-20T01:57:34.058Z", "updated": "2007-12-07T07:11:58.88Z", "migrationVersion": 57331607 } }, "df1d1c23d23a3cc20835c013" ], "iterations": [], "x": -3426495.956957832, "y": -94199925.31342034, "gridCoordinate": { "x": 91253842.59420624, "y": 55596524.380352974 }, "name": "pending", "summary": "aute tempor", "description": "in incididunt ex ad" } }, "parent": { "task": "amet aliqua", "iteration": -14908414.17012687, "element": 36873204.69839829 }, "errorHandler": null, "groups": [ { "_id": "10b918da3560d10bfe14b9f3", "provenance": "esse est", "name": "nisi exercitation dolor pariatur sed", "description": "ea sint minim proident", "memberOf": [ { "groupId": "0668d14876666167ada16919", "aaaManaged": true }, { "groupId": "33c314af68671a48b1662ef4", "aaaManaged": true }, { "groupId": "a767f414d9d1f891fffca189", "aaaManaged": true }, { "groupId": "8412309e90b8f60ec780dfa3", "aaaManaged": true }, { "groupId": "cae222d92cb616e5ae00ae49", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "Duis in" } ], "inactive": true, "_meta": { "created": "1985-12-04T19:48:46.539Z", "updated": "1975-09-10T16:16:55.16Z", "migrationVersion": 88471841 } } ], "watchers": [ null, { "_id": "9c5cceb3992fff6f5b236657", "provenance": "adipisicing magna proident", "username": "Duis aliqua", "firstname": "qui dolor proident laborum sunt", "memberOf": [ { "groupId": "3a8508e7a6e09af9cea7e869", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit ex eiusmod fugiat consectetur" }, { "roleId": "anim" }, { "roleId": "voluptate" } ], "inactive": true, "lastLogin": "1985-04-12T03:44:35.031Z", "_meta": { "created": "2023-01-06T08:29:24.897Z", "updated": "1981-09-16T14:11:04.673Z", "migrationVersion": 33845493 }, "email": "sit" } ], "metrics": { "start_time": -21066944.692913964, "progress": 0.8575665236797663, "end_time": -98271353.73422013, "user": "Pronghorn", "owner": { "_id": "ba8cf4ad114ffba8c5296251", "provenance": "in et nostrud deserunt", "username": "labore", "firstname": "proident", "memberOf": [ { "groupId": "469c8024f1aeec992e3dd24f", "aaaManaged": false }, { "groupId": "b2c4b4702d8e5814ceddbc3d", "aaaManaged": true }, { "groupId": "99f150f7ca1bc2e3b3a3252e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem dolor sed voluptate" } ], "inactive": true, "lastLogin": "1988-03-05T22:37:25.347Z", "_meta": { "created": "2001-12-28T16:10:14.299Z", "updated": "2014-09-14T12:21:24.91Z", "migrationVersion": -38540875 }, "email": "et ea pariatur" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }