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 created the requested item", "data": { "_id": "0dab954a5f08bf69813faf49", "font_size": -58927586, "type": "resource:action", "created": "1966-07-31T08:07:20.057Z", "last_updated": "2025-05-18T19:29:40.453Z", "createdVersion": "59525414595.29131.1026326391-1593.1617706699.131.6", "lastUpdatedVersion": "196249535.2977828.737", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 56792848, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -59920938.58795235, "sla": -92100034.75887425, "decorators": [ { "type": "encryption", "pointer": "/~1/hA6rsz" } ], "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": "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": "error_handler", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "exercitation laborum incididunt" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "cillum veniam in incididunt", "dataPath": "dolore", "schemaPath": "ad pariatur", "message": "exercitation incididunt minim enim" }, { "keyword": "exercitation", "dataPath": "exercitation reprehenderit non sit eiusmod", "schemaPath": "adipisicing id ullamco", "message": "dolor ullamco Lorem" } ], "created_by": { "_id": "8f355125f6813512abc36216", "provenance": "exercitation", "username": "sed elit enim", "firstname": "proident dolor aliqua", "memberOf": [ { "groupId": "e54b3db93d76f8d531ad7a9d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum officia" }, { "roleId": "voluptate velit" }, { "roleId": "sint mollit" } ], "inactive": true, "lastLogin": "2020-03-30T05:37:26.684Z", "_meta": { "created": "1969-03-19T14:30:57.294Z", "updated": "1992-08-23T04:28:58.401Z", "migrationVersion": -59834625 }, "email": "sunt culpa aliqua id amet" }, "last_updated_by": null, "tasks": { "199": { "x": 27637757.020840377, "y": 52227067.5594227, "gridCoordinate": { "x": 48375936.50191975, "y": 9049090.911672011 }, "name": "enim ullamco magna", "location": "Broker", "locationType": "cupidatat sint", "app": "commodo dolore", "canvasName": "cupidatat", "displayName": "labore dolor ipsum", "summary": "amet", "description": "exercitation cupidatat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/T7JYX2T/~0/P+XOWk/~0/~1/oeZiTs-GVk/Rid/B/DGOj/~1/w8yrJC8/~0" }, { "type": "encryption", "pointer": "/T" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/cPGeVbO/-/EbT9Gs/~1/s/zz1/~0" }, { "type": "encryption", "pointer": "/uTEi/~0/~1/~0/~1/~0/f2UL48eixrE" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "laboris aute et sint", "highlightString": "consequat culpa Ut esse" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "error_handler", "workflow_start" ], "complete": [ "e28f", "3a1f", "error_handler", "error_handler", "workflow_start" ], "error": [ "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "e28f", "type": "revert" } ] }, "serverId": "in amet et do qui", "start_time": "2020-02-26T02:07:44.918Z", "end_time": -49964560.237983905, "finish_state": "success", "retrySettings": { "state": [ "error", "failure" ], "autoRetry": true, "limit": 45751003, "delay": 72489538, "count": 54454521, "finishedRetrying": false }, "type": "operation", "actor": { "_id": "26137dd2699af924107c76d0", "provenance": "exercitation nostrud eu", "username": "dolore do occaecat Excepteur", "firstname": "proident Excepteur quis", "memberOf": [ { "groupId": "91103213e9ac871b58d9d444", "aaaManaged": false }, { "groupId": "029272271508125773bcb2f0", "aaaManaged": false }, { "groupId": "48ce79f07b33ed1cfea6c31a", "aaaManaged": true }, { "groupId": "2418571d6fac3a5c388a6a5e", "aaaManaged": false }, { "groupId": "551034b55dcbb87a4f256b32", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "anim ut dolore Duis" } ], "inactive": false, "lastLogin": "1989-07-27T11:31:35.777Z", "_meta": { "created": "1958-02-01T23:11:20.097Z", "updated": "1966-10-22T22:40:00.69Z", "migrationVersion": 25590677 }, "email": "non consequat nostrud dolore aliqua" }, "groups": [ "default", { "_id": "82e122a73ee24c477f82141a", "provenance": "tempor nisi do proident", "name": "eu pariatur nulla", "description": "Duis aute nostrud", "memberOf": [ { "groupId": "2853fbddf3d699f57fa61424", "aaaManaged": false }, { "groupId": "52918d94b4e488ff17278d05", "aaaManaged": false }, { "groupId": "0b4d3975aa48050062e751c4", "aaaManaged": false }, { "groupId": "067b948aae1768b2575aa7e9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut sunt Ut in ex" }, { "roleId": "non" }, { "roleId": "cupidatat irure ullamco" }, { "roleId": "ut ullamco" }, { "roleId": "laborum" } ], "inactive": false, "_meta": { "created": "1956-02-18T20:21:25.338Z", "updated": "2015-01-15T23:23:00.448Z", "migrationVersion": -98034263 } }, "default" ], "iterations": [ "4AAdb3EA-917c-3357-DDab-6beea85AFCfc" ] }, "workflow_start": { "x": -23524005.830918744, "y": -86689159.50053315, "gridCoordinate": { "x": 16822078.326625124, "y": 42432913.71423218 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -53197381.45623685, "finish_state": "error", "user": "Pronghorn" }, "groups": [ "default", "default", { "_id": "cb98f11a80a12e3df4af6272", "provenance": "et dolore tempor incididunt", "name": "exercitation quis et Lorem commodo", "description": "Excepteur fugiat sed ipsum", "memberOf": [ { "groupId": "9e61e606476439975ecded23", "aaaManaged": false }, { "groupId": "47bcf045bdb09f4fb87479aa", "aaaManaged": false }, { "groupId": "cd0600ee81642276f2a3fb63", "aaaManaged": false }, { "groupId": "864e65a7732df74a610de3fe", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor nulla adipisicing" } ], "inactive": false, "_meta": { "created": "1957-03-18T21:31:26.827Z", "updated": "2013-12-02T09:55:01.545Z", "migrationVersion": -41633351 } }, { "_id": "ec9bc204aa8b9e8f0c0fac2c", "provenance": "occaecat ad culpa", "name": "aliquip adipisicing", "description": "pariatur esse", "memberOf": [ { "groupId": "5cbbe731a5dda7c7c84e096a", "aaaManaged": true }, { "groupId": "96468509792359132373b71e", "aaaManaged": true }, { "groupId": "a3d6a3a534f60b6f7a1bddf7", "aaaManaged": true }, { "groupId": "9720e12fffc0bc177865e802", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit mollit velit" } ], "inactive": true, "_meta": { "created": "1959-08-18T22:42:24.134Z", "updated": "2024-08-02T21:32:26.379Z", "migrationVersion": 18612129 } }, { "_id": "0e385aee25e1c65bb8810228", "provenance": "nostrud sed esse", "name": "in", "description": "laborum aliqua dolore ipsum elit", "memberOf": [ { "groupId": "7231b99c307ccdf97431bd71", "aaaManaged": true }, { "groupId": "231dcebfae4f034518be4ac0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris ex ut occaecat aliqua" }, { "roleId": "adipisicing fugiat" } ], "inactive": true, "_meta": { "created": "1960-06-06T02:04:03.237Z", "updated": "1949-06-22T09:46:35.365Z", "migrationVersion": 2468720 } } ], "iterations": [ "c3cDFDdA-0359-6F79-5A4D-B15F2eADdDd9" ] }, "workflow_end": { "x": 97840690.2328, "y": 42115214.26409072, "gridCoordinate": { "x": 21704595.59194362, "y": -62441377.11571658 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "error_handler", "workflow_end" ], "complete": [ "error_handler", "3a1f", "workflow_start" ], "error": [ "3a1f" ] }, "metrics": { "end_time": -21499116.082118347, "run_time": -59015864.30696937 }, "groups": [ "default", { "_id": "64bb2678ae29a9883c3c3542", "provenance": "pariatur aliqua", "name": "irure culpa id", "description": "dolore consequat consectetur in", "memberOf": [ { "groupId": "9687f5a3b2f3502c839f80f0", "aaaManaged": true }, { "groupId": "6ccceb7353e0dde78e3aa7f1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla" }, { "roleId": "laborum minim Lorem aute" }, { "roleId": "cupidatat id" } ], "inactive": true, "_meta": { "created": "2015-07-23T15:17:16.969Z", "updated": "1962-04-05T06:42:29.547Z", "migrationVersion": -62528282 } }, "2d2594f8e5e8916b1a407f98" ], "iterations": [ "AacC1aC9-B5b3-f5C1-0fAB-eD4DAD2D6C1E", "4a939Dff-244E-6eCe-CbDD-EFFB2e3b29B3" ] }, "error_handler": { "x": -83033059.86279663, "y": -48316209.358336605, "gridCoordinate": { "x": 30011834.124358967, "y": 60597001.33246654 }, "name": "childJob", "location": "Application", "locationType": "laboris", "app": "officia sed aliqua quis", "canvasName": "in voluptate est ut laborum", "displayName": "in enim Excepteur", "summary": "id", "description": "cillum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/bWA/SmCShH9n1J/Jip8q7uMS/~0/n89rViidK/iu69.KLG/URoMU9igC/CF6" }, { "type": "encryption", "pointer": "/~0/LjDJvJ/KQrZsYdaQ/~1/~1/vf" }, { "type": "encryption", "pointer": "/~0/~0/~1/~0/f" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "do", "highlightString": "in eu est" }, { "key": "do minim id", "highlightString": "aute in Lorem" }, { "key": "eiusmod mollit quis", "highlightString": "ex et aliqua occaecat" }, { "key": "labore tempor occaecat nostrud", "highlightString": "in non" } ], "status": "canceled", "previous": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "3a1f" ], "error": [ "workflow_end", "workflow_start", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "standard" } ] }, "serverId": "ullamco ex incididunt commodo nisi", "start_time": "1987-03-28T12:37:25.337Z", "end_time": -22853072.683482096, "finish_state": "error", "retrySettings": { "state": [ "error", "error", "success" ], "autoRetry": false, "limit": 629201, "delay": 30262496, "count": 28224897, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "aa66d30de66d90ba32eb06e9", "default", { "_id": "fca835da7c47021f4d737a2d", "provenance": "mollit et", "name": "dolor consequat cillum Duis", "description": "aute eu ex minim", "memberOf": [ { "groupId": "d096c0f5263e75f843316f76", "aaaManaged": true }, { "groupId": "e2076ab0c1a7b9ec6e1e226d", "aaaManaged": false }, { "groupId": "5e2adb6c0e773bbfe26f2c86", "aaaManaged": false }, { "groupId": "f4ed700d8094444d043c26ba", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa" }, { "roleId": "amet Excepteur pariatur cupidatat mollit" }, { "roleId": "et elit amet" }, { "roleId": "ut" }, { "roleId": "do laborum enim" } ], "inactive": false, "_meta": { "created": "1953-09-29T04:44:47.273Z", "updated": "1948-01-04T09:20:33.015Z", "migrationVersion": -72927565 } }, { "_id": "4d76a5c8df53c9b9edaf70c3", "provenance": "dolore ea anim nostrud proident", "name": "laborum tempor veniam", "description": "anim magna sint laboris", "memberOf": [ { "groupId": "b7e3aeee832d500746292b9f", "aaaManaged": true }, { "groupId": "a704049b3629d1dfe3da4ade", "aaaManaged": false }, { "groupId": "b85b4b679614e56d79a44f83", "aaaManaged": false }, { "groupId": "632e09fa6e9888d0698d129c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur Lorem qui anim officia" }, { "roleId": "do fugiat" }, { "roleId": "proident dolore est in et" }, { "roleId": "voluptate elit" }, { "roleId": "sunt" } ], "inactive": false, "_meta": { "created": "1957-09-21T20:36:26.681Z", "updated": "1949-04-09T08:40:36.502Z", "migrationVersion": -40780058 } } ], "iterations": [] } }, "parent": { "job": "aliquip sed fugiat occaecat exercitation", "task": "dolore", "iteration": 98188619.50370291, "element": -73552743.00704235 }, "errorHandler": { "x": -88287502.65906118, "y": -80578012.46553881, "gridCoordinate": { "x": 83150551.4382636, "y": -39878740.61487568 }, "name": "eiusmod anim voluptate eu occaecat", "location": "Broker", "locationType": "Duis dolor incididunt", "app": "aliqua ullamco Excepteur", "canvasName": "sit amet Duis consectetur officia", "displayName": "irure dolor enim ex", "summary": "mollit aliqua aliquip", "description": "aliqua qui irure ipsum ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/FWimH6/cD386fOpnq/~1/NISU/~1/~0" }, { "type": "encryption", "pointer": "/q7/~0/I6pY.08tlw/LFf/s.hCx/D/~0/~1/j81/VtAWyT/XTc96NWWpFt/giNZN" }, { "type": "encryption", "pointer": "/~0/amIk3FYV0cK/zu" }, { "type": "encryption", "pointer": "/~0/b9ONs8w8P/cGZWmH8p.q" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ut sit sint consectetur", "highlightString": "ut" }, { "key": "ea pariatur dolore consectetur", "highlightString": "sed cillum" }, { "key": "tempor", "highlightString": "magna qui velit sunt" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "error_handler", "error_handler", "workflow_end" ], "complete": [ "3a1f", "error_handler" ], "error": [ "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "fugiat proident quis", "start_time": "2006-12-12T14:49:15.44Z", "end_time": 5375010.496521026, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "default", "default", { "_id": "2ef66ab2a2d29caec663223c", "provenance": "occaecat", "name": "Ut anim Excepteur", "description": "dolore", "memberOf": [ { "groupId": "1cf009b834564c58b15676ab", "aaaManaged": true }, { "groupId": "259e76d4845253df1b9e4082", "aaaManaged": false }, { "groupId": "3543094dab89235c5134b514", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Ut sunt reprehenderit qui" } ], "inactive": true, "_meta": { "created": "1956-07-05T12:37:46.235Z", "updated": "2025-07-09T11:50:47.832Z", "migrationVersion": -30434954 } } ], "iterations": [ "58111DB5-6ceb-5f9b-b599-5ed31d43098b", "36bff237-02f6-E8F9-78C9-402d7cD92afe", "d4Ef77e3-D71c-ab7b-0eBF-9d8ec2BE1eBf" ] }, "groups": [ "6c995aac2d5a632cff9d5d0c", "ca7cc0092314a74b605a2905", "1a484883a3beeaf2be54cc2a" ], "watchers": [ "Pronghorn", null ], "metrics": { "start_time": 74342262.49503264, "progress": 0.37097816740470724, "end_time": 23634412.844266534, "user": "6b3f413a21da45c95db57245", "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }