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": "f1fd93323ae26c2970397d31", "uuid": "a135dfd1-aa48-5aa1-4b73-423d722c5b91", "font_size": 72835549, "type": "automation", "created": "2016-03-13T15:18:15.197Z", "last_updated": "1975-02-24T13:05:31.417Z", "createdVersion": "55504.43248.582247633-6593.700274354.50058.6", "lastUpdatedVersion": "37496860.71.7", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -48317688, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 94195559.47133031, "sla": 29711363.40457599, "decorators": [ { "type": "encryption", "pointer": "/~1/UGz/rcY86HeVs/tP73jReioAd/~0/h8mDY9vO/~1/ZRmy2i/lP/QX/V/~1" }, { "type": "encryption", "pointer": "/shk-wD/~0/~0/~1" }, { "type": "encryption", "pointer": "/~0/o7H/Aum8/~0/ozJsQZ2vC7/dOAx9lW/HAoh/nZ7m+QZ/x/~1" }, { "type": "encryption", "pointer": "/wWVZ/~1/uVfFR9T" }, { "type": "encryption", "pointer": "/zh,a3unfwZQ/r08XsJ/~1/~1/~0/e4D/fG-y+y1nQYv/imATJ/n0lWP75GC2/DROeAaK/~1" } ], "status": "paused", "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 }, { "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": "error_handler", "name": "myCoolDocumentName", "message": "cupidatat Excepteur culpa est" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "cillum sit in do" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "sit enim elit nisi" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "anim labore" } ], "ancestors": null, "validationErrors": [ { "keyword": "aliquip aliqua in in eiusmod", "instancePath": "laborum deserunt est", "schemaPath": "Ut qui Lorem", "message": "aliqua eiusmod ad consequat veniam" } ], "created_by": { "_id": "a4812b0049d3b4547230d58c", "provenance": "aute in Ut et esse", "username": "commodo Lorem", "firstname": "in incididunt minim", "memberOf": [ { "groupId": "4597d70a773f797d7b7b4fd4", "aaaManaged": false }, { "groupId": "8cbc5b1d8fa6f3deb3df99e5", "aaaManaged": true }, { "groupId": "ab06edeaea8b2d9609e00b93", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit" }, { "roleId": "consectetur in" } ], "inactive": false, "lastLogin": "2021-05-21T13:05:53.533Z", "_meta": { "created": "1957-05-22T03:17:32.64Z", "updated": "1960-04-16T07:32:03.902Z", "migrationVersion": -59099240 }, "email": "consequat cupidatat" }, "last_updated_by": null, "tasks": { "workflow_start": { "x": 93326145.35694706, "y": 48959761.13936558, "gridCoordinate": { "x": -72448361.35678506, "y": 66190910.58088249 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 18098438.843944862, "finish_state": "failure", "user": "a3e27415349f041c34a7930b" }, "groups": [ { "_id": "41376d6c8559f37c327e66bb", "provenance": "aliqua incididunt reprehenderit laboris nisi", "name": "velit in", "description": "laboris sint", "memberOf": [ { "groupId": "86e5751570b3be26a519e183", "aaaManaged": false }, { "groupId": "152c74099f31467fca5c32e6", "aaaManaged": false }, { "groupId": "4ca01b3615fb87836a8cdf06", "aaaManaged": true }, { "groupId": "e12480640b5c59e48207f502", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliqua sed occaecat proident" }, { "roleId": "ad mollit laborum consectetur ex" }, { "roleId": "Duis adipisicing" } ], "inactive": false, "_meta": { "created": "1970-04-30T16:19:51.915Z", "updated": "2008-06-01T20:53:08.306Z", "migrationVersion": -2559257 } }, "default" ], "iterations": [] }, "workflow_end": { "x": -51509631.4111132, "y": -1247603.198695615, "gridCoordinate": { "x": 6057108.666969538, "y": 61252534.35367325 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "error_handler", "e28f", "e28f", "error_handler" ], "complete": [ "workflow_start" ], "error": [ "e28f", "workflow_start", "workflow_start", "error_handler", "workflow_start" ] }, "metrics": { "end_time": -45731013.50494184, "run_time": 58562344.223582655 }, "groups": [ "default", { "_id": "dbe4073b3ea090b7e77553e3", "provenance": "tempor", "name": "eiusmod", "description": "ex magna", "memberOf": [ { "groupId": "9063ed5ebef3f50ce2898c6d", "aaaManaged": true }, { "groupId": "40311dd9188b513e4d0670de", "aaaManaged": true }, { "groupId": "2e196c6f181b94bb9feda8cc", "aaaManaged": false }, { "groupId": "b3efba34991ea5b462d32787", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum in est" }, { "roleId": "voluptate" }, { "roleId": "commodo ad in culpa" } ], "inactive": false, "_meta": { "created": "1989-02-05T19:55:07.352Z", "updated": "2018-02-09T15:47:47.692Z", "migrationVersion": -49095198 } }, "83be9ff35d26fae5df0d3d37" ], "iterations": [ "7fABB4cf-ABC5-Ea7D-95ee-5EaCcF2C0Ce6" ] }, "error_handler": { "x": 33821138.70524086, "y": -57686841.70616063, "gridCoordinate": { "x": 43862037.42991978, "y": -80614657.83045438 }, "name": "childJob", "location": "Adapter", "locationType": "eu irure officia esse Excepteur", "app": "sit ullamco veniam anim mollit", "canvasName": "veniam cupidatat ea", "displayName": "ad", "summary": "amet sint", "description": "tempor fugiat commodo proident", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/f8YNvHS+8h/~1/~1/~1/~1/hz6Hox0Al/o/USg" }, { "type": "encryption", "pointer": "/JzcBva4jZi/sA7eCcMd-0x/~1/~1/f/QBC1b5///~0" }, { "type": "encryption", "pointer": "/~0/KQ/MWTOyT" }, { "type": "encryption", "pointer": "/~0/~0/~1/pGtun/L9ZiR/t/WsoGYXewO37" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "velit", "highlightString": "dolor officia veniam dolore" }, { "key": "consequat fugiat", "highlightString": "labore amet" }, { "key": "dolore elit", "highlightString": "pariatur in" }, { "key": "et", "highlightString": "ea incididunt Duis cillum dolore" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_end", "workflow_end", "workflow_start" ], "complete": [ "3a1f" ], "error": [ "workflow_end", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" } ] }, "serverId": "Duis veniam laborum proident", "start_time": "1947-05-03T22:51:46.497Z", "end_time": 54130985.48061991, "finish_state": "success", "retrySettings": { "state": [ "error", "error" ], "autoRetry": true, "limit": 59893198, "delay": 7387246, "count": 41876624, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "aa7828c4e0a1e3fafa5328d7", "provenance": "voluptate fugiat eu", "name": "consectetur", "description": "dolor esse non dolor", "memberOf": [ { "groupId": "edd5ffd52a88cfc9427f87dc", "aaaManaged": false }, { "groupId": "8b0db0dd5551791ef3055839", "aaaManaged": true }, { "groupId": "52518b02b4693fb170fdd5c4", "aaaManaged": true }, { "groupId": "22a9102686e0852c91276448", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eu qui Ut ipsum nisi" }, { "roleId": "Ut" }, { "roleId": "Duis qui proident nisi" } ], "inactive": true, "_meta": { "created": "2025-06-10T12:25:57.512Z", "updated": "1996-09-19T09:25:43.823Z", "migrationVersion": 68484558 } }, { "_id": "8593b4919ebb1eab8025f87e", "provenance": "magna est in dolor", "name": "exercitation esse", "description": "ad magna", "memberOf": [ { "groupId": "a4c5a909d6ac53f693868352", "aaaManaged": true }, { "groupId": "ebbdc25b7249a1607582ab30", "aaaManaged": false }, { "groupId": "c28426a423d154deec8fb28b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat" } ], "inactive": false, "_meta": { "created": "2021-07-01T03:26:12.798Z", "updated": "1946-05-04T20:50:01.68Z", "migrationVersion": 16158829 } }, "252b52883a98824a9ebe3fd5" ], "iterations": [ "D7d6bFD4-b1Bb-a31e-32a2-91218Cb7B876", "a553cBfe-Dd9c-02C6-07bB-cCcA7f4E9ad7" ] }, "b": { "x": -56703107.306920275, "y": 19181399.490514785, "gridCoordinate": { "x": 93491944.4461141, "y": -23318810.912483647 }, "name": "in non", "location": "Application", "locationType": "amet", "app": "aliqua nisi labore in", "canvasName": "consequat deserunt et ea quis", "displayName": "cupidatat qui", "summary": "ut nostrud labore", "description": "id", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/Dk1dKnsjLZg/~1/xk/~0/RnLtA6o.RNK/gnyZBCD9/~0/~1" }, { "type": "encryption", "pointer": "/TZW03O/~1/~1/~1/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ad", "highlightString": "sint" } ], "status": "failure", "previous": { "incomplete": [ "workflow_end", "workflow_end", "error_handler", "workflow_start", "workflow_start" ], "complete": [ "e28f", "workflow_start", "workflow_end" ], "error": [ "workflow_start", "3a1f", "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "enim id", "start_time": "2002-12-14T08:20:01.758Z", "end_time": 80531158.17675433, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "d70f8715b8edb111fb33430c", "default", { "_id": "48b934d4555667cc88f6873b", "provenance": "nulla est in", "name": "pariatur Duis eiusmod minim", "description": "laborum veniam ipsum adipisicing cupidatat", "memberOf": [ { "groupId": "406cd38c4793019b1ed404ce", "aaaManaged": false }, { "groupId": "bedba7492d4e3dd11787df9e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur Excepteur" }, { "roleId": "aute mollit dolore aliqua pariatur" } ], "inactive": false, "_meta": { "created": "2020-07-27T07:58:27.813Z", "updated": "2014-09-04T16:44:06.006Z", "migrationVersion": -45724739 } } ], "iterations": [ "6D9A0003-baB8-AdD8-D87E-b9d6AFb58C4d" ] } }, "parent": { "job": "dolor ut tempor", "task": "id proident aute", "iteration": 34154666.313707784, "element": 83052679.53233516 }, "errorHandler": null, "groups": [ "default" ], "watchers": [ null, "Pronghorn", { "_id": "c07f0decb32f1438aa3e7cb3", "provenance": "sed magna cupidatat pariatur", "username": "nostrud in", "firstname": "occaecat enim", "memberOf": [ { "groupId": "79a96e38a5c7ea829598e476", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "occaecat consectetur ea quis" }, { "roleId": "voluptate" }, { "roleId": "ullamco ex esse occaecat" }, { "roleId": "non magna occaecat culpa" } ], "inactive": false, "lastLogin": "2003-10-26T03:41:30.136Z", "_meta": { "created": "1993-05-22T07:10:58.21Z", "updated": "1998-11-07T19:40:25.093Z", "migrationVersion": 92572494 }, "email": "pariatur nostrud labore Duis" }, { "_id": "6e42d0c05ef2f90572818192", "provenance": "deserunt id voluptate commodo", "username": "minim fugiat", "firstname": "consequat velit officia aliqua", "memberOf": [ { "groupId": "3253246dedd288ecc0b3c488", "aaaManaged": false }, { "groupId": "fa7a569bbd9a53a78d008b91", "aaaManaged": false }, { "groupId": "abbe2fcbdd1fa8104dfde068", "aaaManaged": false }, { "groupId": "27473348ac3491574f88a799", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure pariatur" }, { "roleId": "ipsum dolor deserunt labore id" } ], "inactive": false, "lastLogin": "1951-07-29T07:21:02.93Z", "_meta": { "created": "1970-03-28T20:11:01.549Z", "updated": "1954-03-02T01:16:17.605Z", "migrationVersion": -52557834 }, "email": "sed magna in" }, { "_id": "172023da11f45e8d4715e877", "provenance": "eiusmod exercitation velit est nulla", "username": "reprehenderit ut", "firstname": "in minim enim sit", "memberOf": [ { "groupId": "34ea68f5815e885701633f93", "aaaManaged": false }, { "groupId": "0739b09479005bc9d85d1720", "aaaManaged": true }, { "groupId": "6f9a00a9309e06dfbf507f36", "aaaManaged": false }, { "groupId": "a6b795dcac0a044e3cae336e", "aaaManaged": false }, { "groupId": "6dc3603ea5c50f5ab2fe1bf5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum ex dolor sint exercitation" }, { "roleId": "ea proident officia in mollit" }, { "roleId": "fugiat minim quis anim" }, { "roleId": "ipsum irure aute" } ], "inactive": true, "lastLogin": "1972-01-15T05:16:37.329Z", "_meta": { "created": "2011-11-14T20:10:59.68Z", "updated": "1998-09-04T23:11:46.426Z", "migrationVersion": 46052832 }, "email": "velit laborum in cupidatat" } ], "metrics": { "start_time": -62606248.68817706, "progress": 0.2637915507227877, "end_time": -82126892.10398856, "user": "Pronghorn", "owner": { "_id": "1223d7dbaf72c31d8e81786c", "provenance": "veniam", "username": "et magna ullamco", "firstname": "officia aute ullamco magna", "memberOf": [ { "groupId": "f44e3067b28f8549cb079006", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in Duis sit Ut" } ], "inactive": true, "lastLogin": "1976-05-22T16:03:36.385Z", "_meta": { "created": "2001-11-08T21:43:56.536Z", "updated": "2016-04-20T03:28:12.274Z", "migrationVersion": -12685603 }, "email": "ut" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }