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 imported 3 of 4 documents", "data": { "_id": "249071504a43e6b82d09229d", "font_size": -2548059, "type": "resource:action", "created": "1946-10-24T06:27:50.313Z", "last_updated": "2010-10-15T09:48:12.572Z", "createdVersion": "0120.68.675", "lastUpdatedVersion": "8982153009.86528192716.50561486782", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 36051381, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 14402152.758360118, "sla": 41316630.72828996, "decorators": [ { "type": "encryption", "pointer": "/Q1KWK.6XOiD/HiDCO/~1" }, { "type": "encryption", "pointer": "/os1i-/~1/~0/~0/~1/Dkt9.U/~0/~0/~1/Yz" }, { "type": "encryption", "pointer": "/~1/~1/~1" } ], "status": "complete", "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 }, { "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" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "id ea", "dataPath": "quis culpa laborum", "schemaPath": "veniam Excepteur", "message": "consectetur est laborum Duis in" }, { "keyword": "ullamco consequat adipisicing non", "dataPath": "ea Lorem do", "schemaPath": "ea cillum aute ullamco nulla", "message": "sit ad" } ], "created_by": { "_id": "c8dfd9c4e2f84bd8953501ed", "provenance": "consequat Ut irure amet adipisicing", "username": "nisi proident voluptate", "firstname": "reprehenderit", "memberOf": [ { "groupId": "8a7eafe3bac8ee4933dc81b6", "aaaManaged": true }, { "groupId": "4c9f75f8d0871aeb3415d7f0", "aaaManaged": false }, { "groupId": "0ffc3c81bf74f3f9aee0b469", "aaaManaged": false }, { "groupId": "6dbf97bfb5df75144903d096", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis adipisicing id consectetur est" }, { "roleId": "aliquip cillum adipisicing sint" }, { "roleId": "ex id sed nulla" } ], "inactive": true, "lastLogin": "1993-03-22T20:18:37.972Z", "_meta": { "created": "1949-08-21T13:52:11.299Z", "updated": "2000-04-21T09:22:16.286Z", "migrationVersion": -3057405 }, "email": "in aliqua reprehenderit" }, "last_updated_by": null, "tasks": { "workflow_start": { "x": 57950884.99978921, "y": -17210621.0375285, "gridCoordinate": { "x": 12939320.646682218, "y": 52009049.47375813 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -15591341.226386875, "finish_state": "error", "user": "7437e2a4d0d580c5b097cd04" }, "groups": [ { "_id": "4021c246ec08f3ba44e87d4d", "provenance": "consectetur labore enim Lorem", "name": "non sed cillum ullamco", "description": "incididunt consequat in nisi nulla", "memberOf": [ { "groupId": "99fa8ee0b2c021daa38a2e89", "aaaManaged": true }, { "groupId": "12d2a0c24bad5fba0c329a8a", "aaaManaged": true }, { "groupId": "b9d5e98ae4b1aa7e0af32df4", "aaaManaged": true }, { "groupId": "a7ff11d5b3953b578c3c5fb6", "aaaManaged": false }, { "groupId": "dc6a188516fcfc7cdd54b599", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "mollit" }, { "roleId": "est elit aliqua et" }, { "roleId": "non consectetur" }, { "roleId": "sint cupidatat" } ], "inactive": true, "_meta": { "created": "1989-01-22T16:51:21.306Z", "updated": "1975-01-05T19:13:43.323Z", "migrationVersion": -81277250 } }, { "_id": "b7dcdcb0ae56c112e90a1b23", "provenance": "Excepteur ea", "name": "pariatur id cupidatat minim aliquip", "description": "culpa aliqua magna", "memberOf": [ { "groupId": "840cefc5f28190a41d9baee1", "aaaManaged": true }, { "groupId": "93112dda5db4d9ccac9fda27", "aaaManaged": false }, { "groupId": "5aa4b66b1c761e6aa8ab1ebb", "aaaManaged": false }, { "groupId": "e6a9d703b49be04cdff3f629", "aaaManaged": true }, { "groupId": "b8d959934a977d5cb1fba3b7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa in tempor" } ], "inactive": false, "_meta": { "created": "1990-11-11T09:40:38.081Z", "updated": "1990-03-26T10:29:03.489Z", "migrationVersion": -92107111 } } ], "iterations": [] }, "workflow_end": { "x": -44148135.9720119, "y": -11000500.380922511, "gridCoordinate": { "x": -73889991.44541204, "y": 7902557.432067335 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "workflow_start", "e28f", "workflow_start", "workflow_start" ], "complete": [ "workflow_end", "workflow_start", "workflow_start" ], "error": [ "workflow_end", "workflow_end" ] }, "metrics": { "end_time": -26877086.489719287, "run_time": 72300062.725858 }, "groups": [ { "_id": "3664bd3d7fb9253df370dc46", "provenance": "velit eiusmod deserunt", "name": "aliquip Excepteur mollit nisi", "description": "do", "memberOf": [ { "groupId": "3bb13cdb51e4fe12031a526c", "aaaManaged": false }, { "groupId": "badefb139a12c460217fbc96", "aaaManaged": false }, { "groupId": "df051dae6f14d7017d24d740", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit aute" }, { "roleId": "cillum esse id nisi" }, { "roleId": "ad magna non sit" }, { "roleId": "eiusmod" }, { "roleId": "anim Excepteur esse" } ], "inactive": false, "_meta": { "created": "1976-01-10T09:15:41.924Z", "updated": "1970-10-01T18:36:26.784Z", "migrationVersion": -97307207 } }, "default", "1e960fa1ae7984ed867ec42b" ], "iterations": [ "50f8c46B-Ab73-CF4d-02c6-2f2B237eBeac" ] }, "error_handler": { "x": -15461042.568923578, "y": 56156498.635119736, "gridCoordinate": { "x": 72697460.89942494, "y": 51360254.02136138 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "minim nulla do", "canvasName": "ut mollit deserunt do", "displayName": "in", "summary": "veniam", "description": "nostrud consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/cwp6WX" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "qui pariatur in Excepteur ea", "highlightString": "Excepteur mollit nostrud" }, { "key": "sint cillum incididunt", "highlightString": "in Lorem dolore nisi eiusmod" }, { "key": "eu in", "highlightString": "exercitation ea sunt" }, { "key": "proident aute dolor ullamco et", "highlightString": "consequat" }, { "key": "in ullamco tempor dolore", "highlightString": "non" } ], "status": "complete", "previous": { "incomplete": [ "error_handler", "3a1f", "error_handler", "workflow_end", "workflow_end" ], "complete": [ "workflow_start", "e28f" ], "error": [ "e28f", "3a1f", "workflow_start", "workflow_start", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "velit", "start_time": "1949-09-27T21:38:46.05Z", "end_time": -4396431.951301098, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "e0c9b4da15b14962664c1ba6", "groups": [ { "_id": "ff3e55845ddf787780adcd8c", "provenance": "Lorem pariatur", "name": "exercitation", "description": "fugiat ut", "memberOf": [ { "groupId": "e5f68bf18f76a83261d3f248", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea labore" }, { "roleId": "in" }, { "roleId": "ex" }, { "roleId": "aliquip laborum" }, { "roleId": "quis ea reprehenderit" } ], "inactive": true, "_meta": { "created": "1979-01-27T14:52:36.977Z", "updated": "1980-12-29T20:56:42.851Z", "migrationVersion": -23338970 } }, "65f6bda5913672e3a783060d", { "_id": "4a8e9308b9e554a01c6302b0", "provenance": "sint et cillum deserunt aliqua", "name": "Duis nisi", "description": "nostrud mollit consectetur Excepteur", "memberOf": [ { "groupId": "ab2881ab1f2454b604c89e93", "aaaManaged": false }, { "groupId": "fe8be4d641473e63f48975d0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod ullamco incididunt" } ], "inactive": false, "_meta": { "created": "1971-06-28T07:38:05.64Z", "updated": "1974-04-02T21:28:13.086Z", "migrationVersion": -73155020 } } ], "iterations": [] }, "9b": { "actor": "job", "groups": [ "92d17c7f3e8e2264c419377a" ], "iterations": [ "af7C2FAa-d32B-3aFC-9ACa-7F4D876CBc25" ], "x": 31281554.754275247, "y": 36803121.15792787, "gridCoordinate": { "x": -57917876.14845374, "y": 10855621.364037752 }, "name": "pending", "summary": "mollit proident pariatur magna", "description": "incididunt ad anim" } }, "parent": { "task": "ex mollit nulla minim", "iteration": -85595701.27228415, "element": 90006407.61754584 }, "errorHandler": { "actor": { "_id": "28b3c86c2d18a50af8dcb622", "provenance": "et ut", "username": "incididunt cillum ea exercitation", "firstname": "est amet quis voluptate", "memberOf": [ { "groupId": "4be99599433fbbc4d2fe59ec", "aaaManaged": true }, { "groupId": "288a70d016c26fb848d26137", "aaaManaged": false }, { "groupId": "c600a0b9ec1b093406680fe3", "aaaManaged": false }, { "groupId": "30cbe1b6687d4da967a43141", "aaaManaged": true }, { "groupId": "f03a9790ca216d6395a75045", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet eiusmod enim" }, { "roleId": "nostrud aute" } ], "inactive": false, "lastLogin": "2009-09-27T01:43:04.442Z", "_meta": { "created": "2009-02-07T03:16:33.65Z", "updated": "2004-08-14T08:25:15.493Z", "migrationVersion": -76458360 }, "email": "aliqua laborum veniam eu" }, "groups": [ "7e20a851d1a0ca5ccb08a085" ], "iterations": [ "4Db5f6Af-d4c4-B8fF-95d8-fc0a96c4bFa1", "D34eEfF3-C74E-D96C-8796-B906b384889E", "A69ca3B5-6dA2-fdAd-fa63-eFD8Af4dC21B", "601A00e2-401e-Faa6-c18B-a63679bdBDc4" ], "x": -72761381.28761227, "y": 65785142.38826275, "gridCoordinate": { "x": -68496709.22183311, "y": -91987699.12868725 }, "name": "pending", "summary": "adipisicing officia cupidatat culpa", "description": "aliquip consectetur" }, "groups": [ "default", "6747adf5c591c7032566689a", "26fae8e68b473f500965e54a", { "_id": "61eda228386213f6509cadda", "provenance": "ad ea", "name": "aute laboris eiusmod nisi sed", "description": "qui", "memberOf": [ { "groupId": "6a3844370abc9e5889c8c91c", "aaaManaged": true }, { "groupId": "b3ebde8ee0483b556ed0e2cf", "aaaManaged": true }, { "groupId": "fe2c85f9f02932e434680486", "aaaManaged": false }, { "groupId": "398294e2b3f876da1ff39d7d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia culpa ex labore dolore" }, { "roleId": "do fugiat amet" } ], "inactive": true, "_meta": { "created": "1964-09-02T03:37:02.46Z", "updated": "1972-04-02T07:14:10.87Z", "migrationVersion": -57240503 } }, "c29a3def3aa9b72f0f58a780" ], "watchers": [ { "_id": "f4aa1efa2293a794d5fb7598", "provenance": "dolor id officia consequat", "username": "id", "firstname": "elit", "memberOf": [ { "groupId": "1b685273c9eec8f53e1083c4", "aaaManaged": false }, { "groupId": "675e412f32a79df6fa492eff", "aaaManaged": true }, { "groupId": "2f7f752d61bd652e3c7a8b3e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt esse Lorem anim" }, { "roleId": "sunt adipisicing" }, { "roleId": "aute quis" } ], "inactive": false, "lastLogin": "2011-11-23T11:59:40.127Z", "_meta": { "created": "1986-04-10T17:03:19.912Z", "updated": "1955-08-22T08:22:17.989Z", "migrationVersion": -2084682 }, "email": "nostrud veniam" }, "Pronghorn", { "_id": "3aa54409e5db86d0fbe5059f", "provenance": "labore elit in", "username": "sunt irure amet ipsum culpa", "firstname": "eiusmod sit labore in nulla", "memberOf": [ { "groupId": "92792bb8a7177bf3b191fa5e", "aaaManaged": false }, { "groupId": "47f5bfded296e4be3abb761f", "aaaManaged": true }, { "groupId": "5ad4c97b4b87b696e008cb8b", "aaaManaged": false }, { "groupId": "14550e181f2fe83f73bbca8b", "aaaManaged": false }, { "groupId": "2675f694589b46663a8dabf5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia" }, { "roleId": "quis reprehenderit sit" } ], "inactive": true, "lastLogin": "1949-01-08T17:58:18.276Z", "_meta": { "created": "1956-04-19T07:49:19.483Z", "updated": "1964-06-16T06:51:15.892Z", "migrationVersion": -10859264 }, "email": "consequat magna" }, "31e4ae2fe8ba057d1624af43", { "_id": "12338b51d02aff9d4afcdfee", "provenance": "magna", "username": "aliquip", "firstname": "aute mollit commodo", "memberOf": [ { "groupId": "47c5c18fcd0e11d0956d98f6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non aliquip" }, { "roleId": "amet eiusmod quis" }, { "roleId": "sed qui deserunt laborum" }, { "roleId": "dolor Ut Excepteur" }, { "roleId": "sit" } ], "inactive": true, "lastLogin": "1981-11-05T21:46:00.398Z", "_meta": { "created": "2013-04-25T02:53:25.679Z", "updated": "2005-01-31T00:11:13.505Z", "migrationVersion": 20384729 }, "email": "irure ex anim dolor" } ], "metrics": { "start_time": -39421393.764983125, "progress": 0.8733629697339296, "end_time": 36949733.328816116, "user": { "_id": "6a775f001163c19f45e6c85f", "provenance": "laboris dolor ut", "username": "et", "firstname": "elit laborum", "memberOf": [ { "groupId": "df15973b62435763f0a48aed", "aaaManaged": false }, { "groupId": "dd91d78208a03503a99505a2", "aaaManaged": false }, { "groupId": "6325ccfdbdc775b30714a1c5", "aaaManaged": false }, { "groupId": "0808f9ff0d83c84e5ac9d9d4", "aaaManaged": true }, { "groupId": "e3ab5032f1bc6671cedd578f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum labore Duis in dolor" }, { "roleId": "anim" } ], "inactive": false, "lastLogin": "1948-09-05T03:58:38.306Z", "_meta": { "created": "1961-08-30T18:22:20.397Z", "updated": "1996-01-19T19:36:30.239Z", "migrationVersion": 26336043 }, "email": "qui non veniam id dolore" }, "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }