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": "06f93cec188e14eee9cbf8d9", "font_size": 17734149, "type": "automation", "created": "1993-09-16T11:22:49.865Z", "last_updated": "2016-08-27T01:38:58.445Z", "createdVersion": "526.856037801.8724332-7240.8825550.11602", "lastUpdatedVersion": "00806.64.5", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 58525309, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -31144891.24787414, "sla": 10710071.299635798, "decorators": [ { "type": "encryption", "pointer": "/~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": "e28f", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "qui in consequat" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "aliquip Excepteur qui cupidatat" } ], "ancestors": null, "validationErrors": [ { "keyword": "ad deserunt magna esse", "instancePath": "culpa occaecat anim", "schemaPath": "ex non eu aliquip", "message": "reprehenderit" }, { "keyword": "in", "instancePath": "in in", "schemaPath": "deserunt cillum culpa voluptate", "message": "in Lorem" }, { "keyword": "eiusmod", "instancePath": "dolor amet occaecat", "schemaPath": "occaecat ea cupidatat mollit exercitation", "message": "occaecat culpa velit aliquip" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 65070461.36930835, "y": -39854819.205976136, "gridCoordinate": { "x": -51048721.004253484, "y": -77891562.40945223 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 9851936.557526916, "finish_state": "error", "user": null }, "groups": [ { "_id": "95829402f614e06a32d8d4a8", "provenance": "occaecat deserunt qui dolor", "name": "eu laboris qui ex esse", "description": "dolore enim", "memberOf": [ { "groupId": "ca9ef9e14e3f8bde30dd1500", "aaaManaged": true }, { "groupId": "8023631de948a4cfa435a3e5", "aaaManaged": false }, { "groupId": "b7cc91ae769108d4a511338c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing laboris veniam qui Excepteur" }, { "roleId": "tempor Duis" }, { "roleId": "ipsum non ut sunt" }, { "roleId": "adipisicing veniam in in" } ], "inactive": false, "_meta": { "created": "1971-06-21T00:31:20.395Z", "updated": "1990-05-13T08:43:30.212Z", "migrationVersion": 38829373 } }, "20d1010de6a66bb2b0d85da4", "default" ], "iterations": [ "a63B93de-c439-C055-d684-9c4ACcE918D1", "6Ee8FfeE-4450-bC3c-F1Bf-4AD3F884D5ce" ] }, "workflow_end": { "x": 80513427.99110022, "y": 77416475.64285597, "gridCoordinate": { "x": 87957758.76145557, "y": -73672698.5809082 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_start", "e28f" ], "error": [ "workflow_end", "3a1f", "workflow_start" ] }, "metrics": { "end_time": 65469872.472543776, "run_time": -77430959.97269967 }, "groups": [ "4939aa29a5242a5f3558e655", { "_id": "76780b66c14d4ac5620276ab", "provenance": "elit exercitation ea", "name": "Ut Excepteur in aliqua officia", "description": "dolore culpa ullamco Duis", "memberOf": [ { "groupId": "ae458971b443e4c6e027e4eb", "aaaManaged": false }, { "groupId": "a8b7b8abd5e90a0d069bf630", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi" }, { "roleId": "sed quis officia ex" } ], "inactive": false, "_meta": { "created": "1968-09-21T12:19:11.731Z", "updated": "1961-01-02T16:52:53.539Z", "migrationVersion": -4220435 } }, "720503bc7e9cdabd88a34d90", "03eb69310a7ceaeb730df0ee" ], "iterations": [ "eDFcce6c-B741-b8a0-a4A8-Cd7aab53a3CE" ] }, "error_handler": { "x": 64991610.146559566, "y": -28157676.313707873, "gridCoordinate": { "x": -99108030.30830282, "y": 75443357.8522538 }, "name": "childJob", "location": "Broker", "locationType": "ullamco et dolore", "app": "incididunt occaecat proident mollit ut", "canvasName": "amet incididunt laborum aute", "displayName": "cillum fugiat", "summary": "aute pariatur incididunt adipisicing", "description": "eu Ut amet dolore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/mi/~0/mW4+ExXaS-y/kpJpKQ-,Yk/~0/Cid/xS/O97JRslFF/ml8Eq/FbWq" }, { "type": "encryption", "pointer": "/C-uFe/k/hSrKbghA/~0/~1/a.Vee/Rgv/HgabAs" }, { "type": "encryption", "pointer": "/~1/V6/JS2/~0/qwKkyjUVlv/~0/~1/~1/v0j/F/~1/M1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "veniam ex est laboris", "highlightString": "aliquip qui sunt" } ], "status": "scheduled", "previous": { "incomplete": [ "error_handler", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "error_handler", "error_handler" ], "error": [ "error_handler", "e28f", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "dolor nulla dolor non ut", "start_time": "1998-12-25T03:25:49.31Z", "end_time": -55518274.40566011, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "dc1b095ea103dfb40ed7fee2", "groups": [ "default", "default", "77c379e977253383baf72667", { "_id": "3fd7667b3353af05e52e9cef", "provenance": "quis deserunt Excepteur in magna", "name": "labore aliqua", "description": "laborum", "memberOf": [ { "groupId": "743a5d30a130c19e25543271", "aaaManaged": false }, { "groupId": "88e8f4a18d017aac502336f7", "aaaManaged": false }, { "groupId": "88ff19fa03d4d46d36408f26", "aaaManaged": true }, { "groupId": "9abcfa3021337837da9937d9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa sit Duis consequat esse" }, { "roleId": "amet exercitation aute" }, { "roleId": "ipsum ad amet minim adipisicing" } ], "inactive": true, "_meta": { "created": "2001-03-23T19:19:11.85Z", "updated": "1971-12-10T02:53:00.331Z", "migrationVersion": 31210418 } } ], "iterations": [ "c400e7Ca-E6a0-AaAb-0Ea1-04114E68c88C" ] }, "f2": { "actor": null, "groups": [ "default", "default", "81a698e56b58d54a637977be" ], "iterations": [ "FBAfbF2d-cf0E-CDEf-4dbe-eE1f3fC8Cd89" ], "x": 7242409.607022807, "y": 71196514.75752136, "gridCoordinate": { "x": -6194581.44251062, "y": -96024093.27885586 }, "name": "pending", "summary": "occaecat minim id pariatur", "description": "minim ullamco elit" } }, "parent": { "job": "minim", "task": "in voluptate amet enim aliquip", "iteration": 61631995.20821649, "element": 59855403.823360294 }, "errorHandler": { "actor": null, "groups": [ "default" ], "iterations": [], "x": -70151235.26478267, "y": 19180977.324050725, "gridCoordinate": { "x": -77428812.35158828, "y": -88142228.84010018 }, "name": "pending", "summary": "ipsum do voluptate deserunt velit", "description": "nostrud Duis" }, "groups": [ "1f55a8af183b9e63abe1a976", "default", "72863af7a4fa3cb1e65cc89f", "default", "aee996cedc81cff2db860b9c" ], "watchers": [ null, null, null, null, "36581e83b6df4e8c9b9d9f36" ], "metrics": { "start_time": 19243433.58170049, "progress": 0.47826214131042444, "end_time": -29311669.433751002, "user": "Pronghorn", "owner": { "_id": "1119c9e11dc3ac6efa4cdabe", "provenance": "in est", "username": "non mollit cupidatat in", "firstname": "amet Lorem sit non officia", "memberOf": [ { "groupId": "51b2b81fb81dd007ec64caa0", "aaaManaged": false }, { "groupId": "1db5b961de600ac0b42fce3b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt cupidatat nulla" }, { "roleId": "sunt ut aute pariatur exercitation" } ], "inactive": false, "lastLogin": "1976-02-09T02:21:41.282Z", "_meta": { "created": "1990-02-28T10:49:29.946Z", "updated": "1955-08-27T14:16:01.629Z", "migrationVersion": -54875250 }, "email": "quis ad" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }