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": "f20f83cc1b22d923a4c6d440", "font_size": -26096676, "type": "resource:action", "created": "2012-06-17T22:28:40.546Z", "last_updated": "2000-03-27T04:25:47.586Z", "createdVersion": "69192.83673885.1311467-9488.616190.1792.43", "lastUpdatedVersion": "37618.0924528714.2451", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -56780212, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 94469181.94268978, "sla": 91367992.58418518, "decorators": [ { "type": "encryption", "pointer": "/E-/~1" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/ldc/yto9j,/~0/~0/~0/LA3f3I6/B1I-1AASc/~0/~1" }, { "type": "encryption", "pointer": "/U+rnasYs2p/~0/J47MD/T3jB0fLc/~1/~0/uzic2f,7GqE/~0" }, { "type": "encryption", "pointer": "/l,d/m./~1/~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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "ad anim dolore" } ], "ancestors": null, "validationErrors": [ { "keyword": "Ut nostrud laborum tempor qui", "dataPath": "cillum", "schemaPath": "magna", "message": "laboris velit" }, { "keyword": "adipisicing in non", "dataPath": "voluptate anim Lorem enim tempor", "schemaPath": "sit nisi", "message": "non enim aliqua aliquip Excepteur" }, { "keyword": "ut ex in anim", "dataPath": "ut dolore dolor", "schemaPath": "deserunt", "message": "magna" }, { "keyword": "nostrud quis irure", "dataPath": "esse", "schemaPath": "enim", "message": "pariatur non laborum" }, { "keyword": "exercitation id", "dataPath": "mollit", "schemaPath": "fugiat Excepteur", "message": "eiusmod" } ], "created_by": { "_id": "ddd8374d3bc7eef17ce3e7fb", "provenance": "Excepteur esse", "username": "cillum minim et dolor", "firstname": "sunt consequat", "memberOf": [ { "groupId": "ffbb0158c77a0e5f570ec096", "aaaManaged": true }, { "groupId": "f57397f3a264f89175292b1e", "aaaManaged": false }, { "groupId": "0234e2976a1fd67b42c13ad0", "aaaManaged": false }, { "groupId": "3c5d5494c65857a6d4dbc5d1", "aaaManaged": true }, { "groupId": "9e038c9e08a3f683d1436712", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident aute dolor" }, { "roleId": "in ipsum proident" }, { "roleId": "veniam" }, { "roleId": "est in ut sint" } ], "inactive": true, "lastLogin": "1993-01-08T03:19:14.539Z", "_meta": { "created": "1976-08-17T21:47:41.121Z", "updated": "1969-01-23T08:30:05.06Z", "migrationVersion": -20758932 }, "email": "Excepteur anim commodo ipsum" }, "last_updated_by": "871e22d77cf49172229640aa", "tasks": { "51": { "actor": "$var.87.Woj", "groups": [ "default", "3ac46d7f8171d33609aafc7e" ], "iterations": [ "3B227724-eb2C-14C1-5561-73DEe421fF16", "0bf1eF95-fdfF-AEb6-d5db-ac5fBFfD332F" ], "x": 87699512.56959558, "y": -44540159.54834283, "gridCoordinate": { "x": -57579416.30816181, "y": 30818617.580538183 }, "name": "fugiat", "location": "Adapter", "locationType": null, "app": "sed fugiat voluptate pariatur officia", "canvasName": "irure", "displayName": "incididunt", "summary": "eiusmod aute", "description": "id", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/V-kDJJ1/eb" }, { "type": "encryption", "pointer": "/xu5/QAGU5X/FEo/UcdMuY0c/~0/N//RMGGe5/~0/~0/p1LM7SOuGeN/gmWfpm2I/GLz" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "amet anim eu", "highlightString": "in" }, { "key": "consequat adipisicing", "highlightString": "occaecat cillum ipsum magna ut" }, { "key": "laboris in veniam ex do", "highlightString": "nulla" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "workflow_start", "3a1f" ], "complete": [ "workflow_end", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "error_handler", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "do mollit", "start_time": "2004-08-11T23:32:32.327Z", "end_time": 50164455.48403987, "finish_state": "error", "retrySettings": { "state": [ "failure", "error" ], "autoRetry": false, "limit": 16192038, "delay": 1204789, "count": 97501872, "finishedRetrying": true }, "type": "automatic" }, "workflow_start": { "x": -78689960.8302432, "y": -84259823.69011766, "gridCoordinate": { "x": -68353591.2300695, "y": -20188087.15376599 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 78370411.20820102, "finish_state": "error", "user": null }, "groups": [ { "_id": "5d1894b6eae74a2fb366841c", "provenance": "laborum irure fugiat dolor aute", "name": "id aute mollit culpa", "description": "sunt", "memberOf": [ { "groupId": "fc247f9f69ccc2f24cd503e3", "aaaManaged": false }, { "groupId": "f4aff08a25a470002d8a6bb6", "aaaManaged": false }, { "groupId": "fd61045bdbadcb9d33c33017", "aaaManaged": true }, { "groupId": "c69b33984df3a8d6f14cb514", "aaaManaged": false }, { "groupId": "47fcd7582037404218a90af3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut cupidatat" }, { "roleId": "sunt ut" } ], "inactive": true, "_meta": { "created": "1955-08-02T15:43:22.843Z", "updated": "1984-08-06T16:19:35.057Z", "migrationVersion": -71325081 } }, { "_id": "0df3779d18cde05576f1ef29", "provenance": "incididunt elit", "name": "deserunt", "description": "voluptate", "memberOf": [ { "groupId": "7a0eb0aff33fbd140441ece2", "aaaManaged": true }, { "groupId": "8200cb4895f065023401d674", "aaaManaged": true }, { "groupId": "e01a8dcef12fab73a53806cb", "aaaManaged": false }, { "groupId": "b62feef2ebcdadc59743fc81", "aaaManaged": false }, { "groupId": "ae9d85d8d85ed6d8918e7c62", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco ex sunt quis" }, { "roleId": "non tempor ut ex sunt" }, { "roleId": "voluptate reprehenderit" } ], "inactive": true, "_meta": { "created": "2017-06-12T14:34:47.524Z", "updated": "2005-05-18T22:46:58.778Z", "migrationVersion": -31916951 } }, "default" ], "iterations": [ "BCAEaAf7-Abc3-c4ba-B5De-64039023C62A", "Fc88E4cB-4EfF-01Dc-Cc15-C49DaF12BB78", "2Bc6DABf-D1Af-C761-7caC-EA02e0eDDbD1", "e9CA16b3-42a2-96E0-95DF-db993fBF7eEb" ] }, "workflow_end": { "x": 60866336.16710508, "y": -11790875.437784493, "gridCoordinate": { "x": -14043419.33296305, "y": -43514714.13016435 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "3a1f", "workflow_end", "workflow_end" ], "complete": [ "workflow_start", "e28f", "workflow_start", "workflow_start" ], "error": [ "workflow_start", "e28f", "e28f", "e28f", "workflow_start" ] }, "metrics": { "end_time": -89032081.00637196, "run_time": -11869225.618721217 }, "groups": [ "default", { "_id": "ba3e67df62244894c1d75b8b", "provenance": "in adipisicing", "name": "consequat laboris consectetur", "description": "dolore Ut quis", "memberOf": [ { "groupId": "69c574b5e18da66769d36fcd", "aaaManaged": false }, { "groupId": "a3ae010c1a8c413d91609e9c", "aaaManaged": true }, { "groupId": "eef718460276f8175d4af3f1", "aaaManaged": false }, { "groupId": "ee54f8c3d88b92e98fbe2fac", "aaaManaged": true }, { "groupId": "52abc0e1bea38ebe9bf10df6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet commodo nulla dolor labore" }, { "roleId": "Lorem" } ], "inactive": true, "_meta": { "created": "2018-07-13T22:29:59.841Z", "updated": "2024-01-09T22:42:52.917Z", "migrationVersion": -95030497 } }, "default", { "_id": "1de91b9d95fb43f3c3560682", "provenance": "eiusmod eu", "name": "Ut minim dolore", "description": "deserunt mollit tempor do cillum", "memberOf": [ { "groupId": "9bf1d20cb9da8bf27e3f7b52", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt culpa ipsum elit pariatur" } ], "inactive": false, "_meta": { "created": "1953-03-26T07:06:17.023Z", "updated": "1960-04-26T21:06:39.352Z", "migrationVersion": -4476540 } } ], "iterations": [ "Dc59d1b1-e4B4-cFFc-ee0e-E1cdFf8763De" ] }, "error_handler": { "x": -5919253.982150301, "y": -61823775.023445606, "gridCoordinate": { "x": 92577583.70625141, "y": -12017202.65396507 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "pariatur aliqua", "canvasName": "quis qui veniam sed", "displayName": "ad", "summary": "sint adipisicing sunt officia", "description": "nisi irure quis mollit aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/CnU/~1/~1/~1/PM1d/~0" }, { "type": "encryption", "pointer": "/d1Au/~0" }, { "type": "encryption", "pointer": "/~0/~1/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "voluptate", "highlightString": "nostrud sint Ut anim" }, { "key": "ea", "highlightString": "reprehenderit minim mollit" }, { "key": "ipsum do dolore", "highlightString": "laborum velit in exercitation" }, { "key": "eiusmod", "highlightString": "incididunt mollit eu sunt" }, { "key": "consectetur Lorem esse voluptate", "highlightString": "irure in sit" } ], "status": "paused", "previous": { "incomplete": [ "3a1f", "3a1f" ], "complete": [ "error_handler", "workflow_start", "e28f", "workflow_end", "e28f" ], "error": [ "3a1f", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "ea minim consectetur", "start_time": "1969-04-07T22:43:38.109Z", "end_time": 20971592.838822067, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "default", { "_id": "3b50b72cfeb053be27b10d54", "provenance": "qui laborum nulla", "name": "consectetur tempor qui nostrud", "description": "cupidatat veniam culpa Ut ad", "memberOf": [ { "groupId": "f421dd93552c9e0b6d5fac8f", "aaaManaged": true }, { "groupId": "be7373fa45dcbd05e416db58", "aaaManaged": true }, { "groupId": "fff0ec6b0d73e7122bdf91c6", "aaaManaged": true }, { "groupId": "1cb975789fe3da266c01fa26", "aaaManaged": true }, { "groupId": "33b2c4f1acf1d9d0aa18fe0d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore eu eiusmod" }, { "roleId": "irure ullamco" }, { "roleId": "in officia dolore Duis ea" }, { "roleId": "eu" } ], "inactive": true, "_meta": { "created": "1960-03-20T08:28:05.864Z", "updated": "1976-09-24T03:49:44.704Z", "migrationVersion": 58839215 } } ], "iterations": [ "7FcFA6f6-eF65-5375-A2f0-DCCE73eaDCB6" ] } }, "parent": { "job": "voluptate", "task": "sunt", "iteration": 69429633.28257084, "element": 96385607.20477027 }, "errorHandler": null, "groups": [ { "_id": "5f9f4f7c126e308dbc5fc240", "provenance": "Duis labore dolor", "name": "sit pariatur culpa proident tempor", "description": "ea sed et consectetur", "memberOf": [ { "groupId": "16842e96c6d69b0caef928ca", "aaaManaged": true }, { "groupId": "30630a4dac8b00b47eb66bd2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur sunt dolore veniam consequat" }, { "roleId": "ullamco amet est elit" } ], "inactive": true, "_meta": { "created": "1971-12-01T12:10:17.4Z", "updated": "1980-01-09T19:32:05.776Z", "migrationVersion": 38734378 } }, { "_id": "ec583e665480f1530e5e0d5c", "provenance": "Excepteur minim id consectetur", "name": "amet id fugiat", "description": "laborum minim eu reprehenderit", "memberOf": [ { "groupId": "3df882870994a411b8bce9c0", "aaaManaged": true }, { "groupId": "b58b048a51969049bffae215", "aaaManaged": true }, { "groupId": "2c846cfb5fd7fe8ee9f64cc1", "aaaManaged": false }, { "groupId": "34d58cae776f55c0f0bd5ee0", "aaaManaged": true }, { "groupId": "6b8a74b092e20c4f2aa8879a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam dolore" }, { "roleId": "eu anim" }, { "roleId": "nostrud dolore non incididunt" } ], "inactive": true, "_meta": { "created": "1973-10-19T09:25:34.804Z", "updated": "2007-09-10T09:40:20.39Z", "migrationVersion": 12944771 } }, "default", { "_id": "e3fb4adb90b4e2a39dc12c56", "provenance": "adipisicing commodo reprehenderit", "name": "consectetur cupidatat deserunt aliqua in", "description": "minim", "memberOf": [ { "groupId": "5ee026ab24b0cc7c456fd302", "aaaManaged": false }, { "groupId": "63a9229de52165baaebf0336", "aaaManaged": false }, { "groupId": "9b047b9d72b0dd8d4d727820", "aaaManaged": true }, { "groupId": "6eb62539abb422fd43a5744e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur dolor aliqua consectetur est" } ], "inactive": true, "_meta": { "created": "1976-04-05T05:50:25.097Z", "updated": "2007-04-01T11:59:17.467Z", "migrationVersion": -21163732 } } ], "watchers": [ "Pronghorn", { "_id": "524d0f1b95d506ef6e7b864b", "provenance": "quis commodo in deserunt nulla", "username": "nostrud nulla sunt esse", "firstname": "reprehenderit elit dolore occaecat", "memberOf": [ { "groupId": "8767718cbe8303e390af8f3d", "aaaManaged": false }, { "groupId": "6491ea71cc3c28f1413bfed8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor nostrud mollit" }, { "roleId": "proident ut dolore aliqua" }, { "roleId": "enim irure nostrud id" } ], "inactive": true, "lastLogin": "1967-12-05T20:41:18.263Z", "_meta": { "created": "2021-12-21T02:32:03.459Z", "updated": "1970-09-04T02:16:09.127Z", "migrationVersion": 38428213 }, "email": "dolor ut" } ], "metrics": { "start_time": 76407487.66146007, "progress": 0.6414326081263373, "end_time": 13732000.106495738, "user": null, "owner": "b56d0f06135b37fcbdd1516d" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }