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": "a87f30ec333494ac042948a0", "font_size": -96490797, "type": "automation", "created": "1958-12-25T07:37:08.071Z", "last_updated": "1984-06-18T16:45:54.666Z", "createdVersion": "4718648524.8735317.327", "lastUpdatedVersion": "63658430.541687.4965396", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -52057897, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 81034546.86187339, "sla": 94984339.64544767, "decorators": [ { "type": "encryption", "pointer": "/aq" } ], "status": "incomplete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "culpa tempor esse", "dataPath": "magna consectetur non est culpa", "schemaPath": "consequat laboris in sint", "message": "qui ullamco sunt ad" }, { "keyword": "sunt proident qui", "dataPath": "in", "schemaPath": "dolore incididunt eu dolore sunt", "message": "commodo sunt magna ut" } ], "created_by": "f49c696dca9b0f2dd553f6b6", "last_updated_by": null, "tasks": { "workflow_start": { "x": 3036412.6373938024, "y": -63313989.98645037, "gridCoordinate": { "x": -28116933.808647066, "y": 25040486.18598853 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -19868850.617267594, "finish_state": "error", "user": "23b6100281642ad5ae6775de" }, "groups": [ "432be05e6ba0cfd7d53f81ab", "default", "default", "de74492779cdbf26d6b96012" ], "iterations": [ "F941e2a9-abb1-a574-cf00-4DfF0ab3AeF8", "5D9f3BA2-FA4a-aE9B-fe8B-2f7edD5D7B7E" ] }, "workflow_end": { "x": 98362577.17479536, "y": 33164466.0544471, "gridCoordinate": { "x": -74450543.3257988, "y": -34736408.01468516 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "error_handler", "3a1f", "e28f" ], "error": [ "workflow_end", "workflow_start", "workflow_end", "workflow_start", "workflow_end" ] }, "metrics": { "end_time": -65927194.12772765, "run_time": -64290881.82513798 }, "groups": [ "default", { "_id": "4038c77d64ffd28f472a19be", "provenance": "magna Lorem ullamco in minim", "name": "proident occaecat anim Lorem officia", "description": "in", "memberOf": [ { "groupId": "c3ea8d6c60768f69d27ab483", "aaaManaged": false }, { "groupId": "f07ba3bf8e941036c3162664", "aaaManaged": false }, { "groupId": "61f7c3129b69e307bb173ef5", "aaaManaged": false }, { "groupId": "ca681b81e8b0f8af21bf5a28", "aaaManaged": true }, { "groupId": "15fb3504d13e4dc796b69cb9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed" }, { "roleId": "incididunt tempor" }, { "roleId": "pariatur sit magna amet" }, { "roleId": "Duis" }, { "roleId": "dolore minim laborum deserunt labore" } ], "inactive": true, "_meta": { "created": "1998-08-27T19:01:04.369Z", "updated": "2017-10-02T00:46:33.747Z", "migrationVersion": -94472044 } }, { "_id": "b1a914b805709f759cef5ce4", "provenance": "ut Duis ea in esse", "name": "mollit", "description": "Duis magna Lorem", "memberOf": [ { "groupId": "1df73adac71eeabb0cdd8d2a", "aaaManaged": false }, { "groupId": "ae9b60fb495153f96b8501a7", "aaaManaged": true }, { "groupId": "4d3fae706f140ac709a21e34", "aaaManaged": true }, { "groupId": "a1fdf6abd3766f80f6662956", "aaaManaged": true }, { "groupId": "d3f8b1bad09b7c2325493e13", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod" }, { "roleId": "culpa Ut" }, { "roleId": "sunt eiusmod nisi" }, { "roleId": "tempor" } ], "inactive": true, "_meta": { "created": "1966-09-14T22:36:53.983Z", "updated": "1963-01-17T05:59:37.458Z", "migrationVersion": -54161565 } } ], "iterations": [ "f07c845b-cc4E-Db16-eEdc-b3cfb8af0eF9" ] }, "error_handler": { "x": -93935924.79082721, "y": 15293672.147289604, "gridCoordinate": { "x": -86090300.97493222, "y": -12692788.103064597 }, "name": "childJob", "location": "Adapter", "locationType": "in velit", "app": "consectetur labore nulla occaecat", "canvasName": "amet dolor cupidatat dolore nisi", "displayName": "anim", "summary": "voluptate consequat nisi ipsum", "description": "deserunt fugiat aute dolore velit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/UACPHAsb/~1/~1/~1/DhZkT/~0/lWfM/iFRg" }, { "type": "encryption", "pointer": "/~0/qbd" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/NNYBT7ZCu/N8vWkZ2/S/~1/~0/~0/Nog96FcwR/m/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "in Duis sunt dolore eiusmod", "highlightString": "enim Ut veniam nisi velit" }, { "key": "incididunt nulla nisi dolor", "highlightString": "qui incididunt nisi" } ], "status": "error", "previous": { "incomplete": [ "error_handler", "3a1f", "workflow_start", "e28f" ], "complete": [ "workflow_end", "error_handler", "e28f", "error_handler" ], "error": [ "workflow_end", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "sunt eu", "start_time": "1965-08-11T12:43:46.706Z", "end_time": -98649011.8756607, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "bc0c96fc857b7b1732304cbc", "a5294740d4cc99d9e067c47b", "44172d897db8867c548caa4c", "fcdca0fc3e5285616d0943b5" ], "iterations": [ "6DbaDBaC-B6eb-d196-Ccd2-Afd4dB0ea138", "63E88Bb5-f59D-d5f6-ba8D-c230EF87CBCB", "3d612ED3-fccb-4F1b-8abC-8e5a0BF35F56" ] }, "2b": { "x": -49964369.4842502, "y": 67864682.5156276, "gridCoordinate": { "x": 5013970.189231336, "y": 28455391.716923818 }, "name": "nisi ea", "location": "Adapter", "locationType": null, "app": "in dolore ut elit non", "canvasName": "id sint", "displayName": "sunt", "summary": "dolor ipsum commodo", "description": "aliquip irure", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ORv6Cr.MY/~1/ZVfseX+f/~0" }, { "type": "encryption", "pointer": "/~0/FxQ3Y9tVm/~1/fP11MLu,l/~1/lGtsiqOvtp/~0" }, { "type": "encryption", "pointer": "/rSVEMQitz7X" }, { "type": "encryption", "pointer": "/PP/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "adipisicing", "highlightString": "ut et" }, { "key": "tempor ut", "highlightString": "non irure" }, { "key": "in ipsum labore", "highlightString": "proident" }, { "key": "reprehenderit eiusmod", "highlightString": "voluptate irure ullamco Lorem do" }, { "key": "minim adipisicing", "highlightString": "eiusmod" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end" ], "complete": [ "e28f", "error_handler", "workflow_start", "error_handler", "workflow_start" ], "error": [ "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "eu non", "start_time": "1995-09-03T05:31:47.539Z", "end_time": -19902382.33491656, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "default", "default" ], "iterations": [ "60C70FAa-eDaB-35c5-eAa2-dCbAbE59c4af", "7c03fD6e-02e7-AA33-fbC4-1Ffa50425732" ] } }, "parent": { "task": "eiusmod in", "iteration": -19074721.009391785, "element": 63227704.09786484 }, "errorHandler": { "x": 85710383.91556266, "y": 22700168.65342313, "gridCoordinate": { "x": -68808145.32028946, "y": 14461222.622518927 }, "name": "laboris sed id dolor", "location": "Broker", "locationType": null, "app": "aliqua cillum nostrud tempor dolor", "canvasName": "enim labore minim deserunt", "displayName": "aliqua occaecat non", "summary": "id dolore ex", "description": "reprehenderit labore aute sunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/k2cYmYz/~1/I/~0/~0/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "adipisicing sit ex", "highlightString": "Duis eiusmod minim velit" } ], "status": "failure", "previous": { "incomplete": [ "error_handler", "error_handler" ], "complete": [ "3a1f", "workflow_start", "e28f", "workflow_start", "error_handler" ], "error": [ "error_handler", "workflow_start", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "non do esse", "start_time": "1995-09-13T03:54:26.868Z", "end_time": -51881484.481266014, "finish_state": "failure", "retrySettings": { "state": [ "error", "failure", "failure", "failure", "failure" ], "autoRetry": false, "limit": 24662263, "delay": 79258533, "count": 10101651, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ "06ad837cf022f38635ab81c8", "default", { "_id": "0310e6380a05241c42b82d61", "provenance": "adipisicing", "name": "ipsum nulla officia dolor consequat", "description": "in", "memberOf": [ { "groupId": "8575a6e1b68a3d5a2fd542d1", "aaaManaged": true }, { "groupId": "57ac9388fea4b6a14bd8faba", "aaaManaged": true }, { "groupId": "4fb22a24ac3095dded22d426", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "id adipisicing" }, { "roleId": "irure cillum ut sint" }, { "roleId": "eiusmod qui voluptate ullamco" }, { "roleId": "non aliqua laboris ad Ut" } ], "inactive": true, "_meta": { "created": "1948-08-23T04:55:05.894Z", "updated": "2015-07-06T00:36:21.226Z", "migrationVersion": 44818221 } }, "ca9cb1e1c42fbd4767ebc74e" ], "iterations": [ "cAB9dCce-D6dF-deBC-BCE8-965ACA4CdeFd", "C53fF526-2Dc3-2471-d929-A6bDDE752242" ] }, "groups": [ { "_id": "6c29b5e319212edfc31789d6", "provenance": "id", "name": "aliquip in", "description": "do proident ex id", "memberOf": [ { "groupId": "d536c17c26c06c09d8d9d673", "aaaManaged": true }, { "groupId": "86c2d847a54108c9765933b0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do" }, { "roleId": "enim" }, { "roleId": "ex culpa consectetur nulla id" }, { "roleId": "incididunt Lorem" } ], "inactive": true, "_meta": { "created": "1951-03-28T19:24:12.677Z", "updated": "1983-05-27T02:28:05.527Z", "migrationVersion": -28475328 } }, "d0810aa7023bcfac6bde5197", "788eaafc3910ba74e0f10c9d", { "_id": "6669d9407b02f488a60d3db4", "provenance": "mollit", "name": "enim Excepteur esse dolore eiusmod", "description": "Duis id Lorem proident et", "memberOf": [ { "groupId": "51a3d0618b999fccceccf609", "aaaManaged": true }, { "groupId": "cf57aa5ee6734233099dfd84", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing in eiusmod consequat in" } ], "inactive": true, "_meta": { "created": "1959-06-27T20:05:13.629Z", "updated": "1967-06-12T02:08:01.032Z", "migrationVersion": -80067910 } }, "default" ], "watchers": [ "b45b819b78c7893b0f44b79e" ], "metrics": { "start_time": -36323572.858543865, "progress": 0.6711591603733249, "end_time": -88124013.93531246, "user": "ee8a3bd3ec092fdd21f46f31", "owner": { "_id": "ebe0c96245619a258468cea7", "provenance": "culpa cillum dolor cupidatat Excepteur", "username": "mollit consectetur culpa reprehenderit enim", "firstname": "eu in", "memberOf": [ { "groupId": "dac7cc207980c7224a1c7805", "aaaManaged": false }, { "groupId": "73a78bc2636e63d9607e7dcc", "aaaManaged": true }, { "groupId": "0b0c28bb08d66a6e28662a1d", "aaaManaged": false }, { "groupId": "96bb8ff3868bf62ebc39a376", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim nostrud proident eu" } ], "inactive": false, "lastLogin": "1985-09-11T13:39:05.741Z", "_meta": { "created": "1996-09-25T17:36:12.074Z", "updated": "1969-11-29T13:48:23.99Z", "migrationVersion": -94432237 }, "email": "in et esse enim adipisicing" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }