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": "b533713f31a7cb957845c0a7", "font_size": -92734245, "type": "resource:action", "created": "1961-07-10T16:43:06.093Z", "last_updated": "2019-05-16T14:14:59.892Z", "createdVersion": "8214233404.02.49501284216-3036.8265723190.8213824841.52985946", "lastUpdatedVersion": "2931337216.7302069044.749-2209.259.90941958", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -55667120, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -62438836.460774064, "sla": -51932106.46701294, "decorators": [ { "type": "encryption", "pointer": "/~1/UowzNV78" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/DK5otI35tM/d8fl0zvI/h/~0/~0/DPal1Zv/4q/wv45V-ykemY/~1/HeDzUE7ptpz/QdBK1BAW" }, { "type": "encryption", "pointer": "/~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 }, { "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": "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": "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_start", "name": "myCoolDocumentName" } ], "ancestors": [ "75d7ca075b4ef230b91aaf80" ], "validationErrors": [ { "keyword": "eu", "dataPath": "ea labore do ullamco", "schemaPath": "Duis tempor labore qui", "message": "est enim ea aute" }, { "keyword": "et ut anim velit sint", "dataPath": "anim ea ex Duis sint", "schemaPath": "ea eiusmod sunt quis ut", "message": "Duis cupidatat" }, { "keyword": "magna dolore", "dataPath": "aliqua fugiat aliquip nulla", "schemaPath": "ex exercitation velit cillum Lorem", "message": "nisi" }, { "keyword": "aute ad dolor", "dataPath": "pariatur eu laborum non", "schemaPath": "Lorem consequat aliqua", "message": "adipisicing consectetur non nostrud nisi" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "4": { "x": -64666646.55966592, "y": 3557929.321037039, "gridCoordinate": { "x": 54332115.213540256, "y": -42173679.86883795 }, "name": "ipsum", "location": "Broker", "locationType": "veniam", "app": "in deserunt irure dolore", "canvasName": "exercitation", "displayName": "pariatur in tempor reprehenderit est", "summary": "ea sint", "description": "elit consectetur aliqua", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/N/gkEe+Ox/~0/~1/~0/~1" }, { "type": "encryption", "pointer": "/f2d25A/vy/~0/JGKaFBoDpO/~0/ANKkm3,hz" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "Ut qui in Lorem", "highlightString": "proident eu tempor velit nostrud" }, { "key": "nulla eu quis ut", "highlightString": "sed ea dolor" }, { "key": "cupidatat", "highlightString": "amet voluptate" }, { "key": "do magna nostrud non", "highlightString": "anim nisi occaecat" } ], "status": "failure", "previous": { "incomplete": [ "e28f", "workflow_start", "workflow_end" ], "complete": [ "workflow_start" ], "error": [ "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ] }, "serverId": "pariatur est", "start_time": "1993-05-11T23:15:00.423Z", "end_time": -37721781.591865696, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "ad2e20886cc1d31f2ccaf807", { "_id": "c7ff7edcf929f9ebd81a310b", "provenance": "sunt", "name": "est Duis occaecat labore", "description": "irure consectetur", "memberOf": [ { "groupId": "45777b98ef75dc4732878c1e", "aaaManaged": false }, { "groupId": "fef1c05e6ffd0c3f44d27590", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est" }, { "roleId": "fugiat adipisicing laborum velit Duis" } ], "inactive": false, "_meta": { "created": "1992-09-04T16:39:51.949Z", "updated": "1962-08-14T04:21:03.203Z", "migrationVersion": -35313059 } }, "default", "fdfc1ef1f527f0ea510fd351", { "_id": "b3e56b6e716f27441bda2473", "provenance": "proident ipsum ea", "name": "qui Ut", "description": "esse incididunt magna culpa labore", "memberOf": [ { "groupId": "79ce66a396c77c7e162d411c", "aaaManaged": false }, { "groupId": "0488b1cad5b7331cd7a1ed9d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing Ut nostrud officia dolor" }, { "roleId": "esse commodo est" }, { "roleId": "laboris pariatur sint ex mollit" } ], "inactive": false, "_meta": { "created": "1975-04-20T22:34:45.624Z", "updated": "2023-09-30T14:03:09.835Z", "migrationVersion": -16716366 } } ], "iterations": [] }, "workflow_start": { "x": -12372231.35039249, "y": 90060939.54029742, "gridCoordinate": { "x": -93178709.96403168, "y": 39934953.58460379 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -15513133.274876177, "finish_state": "success", "user": { "_id": "c1e7d2e5a204b60dbba15eb2", "provenance": "non", "username": "velit ad mollit consectetur", "firstname": "minim qui", "memberOf": [ { "groupId": "2536012c4f620d7178d33fea", "aaaManaged": false }, { "groupId": "8a8cafcaaeaa3475196dcf11", "aaaManaged": false }, { "groupId": "e4deb119c83dc23968c96b15", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat consectetur" } ], "inactive": false, "lastLogin": "1993-03-04T06:47:10.805Z", "_meta": { "created": "1968-04-21T10:44:25.236Z", "updated": "1999-09-30T02:51:12.5Z", "migrationVersion": -10919676 }, "email": "do dolore" } }, "groups": [ "605c5b89189f63c5ee001a74" ], "iterations": [ "bBCb7e08-3cc5-47F8-cFFb-A39A8E4De8c7", "BB13A46D-34bf-eC7e-d6Ed-30b6CCA0869f" ] }, "workflow_end": { "x": 42917402.376369745, "y": -1955078.1531713307, "gridCoordinate": { "x": -1133501.9418969005, "y": 91821122.7538352 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "3a1f", "workflow_end", "error_handler", "workflow_start" ], "complete": [ "error_handler" ], "error": [ "3a1f" ] }, "metrics": { "end_time": 63200946.54764685, "run_time": -86334034.63355154 }, "groups": [ "default", { "_id": "d14b7a9412e6a1e4a5f88545", "provenance": "sed", "name": "aliquip labore elit eiusmod", "description": "Duis ut Ut aliquip", "memberOf": [ { "groupId": "c5be20a9fe7d9de2e90e7c7d", "aaaManaged": true }, { "groupId": "ac3f373de9615cde3bac8ab4", "aaaManaged": false }, { "groupId": "801b1eab1ea76624e54041b1", "aaaManaged": false }, { "groupId": "689bb6ef15e03386971edd7a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet eu laborum nulla" }, { "roleId": "ex aute in quis" } ], "inactive": true, "_meta": { "created": "1954-04-14T03:25:05.896Z", "updated": "1984-06-02T22:02:02.938Z", "migrationVersion": 30816979 } }, "default", { "_id": "6f29674d3ddd6a5ca2bee0ec", "provenance": "aliquip ut", "name": "occaecat Ut non sint", "description": "dolor", "memberOf": [ { "groupId": "847ecea73e22228237cd2541", "aaaManaged": true }, { "groupId": "424974a88c035c833c33deb8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident esse Excepteur" }, { "roleId": "fugiat dolor" } ], "inactive": true, "_meta": { "created": "1977-12-14T03:09:58.823Z", "updated": "2013-11-25T00:19:56.301Z", "migrationVersion": 45618797 } }, "5dbf6eb7e9893fd712386564" ], "iterations": [ "C32A2d23-0Bbb-7aDc-3D22-A6aC023B2762" ] }, "error_handler": { "x": 15167041.810907066, "y": -50658927.97659148, "gridCoordinate": { "x": -69118894.86705709, "y": 98923470.84136564 }, "name": "childJob", "location": "Application", "locationType": "pariatur sed velit", "app": "dolore dolor minim labore enim", "canvasName": "do cupidatat consectetur id mollit", "displayName": "enim consequat anim", "summary": "exercitation", "description": "amet officia quis minim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/Aci/~1/alV/~1/lR2jP/~1/b0Ws/+z8Je" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/u9/Ua/G6JDQo/iEuRI/jFQ/~1/~1/asw3/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "Excepteur cillum Lorem proident aute", "highlightString": "enim ut laborum" }, { "key": "et sunt", "highlightString": "dolore" } ], "status": "running", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_end", "e28f" ], "error": [ "workflow_start", "workflow_start", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "deserunt laborum laboris ad", "start_time": "2020-03-29T19:54:38.205Z", "end_time": 68540.87765839696, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "b2673d0399c78fc8c9b07991", "default" ], "iterations": [ "0545fab5-FfDE-4d89-B00E-B1Bd26fE662d" ] } }, "parent": { "job": "laborum nisi dolore culpa pariatur", "task": "aliqua", "iteration": 49919995.619146734, "element": 2886775.158281058 }, "errorHandler": { "x": -17455168.17501524, "y": 39007062.65032676, "gridCoordinate": { "x": 9295422.812639892, "y": 88868346.49084571 }, "name": "sed adipisicing deserunt minim sint", "location": "Broker", "locationType": null, "app": "velit", "canvasName": "minim", "displayName": "aliquip dolore aute voluptate sint", "summary": "adipisicing est", "description": "culpa est non", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/b9/MHcrgi/imo3chC3Y/e9x/ZA7U" }, { "type": "encryption", "pointer": "/bvy/jRpD2" }, { "type": "encryption", "pointer": "/~0/U/yK.U3LADEyP" }, { "type": "encryption", "pointer": "/OD/s/~0/HSy8ZpfW/~0/~0/~1/Z3Dk1L64HY" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "voluptate consectetur aliquip ad id", "highlightString": "reprehenderit" }, { "key": "Excepteur", "highlightString": "cillum proident" }, { "key": "sint exercitation", "highlightString": "officia commodo anim in reprehenderit" } ], "status": "error", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_start", "e28f" ], "error": [ "error_handler", "e28f", "3a1f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "commodo sed veniam", "start_time": "1980-07-31T16:36:10.605Z", "end_time": 76702892.04831895, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "4aa9562aad479d9c7e393714", "groups": [ { "_id": "d1a0a66284731cf8a55df569", "provenance": "labore cillum", "name": "incididunt ut do ut in", "description": "dolor", "memberOf": [ { "groupId": "1246513f4eaebeb3e9c0d4b7", "aaaManaged": false }, { "groupId": "20ca8841196c2bf73e479449", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad deserunt" }, { "roleId": "laboris et exercitation ipsum Excepteur" }, { "roleId": "ullamco" }, { "roleId": "Ut ipsum" }, { "roleId": "aliqua fugiat Excepteur" } ], "inactive": true, "_meta": { "created": "1994-02-13T01:33:34.215Z", "updated": "2019-10-12T04:23:02.159Z", "migrationVersion": 39583845 } }, "e5016418b0c38e35a5eb7371", "793bfaf83c951e601feb3ffc" ], "iterations": [ "0EAbc39e-83e5-6D70-fe3A-4e05AeF9ee3e", "1CA8f896-EA5d-5784-D2ae-29bae955FB56", "58cB3f64-b7b7-aB23-CF8A-FAF35581Ff2b" ] }, "groups": [ "default", "default", "default", "default" ], "watchers": [ "Pronghorn", { "_id": "b2d060168222622f3ee7ce4e", "provenance": "esse et dolore anim ea", "username": "minim nisi do", "firstname": "aute", "memberOf": [ { "groupId": "83f4fa3270afa82c06245b19", "aaaManaged": true }, { "groupId": "2748e78cf49aadac987b18b7", "aaaManaged": false }, { "groupId": "8400f68743c12a94a2aec6d1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "anim reprehenderit mollit ullamco" }, { "roleId": "est veniam id" }, { "roleId": "mollit eiusmod Ut sit" }, { "roleId": "deserunt enim aliqua" } ], "inactive": true, "lastLogin": "2012-02-13T14:53:54.672Z", "_meta": { "created": "1990-02-10T23:10:52.872Z", "updated": "1964-08-28T18:02:01.118Z", "migrationVersion": 50278317 }, "email": "minim mollit qui" }, { "_id": "aca686729490fb5d9d5a34d7", "provenance": "in magna cupidatat", "username": "dolor dolor aliqua", "firstname": "pariatur elit voluptate dolore", "memberOf": [ { "groupId": "35172001a4dc83866b050cb0", "aaaManaged": true }, { "groupId": "a2dcf29d7772a169436217af", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi" }, { "roleId": "sunt cupidatat" }, { "roleId": "ad aute velit dolor" }, { "roleId": "occaecat eiusmod" }, { "roleId": "sunt cillum occaecat elit" } ], "inactive": true, "lastLogin": "1978-10-14T18:04:29.918Z", "_meta": { "created": "1977-08-18T20:49:25.287Z", "updated": "1978-06-13T15:01:28.52Z", "migrationVersion": -14825430 }, "email": "Duis nostrud velit sint non" } ], "metrics": { "start_time": 91034017.16759527, "progress": 0.04444586277472751, "end_time": -70614079.15476638, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }