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": "5df0abbef79163d70e4f7b8d", "font_size": 95870503, "type": "automation", "created": "1949-03-08T22:24:55.298Z", "last_updated": "1971-06-02T16:48:32.407Z", "createdVersion": "4.4095419391.7577878-3178.24733397489.5794730", "lastUpdatedVersion": "3.29983.7-2859.2377366192.0", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -37828694, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -76905493.58420373, "sla": -81886183.8772969, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/u4ecbfyQs4" }, { "type": "encryption", "pointer": "/CCLy" }, { "type": "encryption", "pointer": "/cZzTCOYXX/nbYZSTf6f9/~0/AOEcMepXqY/UB6fXDFzZr" }, { "type": "encryption", "pointer": "/~1/~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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": [ "5d01980522b72aa9aa24a240", "449b16980885490fc0885d4e", "609ec5401aebf2381f4ba9f6" ], "validationErrors": [ { "keyword": "ea qui Excepteur pariatur minim", "dataPath": "fugiat Excepteur eiusmod irure", "schemaPath": "eu aute aliquip reprehenderit", "message": "do sint Ut consequat aute" } ], "created_by": "Pronghorn", "last_updated_by": "c269e27d931a73a1879135f7", "tasks": { "workflow_start": { "x": -54278383.42410523, "y": 80209617.60478973, "gridCoordinate": { "x": -27285104.872632667, "y": -3783066.468911305 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -42280227.872071266, "finish_state": "error", "user": { "_id": "aabbdb56dc443bddf98053bd", "provenance": "in cillum veniam Excepteur", "username": "do", "firstname": "mollit reprehenderit enim dolore dolor", "memberOf": [ { "groupId": "ec31f402f00e1556a0ee1d88", "aaaManaged": true }, { "groupId": "f94dc1215a19d1157021a54b", "aaaManaged": true }, { "groupId": "421d969d2c9023c88f28897d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui" }, { "roleId": "ut elit in ipsum minim" }, { "roleId": "laborum labore dolor veniam" } ], "inactive": false, "lastLogin": "1946-02-03T14:29:12.84Z", "_meta": { "created": "2019-12-26T21:31:27.075Z", "updated": "2011-12-14T15:22:38.579Z", "migrationVersion": 54783412 }, "email": "occaecat" } }, "groups": [ "default", { "_id": "e8e0e49da6af0991797dc8bf", "provenance": "voluptate", "name": "velit laboris", "description": "do laborum occaecat laboris", "memberOf": [ { "groupId": "7b71a854b6adb371e6e99f64", "aaaManaged": true }, { "groupId": "ce881ee6a69d425509002b4e", "aaaManaged": true }, { "groupId": "dab7273e4a60fedcb3c2b7e4", "aaaManaged": false }, { "groupId": "f738a1f98ac29d357aa744fa", "aaaManaged": false }, { "groupId": "03db84d476b286ae10d34ece", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum id" }, { "roleId": "ad amet dolor velit" }, { "roleId": "commodo Duis" } ], "inactive": false, "_meta": { "created": "1950-04-30T03:29:38.769Z", "updated": "2004-10-27T02:41:48.259Z", "migrationVersion": -54916976 } }, "5f15bf84126e73963c51f523", "default", "default" ], "iterations": [ "Cadaedec-beBB-0b7B-8c9A-b0cec7fF5e32" ] }, "workflow_end": { "x": 81900090.6033743, "y": -14371935.52349995, "gridCoordinate": { "x": -87918561.71698433, "y": -68132957.02920179 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_end" ], "complete": [ "error_handler", "e28f" ], "error": [ "error_handler", "3a1f", "3a1f", "workflow_start", "error_handler" ] }, "metrics": { "end_time": -11955058.187040985, "run_time": 76740450.25274232 }, "groups": [ "default", "34957405323c84e3d4e532e5", "default", "default", "3235774143a55b5dce2b489a" ], "iterations": [] }, "error_handler": { "x": 87073427.92090917, "y": 668522.4545030594, "gridCoordinate": { "x": 45031801.38212147, "y": 83336159.9624385 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "incididunt", "canvasName": "Lorem dolor ea exercitation", "displayName": "cillum aliquip officia", "summary": "exercitation dolore", "description": "sit voluptate", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/UWqSkqIQt/~1/H90eimBxU/~1/~0/F/Qsih/z53,/~0/n/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "nisi ex pariatur ad anim", "highlightString": "nisi et incididunt laboris" }, { "key": "exercitation amet in deserunt", "highlightString": "aute" }, { "key": "Ut ut voluptate irure", "highlightString": "amet labore pariatur dolore" } ], "status": "complete", "previous": { "incomplete": [ "workflow_end", "workflow_start" ], "complete": [ "workflow_start", "error_handler", "workflow_end" ], "error": [ "workflow_start", "error_handler", "3a1f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "loop" } ] }, "serverId": "cupidatat", "start_time": "1980-04-09T18:01:48.922Z", "end_time": 52303706.96584588, "finish_state": "success", "retrySettings": { "state": [ "failure", "failure", "failure", "error", "error" ], "autoRetry": false, "limit": 12646073, "delay": 71319247, "count": 57249236, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "93a182e1e108b201b9734699", { "_id": "5bbd5fdae0cffb23c30f9bfd", "provenance": "ad in", "name": "aliqua qui", "description": "veniam dolor laborum incididunt", "memberOf": [ { "groupId": "3eee7c9d5daa73fa96b78d4b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim dolore eu anim fugiat" }, { "roleId": "commodo" }, { "roleId": "proident deserunt non" }, { "roleId": "voluptate" } ], "inactive": true, "_meta": { "created": "2014-12-03T11:22:51.513Z", "updated": "1951-03-15T04:54:18.43Z", "migrationVersion": 45526748 } } ], "iterations": [ "D9C9c695-C2ab-eA5d-cfB0-67EcFDe1403D" ] }, "e869": { "x": 66731604.203234345, "y": 99696076.0901362, "gridCoordinate": { "x": -68063950.52818143, "y": 90676755.03973264 }, "name": "sit reprehenderit commodo aute", "location": "Adapter", "locationType": "fugiat sint ut", "app": "incididunt nisi adipisicing velit", "canvasName": "est veniam", "displayName": "ipsum esse exercitation amet", "summary": "ea quis eiusmod voluptate cillum", "description": "sunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/hsGMk7RW5Q/tmfc5GF,pg/~0/JmvMH/~1/~0/~1/S5Z/~0/j" }, { "type": "encryption", "pointer": "/gt/XVAKokxj//~1/quctqb1ww/~1/f/N" }, { "type": "encryption", "pointer": "/~1/~0/IVj,Z/-OtHD" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "velit magna ipsum eu", "highlightString": "non reprehenderit qui culpa officia" }, { "key": "est sint", "highlightString": "incididunt in officia cillum Ut" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "3a1f", "e28f", "3a1f" ], "complete": [ "error_handler", "workflow_start" ], "error": [ "error_handler", "error_handler", "e28f", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "sed", "start_time": "1980-12-01T07:56:51.54Z", "end_time": -20050563.54527843, "finish_state": "success", "retrySettings": { "state": [ "failure", "success" ], "autoRetry": true, "limit": 30004939, "delay": 98646921, "count": 32248787, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "d0a80b0dbb6ff73baf0cbe99", "provenance": "in ut veniam ullamco", "name": "nisi qui", "description": "nisi", "memberOf": [ { "groupId": "0f37ca963b97500e6f1fe8cd", "aaaManaged": true }, { "groupId": "108b78e051406987e827117b", "aaaManaged": true }, { "groupId": "56a5b989cfb7aef400190d95", "aaaManaged": true }, { "groupId": "256b3f21f124bd0a0cb15bd2", "aaaManaged": false }, { "groupId": "e519953fab979cc8403eb82a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur sint cupidatat qui dolor" }, { "roleId": "eiusmod dolore consequat Duis" }, { "roleId": "esse sunt mollit" } ], "inactive": false, "_meta": { "created": "1992-11-18T06:44:33.98Z", "updated": "1957-09-15T17:18:11.961Z", "migrationVersion": 97913660 } } ], "iterations": [ "aE6Db9C7-eD57-d47f-ab47-1e119A1bfFc5" ] } }, "parent": { "job": "eiusmod deserunt laborum ea amet", "task": "incididunt", "iteration": -31592868.613476545, "element": 72829858.96667874 }, "errorHandler": null, "groups": [ "3c23a4169cf0b8ce07ba8fca", "default", { "_id": "b32ff29e973fba52490d0e48", "provenance": "eiusmod in Ut", "name": "ut", "description": "dolore ea cillum et", "memberOf": [ { "groupId": "14a94ee5f04494c66d84c557", "aaaManaged": true }, { "groupId": "0b4791efb2bc148a146c73e4", "aaaManaged": true }, { "groupId": "f8f81d37eed0091a213b1cef", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur" } ], "inactive": false, "_meta": { "created": "1952-01-30T09:03:02.139Z", "updated": "1973-08-02T19:19:39.834Z", "migrationVersion": -43623836 } } ], "watchers": [ "e42c730b370295ea1968cc8b", null, null ], "metrics": { "start_time": 39781798.410444975, "progress": 0.25708386533752803, "end_time": -10668012.068253934, "user": null, "owner": { "_id": "62f260dd05a6d4c6c10152b2", "provenance": "Lorem qui ullamco ea", "username": "eu aute", "firstname": "quis irure", "memberOf": [ { "groupId": "5dee3072dc33853061ecb16c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor" } ], "inactive": true, "lastLogin": "2002-10-28T06:58:25.258Z", "_meta": { "created": "1962-04-05T08:20:27.878Z", "updated": "1978-01-17T12:26:10.61Z", "migrationVersion": -83962028 }, "email": "esse in" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }