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": "d9530f030d7fa11d07ad1782", "uuid": "6759c8d5-3822-fd3a-2790-48e491384eb0", "font_size": 26010063, "type": "resource:action", "created": "1977-01-17T01:43:58.83Z", "last_updated": "2009-10-30T06:15:50.911Z", "createdVersion": "26129994791.6.6-6658.45473.3328886480", "lastUpdatedVersion": "502000.97818788.08149217-7554.48627.2876", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 84110267, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -97068768.08679721, "sla": -71902066.97734696, "decorators": [ { "type": "encryption", "pointer": "/~0/EMD3/4uDc9E/Z/Y+INdg/~0/tPKdvyHzX1U/jXc4/~0/~0/z73Sn3w/ww4bWXgw5" }, { "type": "encryption", "pointer": "/jYv,xRsWkiQ/~1/zIL3z8t/~0/~0" }, { "type": "encryption", "pointer": "/~0/~1/~0/VJoKiz/~0/vs,woLV/tQ49MP" }, { "type": "encryption", "pointer": "/~1/~0" } ], "status": "running", "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": "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 }, { "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_end", "name": "myCoolDocumentName", "message": "dolor dolore elit veniam" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "ex aliquip amet magna pariatur" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "4c2ec505cfc88665d180da8c" ], "validationErrors": [ { "keyword": "Excepteur sunt", "instancePath": "fugiat ad eiusmod sit officia", "schemaPath": "aliquip dolor deserunt sint nostrud", "message": "quis amet ullamco reprehenderit officia" }, { "keyword": "Excepteur eu velit do", "instancePath": "ullamco anim ex ad", "schemaPath": "anim in", "message": "minim enim" } ], "created_by": "4e899f024e92c4159d4fc7a5", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -5576355.85939908, "y": -47238164.69456685, "gridCoordinate": { "x": -10427961.10222657, "y": 13577470.575310975 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -43205645.82005888, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "ce5665fc1fb2ea4783141177", "23eac49bc4addc31ac2b98e5" ], "iterations": [ "dA0AF29D-f2Da-CDdF-C183-6817DF0CC146", "b47a2E9E-76ab-2de2-7bD0-E8daB544803E", "5bb5D353-2cCC-aB2C-1694-5B925cdC2b5a" ] }, "workflow_end": { "x": 92999700.07583767, "y": 85865124.88186404, "gridCoordinate": { "x": -71069071.08009666, "y": -14476530.669286177 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start", "workflow_end", "workflow_start", "workflow_end" ], "complete": [ "workflow_start", "error_handler" ], "error": [ "workflow_end" ] }, "metrics": { "end_time": 36130487.833937764, "run_time": -85031719.60502946 }, "groups": [ { "_id": "f24da0244b7e06aae447d7ff", "provenance": "aute", "name": "labore ad", "description": "id", "memberOf": [ { "groupId": "7fef078bba1e5f7cc2c6f954", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut" }, { "roleId": "laboris velit labore esse" }, { "roleId": "laborum" } ], "inactive": false, "_meta": { "created": "1960-03-27T04:40:32.932Z", "updated": "1956-06-30T03:56:19.539Z", "migrationVersion": -79291509 } } ], "iterations": [] }, "error_handler": { "x": 7033979.410532564, "y": 93314368.30540752, "gridCoordinate": { "x": 75853140.78710163, "y": -56935927.32545745 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "eu ad laboris Excepteur cupidatat", "canvasName": "ex reprehenderit irure", "displayName": "anim aliqua", "summary": "est cillum ullamco", "description": "velit cillum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/i/dRp,q-jfr7/~0/Rm/mAx2BQL1sO/~1" }, { "type": "encryption", "pointer": "/EhGwhXc0k/~0/~0" }, { "type": "encryption", "pointer": "/ga+oG-k/EAybNjSBqub/GBg/~0/YeZUf+hA7t1/N6riAcae/xlpP8FZijJ" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "deserunt voluptate commodo exercitation aliqua", "highlightString": "minim sunt veniam ut irure" }, { "key": "non", "highlightString": "eu irure esse sit" }, { "key": "dolor dolore cupidatat minim", "highlightString": "aute sed non" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "error_handler" ], "error": [ "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "ut do in", "start_time": "1952-05-10T23:46:13.344Z", "end_time": -21775630.446432278, "finish_state": "failure", "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 71123309, "delay": 15646424, "count": 93500191, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "db59e9dab1bc82723b7ffdbc", "provenance": "dolor cupidatat", "name": "velit eu non", "description": "sint reprehenderit elit occaecat", "memberOf": [ { "groupId": "906de73d0c0c345387c3c9a0", "aaaManaged": false }, { "groupId": "d2a9ab5f0b9d661fb5ad7746", "aaaManaged": false }, { "groupId": "2868333637cc2ac52cda4629", "aaaManaged": true }, { "groupId": "221bdb242d8969936762a09f", "aaaManaged": false }, { "groupId": "ac71e2c25e107c4d204756a2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore sed occaecat ipsum consequat" }, { "roleId": "id minim ullamco" }, { "roleId": "quis" }, { "roleId": "ut cupidatat reprehenderit non" } ], "inactive": true, "_meta": { "created": "2023-06-09T19:27:50.099Z", "updated": "1992-09-27T04:38:22.162Z", "migrationVersion": 35450811 } }, { "_id": "2291f32536e7c82f932977a6", "provenance": "ex enim ipsum consectetur laboris", "name": "dolor Duis", "description": "Excepteur ea fugiat nisi", "memberOf": [ { "groupId": "2d0bd94f97541028be2749ba", "aaaManaged": true }, { "groupId": "8e69e4192a77d2f83b478e1e", "aaaManaged": true }, { "groupId": "8c44ac53464dad6478f88743", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate minim tempor cillum" } ], "inactive": false, "_meta": { "created": "1958-03-07T09:58:06.586Z", "updated": "1964-08-22T21:44:49.678Z", "migrationVersion": -75802565 } }, "default", "598c24e022b6c5729a1d331c" ], "iterations": [ "e6cbAd89-D2bF-43fD-9b3F-6655eAEFDdee", "6EaEfcF8-1aa7-fEfC-Eebd-d588Bb0dA77a", "49CbD8Bd-bDdb-6b5b-0f7f-d0F3FB22fda0" ] }, "ef": { "x": 84055886.20788628, "y": -33958539.34167708, "gridCoordinate": { "x": 1241174.18257761, "y": 66778632.413969874 }, "name": "Ut ut Lorem proident", "location": "Application", "locationType": null, "app": "commodo ipsum deserunt Lorem", "canvasName": "nostrud", "displayName": "ex", "summary": "sed", "description": "culpa qui proident laborum velit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/KtGNHJ0/~1/wlXIsG/~1/~1/~1/Yy/jpRe/~1/iScwDGYla/F6d4G0k,/VzZCT" }, { "type": "encryption", "pointer": "/bhUW9q/~0/K-KhaIJur//nmZPrU/~0/ef0ucpJ0" }, { "type": "encryption", "pointer": "/~0/~0/m.xll/CK3w/~0/~0" }, { "type": "encryption", "pointer": "/~1/NYB/F./HPODm/~0/IQn8Paq/90P/z//~0" }, { "type": "encryption", "pointer": "/~0/vEiX7sa/~0/Ifq/~1/~0/g/~1/~0/b3eAGgIfkPr/TULzd" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "magna aliqua in id consectetur", "highlightString": "in Duis esse et deserunt" }, { "key": "incididunt sed", "highlightString": "ipsum elit" }, { "key": "aliquip in ea laboris do", "highlightString": "enim Lorem exercitation" }, { "key": "non", "highlightString": "ad" } ], "status": "running", "previous": { "incomplete": [ "e28f", "workflow_start", "workflow_start", "e28f", "error_handler" ], "complete": [ "3a1f", "error_handler", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "e28f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "loop" } ] }, "serverId": "quis labore Lorem", "start_time": "1968-09-25T04:32:50.656Z", "end_time": -13904814.818408579, "finish_state": "failure", "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 72022810, "delay": 60929244, "count": 71688600, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "343522a1876a8f86a2cdfa3f", "provenance": "sint commodo ullamco in voluptate", "name": "Ut aliqua cupidatat Duis", "description": "aliquip", "memberOf": [ { "groupId": "d5fe098903d958a45ee4f9ae", "aaaManaged": false }, { "groupId": "2be3198123daf033dc2cb760", "aaaManaged": false }, { "groupId": "52b67baa07c6ff4a08f07d23", "aaaManaged": true }, { "groupId": "7aacd25c0f3a625837f14185", "aaaManaged": false }, { "groupId": "007c962893e282748f0ee20b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad cillum aliqua est" }, { "roleId": "ut occaecat eiusmod" } ], "inactive": false, "_meta": { "created": "2003-08-09T23:10:08.911Z", "updated": "1980-01-08T12:18:22.804Z", "migrationVersion": 96638780 } }, { "_id": "e0c30f4a7d67265ffa39b91c", "provenance": "velit eu", "name": "dolore consequat", "description": "labore aliqua", "memberOf": [ { "groupId": "4d6f4312cb97220679445141", "aaaManaged": false }, { "groupId": "5bd6cf2890b0426e1d335c15", "aaaManaged": true }, { "groupId": "95429a257656be4ac5217a4b", "aaaManaged": false }, { "groupId": "de223e0362191e2629bc60b1", "aaaManaged": true }, { "groupId": "40e5e86f8547a3fcff8821cf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla esse sit fugiat" } ], "inactive": false, "_meta": { "created": "2005-03-11T18:02:52.559Z", "updated": "1968-06-05T15:51:22.156Z", "migrationVersion": 10487854 } } ], "iterations": [ "e59DEc6D-cBcf-1aee-b4a9-07Dca891fDd7", "FF4d8b5C-aed9-2b32-a6C4-c9FE8EcB7Ae8", "8fBcaCbA-3aB9-b770-2Af7-cef05CC54eea" ] } }, "parent": { "task": "Excepteur officia ex commodo", "iteration": -91803499.56434202, "element": -8089742.669452786 }, "errorHandler": null, "groups": [ "default", { "_id": "5df217c8911b151f9c8a37df", "provenance": "magna sed aute tempor", "name": "dolor voluptate", "description": "pariatur Excepteur aliqua non dolor", "memberOf": [ { "groupId": "e0ef6d733a0641379a971071", "aaaManaged": true }, { "groupId": "a0ec933a18ff891e87f6d191", "aaaManaged": false }, { "groupId": "efbe670c60aa59f778237ad1", "aaaManaged": false }, { "groupId": "7452ae11bab5d43781c4fb6e", "aaaManaged": false }, { "groupId": "5d200e31b6ba5399d9d8b077", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit incididunt nulla" } ], "inactive": false, "_meta": { "created": "1992-05-30T10:41:28.84Z", "updated": "2020-10-18T21:02:35.422Z", "migrationVersion": 9877489 } } ], "watchers": [ "22b18d5873255841f9962ebe", "Pronghorn", null, "Pronghorn" ], "metrics": { "start_time": 88981120.72020483, "progress": 0.24770958202498994, "end_time": -97603850.28858343, "user": null, "owner": "9213f942a40423a9a79f6cc7" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }