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 created the requested item", "data": { "_id": "bddd703b4f1eeed436838673", "font_size": 10428233, "type": "automation", "created": "2004-10-30T07:33:14.963Z", "last_updated": "1965-02-15T06:26:22.376Z", "createdVersion": "63364.91667887.81786456", "lastUpdatedVersion": "99439.216458.37620603-2952.944810.76123832817", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 5672960, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 17526501.08278337, "sla": -94820499.62502526, "decorators": [ { "type": "encryption", "pointer": "/G3vPcJUuL/q1/C7Gk2j" } ], "status": "complete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "aliquip amet" } ], "ancestors": [ "a599f1e43e898c8b7029f413", "5e48e801464bceb9070a33cb", "dc4de712dc3b781c2920bff6" ], "validationErrors": [ { "keyword": "pariatur Duis esse", "instancePath": "cupidatat", "schemaPath": "nostrud aliqua qui sunt incididunt", "message": "commodo in" } ], "created_by": null, "last_updated_by": null, "tasks": { "workflow_start": { "x": 22638980.42472233, "y": 73332122.06585357, "gridCoordinate": { "x": 548101.5758278817, "y": -30700594.813014746 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 32395585.964692637, "finish_state": "success", "user": "eb96d6e27b288e86b846fc5a" }, "groups": [ { "_id": "f7831b83b5ddada82ea3d88f", "provenance": "velit incididunt culpa do", "name": "in exercitation", "description": "commodo qui officia consectetur tempor", "memberOf": [ { "groupId": "93745f029e7c4a6448d67c38", "aaaManaged": true }, { "groupId": "c0cb74927ae41deb94a23c6d", "aaaManaged": false }, { "groupId": "c16733105fa74b7a5ad516c4", "aaaManaged": true }, { "groupId": "adee4f5cff566ad8dcb8b7cc", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sit Lorem adipisicing laboris" } ], "inactive": true, "_meta": { "created": "1957-10-21T15:28:44.713Z", "updated": "1967-03-15T01:27:31.707Z", "migrationVersion": -71204252 } }, "default" ], "iterations": [ "b06C4C21-F720-7fa9-9d91-191abA4C97e8", "7BA58Ab9-254A-eBBe-d7e5-cF0bd183EA2A" ] }, "workflow_end": { "x": -33657195.84837992, "y": -28518941.54132189, "gridCoordinate": { "x": -13815794.145217717, "y": -55233899.10626411 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_end", "workflow_end", "workflow_start" ], "complete": [ "3a1f", "e28f", "workflow_end", "error_handler" ], "error": [ "error_handler", "e28f", "workflow_end" ] }, "metrics": { "end_time": -2842909.1017487794, "run_time": -40686345.57784736 }, "groups": [ { "_id": "cedd9187d74d566f84b62944", "provenance": "dolore", "name": "amet nulla dolor ut dolor", "description": "ad", "memberOf": [ { "groupId": "4e9db4a8e8fbf2810c2e031c", "aaaManaged": true }, { "groupId": "3f945159d088f7fdd6217336", "aaaManaged": true }, { "groupId": "20d61ede55867d8574d2f8be", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Ut aute" } ], "inactive": true, "_meta": { "created": "1967-03-26T17:54:14.213Z", "updated": "1953-05-19T01:12:14.162Z", "migrationVersion": 59468904 } }, "default", { "_id": "347118aba74bfbec6acfe72d", "provenance": "ullamco proident occaecat sint consequat", "name": "ipsum eiusmod", "description": "enim", "memberOf": [ { "groupId": "7b585e66bedea430f2cbf4af", "aaaManaged": true }, { "groupId": "74fc91c9e3f657a9722c89a2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad consectetur et fugiat" } ], "inactive": false, "_meta": { "created": "1965-02-06T17:04:51.215Z", "updated": "1975-08-07T08:05:27.421Z", "migrationVersion": 10560532 } }, { "_id": "ecbcdb72e0047aa423a8d210", "provenance": "exercitation reprehenderit magna proident dolore", "name": "ex sunt", "description": "ex aliquip consectetur proident", "memberOf": [ { "groupId": "bf4435a8ecdcb902e4471e67", "aaaManaged": true }, { "groupId": "95000dfb49d036291e38b6ff", "aaaManaged": true }, { "groupId": "5d466310579c42902887193d", "aaaManaged": true }, { "groupId": "dcb8797b0184e3f4cb8b7979", "aaaManaged": false }, { "groupId": "4d5e87a8006b3bae066e69b9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse non consectetur officia" }, { "roleId": "qui eiusmod dolor deserunt" }, { "roleId": "tempor nisi voluptate ullamco minim" }, { "roleId": "cupidatat" } ], "inactive": false, "_meta": { "created": "1980-04-06T17:19:44.349Z", "updated": "2001-04-16T08:59:00.976Z", "migrationVersion": 46204142 } } ], "iterations": [] }, "error_handler": { "x": -13374507.077428758, "y": 91312646.88922909, "gridCoordinate": { "x": 31036002.575463995, "y": -1914283.1910491139 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "dolor", "canvasName": "ut", "displayName": "nostrud dolore sed reprehenderit", "summary": "in", "description": "fugiat culpa deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/fR,h/I/~0/rdlKPIkdR" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "ex ad dolore velit", "highlightString": "sed" }, { "key": "sit id", "highlightString": "ad eu sit" }, { "key": "ullamco", "highlightString": "Ut exercitation" }, { "key": "quis nulla esse qui", "highlightString": "elit" }, { "key": "aute dolor", "highlightString": "laboris incididunt anim" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "3a1f" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "workflow_end", "3a1f" ], "error": [ "e28f", "workflow_end", "error_handler" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "ipsum enim elit Lorem", "start_time": "2011-08-06T14:52:20.099Z", "end_time": -23351225.46298431, "finish_state": "failure", "retrySettings": { "state": [ "error", "error" ], "autoRetry": false, "limit": 37714905, "delay": 69855730, "count": 16362940, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "5fb3082fb54262b15535364a", "provenance": "voluptate dolor laboris", "name": "ea magna est", "description": "ullamco adipisicing occaecat ut labore", "memberOf": [ { "groupId": "732b6662ee55054f9ae34c4d", "aaaManaged": true }, { "groupId": "f4dcc872d6c8b445d1d58141", "aaaManaged": true }, { "groupId": "ef32f3cfe42d5b8f67c0daa3", "aaaManaged": false }, { "groupId": "5923bc1da42f89cb46629df7", "aaaManaged": false }, { "groupId": "04df1d5f3134a0bbc2c1d54c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat" }, { "roleId": "consequat dolore sit ullamco enim" } ], "inactive": false, "_meta": { "created": "1949-06-22T00:23:31.901Z", "updated": "1949-08-13T04:35:07.305Z", "migrationVersion": 73742625 } }, { "_id": "3f5758beac44df78a17ed201", "provenance": "voluptate fugiat ut dolore sed", "name": "quis dolor amet ut", "description": "in", "memberOf": [ { "groupId": "044e6d24ef357d40e984c905", "aaaManaged": false }, { "groupId": "5fc7dfc4b478b46a9fa48d3c", "aaaManaged": true }, { "groupId": "cbbcf1d538be1a7ca0b623a0", "aaaManaged": true }, { "groupId": "4598b5465ac7ce9f47fea306", "aaaManaged": false }, { "groupId": "0920144f91fe0a03b1bdb36a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident nulla amet" }, { "roleId": "ut in enim anim ad" } ], "inactive": true, "_meta": { "created": "1982-12-19T20:26:23.553Z", "updated": "2020-08-29T09:02:39.428Z", "migrationVersion": 58785361 } }, "default" ], "iterations": [ "9d8a2E4F-ab77-1F00-FBdE-AcDde50d9Fba" ] }, "c8": { "actor": "Pronghorn", "groups": [ { "_id": "539299ca33b5d140e7be6abc", "provenance": "irure elit", "name": "minim commodo sit", "description": "adipisicing ad pariatur aliqua", "memberOf": [ { "groupId": "240ab4ca308ebe0ff59615a4", "aaaManaged": false }, { "groupId": "f9e22a67e790c357943a54e5", "aaaManaged": true }, { "groupId": "7c10ea89ec3a137f96eecaee", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex cillum ullamco sit minim" }, { "roleId": "labore est non" }, { "roleId": "consectetur" }, { "roleId": "ad commodo ullamco eiusmod" } ], "inactive": true, "_meta": { "created": "1958-09-21T19:35:23.752Z", "updated": "2013-10-07T22:55:17.748Z", "migrationVersion": -41804647 } }, "default", "default", { "_id": "5d78bd02bc7b0861b67399b4", "provenance": "officia do fugiat labore culpa", "name": "eu cillum", "description": "dolore adipisicing dolor ex", "memberOf": [ { "groupId": "e6db53b630b0f7b9afcc2114", "aaaManaged": false }, { "groupId": "22311247c239ecc7dee71d88", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis" }, { "roleId": "fugiat in" }, { "roleId": "dolor fugiat" }, { "roleId": "occaecat ullamco ex sed" }, { "roleId": "dolore occaecat" } ], "inactive": true, "_meta": { "created": "2019-05-14T00:17:57.274Z", "updated": "2008-12-25T08:54:52.349Z", "migrationVersion": 59258311 } } ], "iterations": [ "a01Bc2b6-EDF3-fF83-EBd4-1F14AE5FcE5B" ], "x": -29266974.967803255, "y": -58473571.69569274, "gridCoordinate": { "x": 80264294.8299323, "y": 50212296.07404241 }, "name": "velit ullamco pariatur cupidatat", "location": "Broker", "locationType": null, "app": "aute magna consequat officia", "canvasName": "childJob", "displayName": "in proident aliquip Excepteur", "summary": "culpa", "description": "quis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/OOoNSBp/~1/~0/YyLUJSTJ/~1" }, { "type": "encryption", "pointer": "/~1/D8M4uSOimD9/~1" }, { "type": "encryption", "pointer": "/~0/s.NfpGPwUA/~0/O+E/~0/~0/HQbM5jfz/Q04tNXF0L/~1" }, { "type": "encryption", "pointer": "/wpBHNkpn/cT" }, { "type": "encryption", "pointer": "/~0/HQp,5sc+mc/~0/y/H3k8/sKfR/~1/m67Z0htTS,/KGyg/i1I.62/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "est", "highlightString": "deserunt ad aliqua Lorem labore" }, { "key": "in irure", "highlightString": "cillum consequat ad Lorem fugiat" }, { "key": "officia aliquip nisi voluptate", "highlightString": "Excepteur pariatur in" }, { "key": "nostrud", "highlightString": "labore deserunt" }, { "key": "id in est Duis velit", "highlightString": "exercitation culpa ad pariatur" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "error_handler", "workflow_start" ], "complete": [ "workflow_start", "error_handler", "workflow_end", "3a1f", "workflow_end" ], "error": [ "workflow_start", "workflow_start", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "laborum dolore ut", "start_time": "1961-02-09T09:05:04.223Z", "end_time": -21637067.500301123, "finish_state": "success", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -31305165.177707255, "outgoing": [ "voluptate quis nostrud Ut", null ] }, "childJobs": [ { "_id": "proident", "name": "anim", "iteration": -3906567.910596743 } ] } }, "parent": { "task": "enim consectetur laborum", "iteration": -9111756.914525941, "element": -590110.7171346992 }, "errorHandler": null, "groups": [ { "_id": "587d79d3d9dc8d70fdcb94d7", "provenance": "voluptate est cupidatat enim sint", "name": "sint sunt", "description": "officia pariatur dolor", "memberOf": [ { "groupId": "e3551c8ee8a9414ed1cb7852", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat" } ], "inactive": true, "_meta": { "created": "1945-06-25T16:18:14.677Z", "updated": "2023-07-11T09:21:31.728Z", "migrationVersion": 17650928 } }, "default", "default", "default" ], "watchers": [ "33c3f3d2624fbe9b72f64920", { "_id": "52e9b7eba580b0a2c96835d6", "provenance": "adipisicing laboris", "username": "sint commodo enim Duis", "firstname": "voluptate qui eu officia", "memberOf": [ { "groupId": "7f37e640f7a633e49c8655c7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est aliqua elit" }, { "roleId": "ullamco laboris cillum" }, { "roleId": "aliqua id cupidatat ipsum et" }, { "roleId": "non magna" }, { "roleId": "pariatur id culpa incididunt dolor" } ], "inactive": false, "lastLogin": "1995-09-13T17:48:48.395Z", "_meta": { "created": "2019-10-12T08:48:02.196Z", "updated": "2022-11-22T21:35:36.756Z", "migrationVersion": 79648094 }, "email": "commodo aliquip elit" }, "Pronghorn", "2f09803cfb19cf32472e0ebd", "b07eea4e89ef68bc961e66ed" ], "metrics": { "start_time": -50157997.96414648, "progress": 0.31802992419119214, "end_time": 37750545.001470625, "user": "7a290ee208e7130ffa2189ac", "owner": "81d515785983f1ed1f01054d" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }