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": "70559d2e2ae543e348c34073", "font_size": -6859953, "type": "resource:action", "created": "1958-10-04T10:30:06.812Z", "last_updated": "1948-12-10T13:17:16.777Z", "createdVersion": "325.68073.2026-4871.52361834741.329772.60", "lastUpdatedVersion": "34802169983.4984.1861", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -73848333, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -41388609.48909015, "sla": -29227665.169314682, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/~1/o0N/~1/~1/rOp" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/~1/tilX" } ], "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": "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "elit aute tempor dolore" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "in in" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "sint deserunt quis fugiat" } ], "ancestors": [ "3284bdc35c9a1bd7b830ffbc", "6269d228ee921c61590bbc10", "0244ec2e9ad8d11db7b100fc", "3eec184a78212fd7400afc3e", "b7f613b92a36d3e3005457a5" ], "validationErrors": [ { "keyword": "ipsum dolore culpa irure ullamco", "dataPath": "Duis", "schemaPath": "velit sit ex", "message": "velit Ut" }, { "keyword": "commodo dolore ullamco", "dataPath": "aliquip laboris velit Lorem in", "schemaPath": "proident velit", "message": "sunt" }, { "keyword": "laboris velit", "dataPath": "exercitation occaecat dolor adipisicing proident", "schemaPath": "pariatur Excepteur et", "message": "elit ad tempor nostrud" } ], "created_by": { "_id": "74787837d2673cfad8b93228", "provenance": "ullamco", "username": "adipisicing sed esse amet Excepteur", "firstname": "laborum aliquip elit consequat", "memberOf": [ { "groupId": "3d27509a7eb680d77a9f2163", "aaaManaged": false }, { "groupId": "4a2e0fc54ee0c6f21bbbc51c", "aaaManaged": true }, { "groupId": "252ce1cd8a546bbf023077d0", "aaaManaged": true }, { "groupId": "e1048357b200ed160b6b65ac", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem ad Excepteur pariatur reprehenderit" }, { "roleId": "consequat in occaecat dolore dolor" }, { "roleId": "in sunt" }, { "roleId": "dolore" }, { "roleId": "ipsum labore ex velit ut" } ], "inactive": true, "lastLogin": "2005-12-11T20:00:24.847Z", "_meta": { "created": "1967-05-14T06:21:03.538Z", "updated": "1992-05-24T21:34:47.823Z", "migrationVersion": -84226063 }, "email": "reprehenderit enim" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 81784467.37928909, "y": 17056866.912265316, "gridCoordinate": { "x": -33499193.921457194, "y": 14609423.758995324 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 73647790.06207427, "finish_state": "success", "user": null }, "groups": [ "140bbc2a5337dcff6cd9f4cf", { "_id": "387f16136028df4f8a8c17f7", "provenance": "nulla quis ea", "name": "fugiat Lorem proident", "description": "ut sint quis minim", "memberOf": [ { "groupId": "94fc69de09e9f4f33752b720", "aaaManaged": false }, { "groupId": "cdfdc1dfff40e2f560e501fe", "aaaManaged": false }, { "groupId": "eded4711ae068b9470e0bfb5", "aaaManaged": false }, { "groupId": "3e22c102ac4fa0f27e9b3df3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation dolore" }, { "roleId": "officia enim ut non ipsum" } ], "inactive": true, "_meta": { "created": "1962-01-04T01:09:24.945Z", "updated": "1987-04-28T17:40:48.905Z", "migrationVersion": 89184899 } }, "c0789013262b69e5191c7f47", "79cb9a6f27837eb65bdd00d5" ], "iterations": [ "D3C089a9-48bC-1d82-2d8b-cec3EE86Dc5b" ] }, "workflow_end": { "x": 98525776.67322195, "y": -94799172.43477592, "gridCoordinate": { "x": 80321698.53366908, "y": 89842059.67371362 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_start", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "error_handler", "e28f", "workflow_end" ] }, "metrics": { "end_time": 50515232.54059225, "run_time": 83384178.75491041 }, "groups": [ "default" ], "iterations": [] }, "error_handler": { "x": -2273538.2702810764, "y": 37520291.773195386, "gridCoordinate": { "x": -93893239.58710355, "y": -62693414.56930873 }, "name": "childJob", "location": "Application", "locationType": null, "app": "dolore Excepteur aliquip", "canvasName": "ut", "displayName": "elit", "summary": "et magna in adipisicing fugiat", "description": "fugiat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/QXTo/bOeB/~0/~1" }, { "type": "encryption", "pointer": "/~1/G8z0/~1/KTGg-gve2j/PPdF//Hn/fZOi5rYG/R8Z6S/x/wskSzb3r6-" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ex dolore dolor", "highlightString": "dolor cillum aliqua officia proident" }, { "key": "id deserunt dolor", "highlightString": "et dolor deserunt" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "workflow_start", "e28f", "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "3a1f", "e28f", "error_handler" ], "error": [ "workflow_end", "workflow_end", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "minim quis", "start_time": "1963-12-30T12:53:32.056Z", "end_time": 85176988.96467885, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "5b7cd5228b7b860006ccea3c", "provenance": "nisi adipisicing laboris Ut", "name": "esse sed cupidatat", "description": "irure Duis magna", "memberOf": [ { "groupId": "a3d83f9bafaf2958250cec9f", "aaaManaged": true }, { "groupId": "2636890020d50c818e66f6ed", "aaaManaged": true }, { "groupId": "b5b800c7702a312c1ae42122", "aaaManaged": true }, { "groupId": "4902cb2ad2bdd62b94eba85e", "aaaManaged": false }, { "groupId": "64b3c226724f10843b740d2a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia pariatur proident ut in" }, { "roleId": "eu deserunt" } ], "inactive": false, "_meta": { "created": "1983-12-08T10:29:29.016Z", "updated": "2006-09-13T00:42:43.285Z", "migrationVersion": -83454094 } }, "default" ], "iterations": [ "e398ECCe-De5a-7D08-9c7A-7b3eacaB60C6", "c4A4Ef06-BB1c-e6d5-5Ac3-21aF4af49aD3", "65A400Ab-d79A-0Cb7-D85d-0dC2bd8EBaCC" ] }, "33ea": { "actor": "Pronghorn", "groups": [ { "_id": "cb0b7d393adb4291aad575f7", "provenance": "ex aute aliqua dolore ipsum", "name": "eu in Excepteur sit", "description": "culpa", "memberOf": [ { "groupId": "5b15441e71c1fd70461ab22f", "aaaManaged": false }, { "groupId": "361d19817030a238edcfcd5c", "aaaManaged": false }, { "groupId": "f98a0284ac4c39e70cac30fd", "aaaManaged": false }, { "groupId": "a0bab466c97a63024b374554", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat ad qui reprehenderit" }, { "roleId": "nulla" }, { "roleId": "ad" } ], "inactive": true, "_meta": { "created": "1969-11-30T12:11:47.99Z", "updated": "1968-05-18T20:51:37.318Z", "migrationVersion": 63524740 } } ], "iterations": [ "eacfa184-AdA3-eF7c-3E9e-791BAf30aC0C" ], "x": -31407345.83052604, "y": -24655389.34921874, "gridCoordinate": { "x": 9940646.130953118, "y": -68043467.13517435 }, "name": "tempor aute et in dolor", "location": "Adapter", "locationType": null, "app": "elit reprehenderit", "canvasName": "ex ipsum", "displayName": "sit consequat pariatur", "summary": "ipsum", "description": "Lorem est nisi exercitation dolore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/noY/~0/RyLyn/~0/~0/~0/~0/~1/zi7NP/~0" }, { "type": "encryption", "pointer": "/~0/~0/GjQ1rOak/qc./ivd1/~0/~1/~1/HRJI,E" }, { "type": "encryption", "pointer": "/RMCcEt0yZM-/LX/~0/DPHHgMpqItf/YUu4bDfJnr7/QyDx/~1/~0" }, { "type": "encryption", "pointer": "/~0/Vr/~0/qBEsAP/~0/h/m6iq/~0/~0/cr./6u/~1/mYUK" }, { "type": "encryption", "pointer": "/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "fugiat elit ipsum consectetur", "highlightString": "eu ea cupidatat ipsum" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "workflow_start", "workflow_start", "workflow_start", "e28f" ], "complete": [ "workflow_end", "workflow_end", "workflow_start", "workflow_start", "error_handler" ], "error": [ "error_handler", "e28f", "e28f", "workflow_end", "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "sed dolore", "start_time": "2001-09-23T06:45:00.669Z", "end_time": -87025414.31629509, "finish_state": "failure", "retrySettings": null, "type": "manual", "view": "magna fugiat laboris aliquip laborum" } }, "parent": { "job": "qui veniam est", "task": "sint qui", "iteration": 31240640.08074723, "element": 23079981.86917253 }, "errorHandler": null, "groups": [ { "_id": "aeabe4cc587a3d644489b2b9", "provenance": "mollit anim ad", "name": "nulla culpa", "description": "sit dolor laboris eu", "memberOf": [ { "groupId": "15e0e45ec54da5e51dc4ceb0", "aaaManaged": false }, { "groupId": "60245c6b92849592c5fffd75", "aaaManaged": false }, { "groupId": "a4063bf37dbb0b7e7855175c", "aaaManaged": true }, { "groupId": "79589e79fabf01bfbc0ccdea", "aaaManaged": true }, { "groupId": "507d6bd96378cf12ae2fe9eb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sed in exercitation voluptate tempor" }, { "roleId": "tempor" }, { "roleId": "consequat" }, { "roleId": "officia aliquip esse consectetur Excepteur" }, { "roleId": "irure" } ], "inactive": true, "_meta": { "created": "1987-02-26T01:17:24.795Z", "updated": "1983-05-06T05:57:58.438Z", "migrationVersion": 15920722 } }, "default", { "_id": "0835e763549a19230e3b0b17", "provenance": "esse sint aliquip cupidatat laborum", "name": "exercitation aute aliquip enim", "description": "Excepteur laboris eiusmod", "memberOf": [ { "groupId": "9325442676cb56ad4b52f23d", "aaaManaged": false }, { "groupId": "76470336a43bacd44b001b88", "aaaManaged": false }, { "groupId": "d465acf908a8e4fce4121c0e", "aaaManaged": true }, { "groupId": "f8db2b655a4c8fb20dd2c6e5", "aaaManaged": true }, { "groupId": "1f2e19f362a44b0dbe61c7b7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea cupidatat pariatur proident" }, { "roleId": "est reprehenderit nostrud magna laborum" }, { "roleId": "do" }, { "roleId": "dolor sunt eu ut" } ], "inactive": true, "_meta": { "created": "2022-02-14T00:19:39.365Z", "updated": "2000-08-19T22:51:44.667Z", "migrationVersion": -16909806 } } ], "watchers": [ "Pronghorn", "Pronghorn", "53b70b74ffcbe7b129d70a93", { "_id": "9554b9f34ca44cb0ccb8790d", "provenance": "exercitation ea", "username": "ex reprehenderit laboris", "firstname": "est Excepteur amet esse do", "memberOf": [ { "groupId": "d0838d2b52d11ada6a293d31", "aaaManaged": false }, { "groupId": "babc768d846aefc275cf01fa", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat ipsum consequat culpa" }, { "roleId": "minim non enim sit" }, { "roleId": "est" }, { "roleId": "sed eu laborum" }, { "roleId": "dolor deserunt ut" } ], "inactive": true, "lastLogin": "2006-04-15T08:04:25.207Z", "_meta": { "created": "2007-04-25T22:37:54.361Z", "updated": "2018-08-11T13:08:46.357Z", "migrationVersion": 12133331 }, "email": "in mollit ut veniam pariatur" }, "Pronghorn" ], "metrics": { "start_time": -561745.479073301, "progress": 0.9958051496468705, "end_time": -29914662.13745913, "user": "9bd520730f4e784cbae801d2", "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }