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": "0f32ddb49bea521a9da38b65", "font_size": 2122773, "type": "automation", "created": "1965-08-16T17:45:42.357Z", "last_updated": "1971-12-11T06:14:33.682Z", "createdVersion": "796151010.83931460.028-2063.9974.292367435.882545740", "lastUpdatedVersion": "300.94859488528.18185885075", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -49075838, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 42062360.47527012, "sla": -87435224.6278649, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/~0/oAY9Heg/GmJ9ieE-B/BIWzf8/YP/~1/~1/bS-pvGNPn" }, { "type": "encryption", "pointer": "/~1/bU/Bj,5T+q9y/ZjItI/g" } ], "status": "paused", "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": "3a1f", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "aute commodo nulla" } ], "ancestors": null, "validationErrors": [ { "keyword": "adipisicing dolor et id", "dataPath": "ut laboris aliqua dolor anim", "schemaPath": "nulla amet aliqua", "message": "cillum ut enim" }, { "keyword": "occaecat veniam", "dataPath": "ut occaecat ad sint mollit", "schemaPath": "incididunt irure et", "message": "laboris" }, { "keyword": "quis nostrud", "dataPath": "id consequat", "schemaPath": "consequat enim dolor Lorem anim", "message": "magna fugiat velit Duis in" } ], "created_by": { "_id": "d1445b40e9e09c32d7714472", "provenance": "do ea dolor", "username": "in in magna reprehenderit", "firstname": "est ad irure", "memberOf": [ { "groupId": "0d388a23af7987aca78ed56d", "aaaManaged": true }, { "groupId": "af81414f19da61aca182df15", "aaaManaged": true }, { "groupId": "cfef0192ed42a419deaefe94", "aaaManaged": false }, { "groupId": "7b598c650c2067191cceb1f9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id cillum ea" }, { "roleId": "ea sit culpa est" }, { "roleId": "voluptate consectetur sint quis" }, { "roleId": "aliqua in in occaecat ullamco" } ], "inactive": true, "lastLogin": "1947-08-24T11:44:22.043Z", "_meta": { "created": "1993-12-29T21:43:14.672Z", "updated": "2015-07-15T07:12:00.208Z", "migrationVersion": 44874001 }, "email": "esse ad nisi" }, "last_updated_by": "c61ed784898d7c4b83f8f7b4", "tasks": { "0": { "actor": { "_id": "4d8043b6521dcb132f557cb8", "provenance": "ex consequat in Lorem in", "username": "ipsum eiusmod ea voluptate in", "firstname": "magna", "memberOf": [ { "groupId": "d22b1087d3a34a2807846d6f", "aaaManaged": false }, { "groupId": "7581e6aa560f7b161382c335", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "anim" }, { "roleId": "dolore proident eu ullamco nulla" }, { "roleId": "ad veniam nostrud sunt" } ], "inactive": false, "lastLogin": "1987-02-14T10:39:46.109Z", "_meta": { "created": "1966-06-24T01:19:32.239Z", "updated": "1964-10-10T00:49:46.758Z", "migrationVersion": 68732087 }, "email": "cillum elit sit eu" }, "groups": [ "default", "default" ], "iterations": [ "00dc2F7B-C6bf-0206-0FEE-C9bF69FFF59C" ], "x": 5514096.827642411, "y": -99708609.74703881, "gridCoordinate": { "x": -44840352.97121833, "y": -53617101.89912094 }, "name": "aliquip dolore aliqua anim", "location": "Adapter", "locationType": "ullamco mollit sunt voluptate minim", "app": "incididunt Excepteur nostrud", "canvasName": "ut fugiat culpa quis ullamco", "displayName": "sunt magna irure ea anim", "summary": "veniam culpa", "description": "id veniam minim laborum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/FqsrT4hJ2h/~0/~1/dha3/SRtE" }, { "type": "encryption", "pointer": "/D8tcCawYf/n.Cj52/~1/mOyWu7Jc-z/hWo543uk" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "deserunt", "highlightString": "consectetur et aliqua ut" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_end", "workflow_end", "workflow_start", "workflow_start", "3a1f" ], "error": [ "3a1f", "workflow_start", "error_handler", "e28f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "voluptate do", "start_time": "1984-04-16T06:28:30.076Z", "end_time": -67415928.90121603, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "magna ex ad" }, "workflow_start": { "x": -23868617.873640567, "y": 33640644.697438255, "gridCoordinate": { "x": -22159940.036596075, "y": -32896299.249674812 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -35086924.65142938, "finish_state": "failure", "user": "c9f020b1ff399df6f2347262" }, "groups": [ "23a5696c46eb735b7c0d3ec9", "default", "356d16f2d6b980a36cc041bc" ], "iterations": [ "3e7f96F4-1b0d-0cDE-bAb5-3d498C933B79" ] }, "workflow_end": { "x": -72810141.86849175, "y": 42793678.69144264, "gridCoordinate": { "x": -78304730.33190568, "y": 27547670.057735234 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "workflow_start", "3a1f", "error_handler" ], "error": [ "error_handler", "error_handler", "3a1f", "e28f" ] }, "metrics": { "end_time": 93678136.76832831, "run_time": -32844234.87214032 }, "groups": [ { "_id": "ea49680def208bad5bd6c996", "provenance": "anim commodo ut in", "name": "ut", "description": "id", "memberOf": [ { "groupId": "4c35737cbe5477afde4a0c3e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute sunt nostrud" }, { "roleId": "exercitation proident" }, { "roleId": "minim tempor esse commodo" }, { "roleId": "labore do amet sunt ea" } ], "inactive": false, "_meta": { "created": "2023-11-01T13:23:52.434Z", "updated": "2003-11-24T21:08:36.503Z", "migrationVersion": 77253 } } ], "iterations": [ "2E903Ab1-f80E-053d-BbAf-B1FCCD1CaaCA" ] }, "error_handler": { "x": -62753566.951679215, "y": 70029252.21772817, "gridCoordinate": { "x": -14111108.664452001, "y": -4304830.340240121 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "voluptate cupidatat", "canvasName": "ea sit irure quis sunt", "displayName": "ad minim", "summary": "dolore tempor", "description": "sed Lorem dolore elit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/QI/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "sint aliquip dolore", "highlightString": "elit culpa consectetur" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "workflow_start", "error_handler" ], "complete": [ "3a1f", "3a1f", "workflow_start", "3a1f" ], "error": [ "workflow_start", "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "officia veniam in ex", "start_time": "1953-09-15T08:35:23.693Z", "end_time": -75484281.4693509, "finish_state": "failure", "retrySettings": { "state": [ "failure", "success", "error" ], "autoRetry": false, "limit": 58567238, "delay": 10049780, "count": 79923895, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "bdf75199926726669541a6ac" ], "iterations": [ "A57cA1e4-4168-DAd6-e8b5-BCbD05cb7A4b" ] } }, "parent": { "job": "et deserunt eiusmod", "task": "Ut dolore est culpa id", "iteration": 81547531.25266817, "element": -52354939.68518439 }, "errorHandler": { "actor": null, "groups": [ "22baffedb39f92baf6e347e0" ], "iterations": [ "3E67BC4b-cbe0-Bf52-571a-F723eCFeFDcc", "37aaBF9f-Cf25-d2ee-Ecd6-ed5BB0eFe8DB", "2Bb5cDbC-0a7B-e2eD-8d2f-64d012db1bEa" ], "x": 25478766.796588108, "y": 47464588.697129786, "gridCoordinate": { "x": 14809489.292427093, "y": -91909806.9916044 }, "name": "aliqua voluptate", "location": "Adapter", "locationType": "voluptate incididunt ut adipisicing", "app": "nisi quis commodo reprehenderit", "canvasName": "eiusmod aliqua elit quis", "displayName": "ea", "summary": "sit ipsum", "description": "dolore labore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/BH3/~1/~1" }, { "type": "encryption", "pointer": "/fKe6RUoakV./mpao0Hp/S24Rx/~0/~1" }, { "type": "encryption", "pointer": "/dSrk7N6Z/j-Q8/~1/~0/Z/FQV/aY/D,fyu53.3NO/~0/b8+j084u5r/~0" }, { "type": "encryption", "pointer": "/~0/Ru/~0/~0/~0" }, { "type": "encryption", "pointer": "/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "sit laborum", "highlightString": "in ut cupidatat in deserunt" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_end", "workflow_start", "3a1f" ], "error": [ "3a1f", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "eu velit Lorem do", "start_time": "1945-03-19T11:40:54.743Z", "end_time": -57770256.50348118, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "adipisicing velit" }, "groups": [ "default" ], "watchers": [ { "_id": "99a845213ed96900680d8264", "provenance": "veniam", "username": "consequat anim", "firstname": "ad Duis do aliquip", "memberOf": [ { "groupId": "55631f76452e9a4468bbed56", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non ut" }, { "roleId": "id esse" }, { "roleId": "commodo culpa ea proident" } ], "inactive": false, "lastLogin": "1955-01-10T22:10:58.932Z", "_meta": { "created": "1960-11-26T16:25:35.29Z", "updated": "1981-05-07T12:19:24.948Z", "migrationVersion": -52837146 }, "email": "dolor" }, "Pronghorn", "Pronghorn", null, null ], "metrics": { "start_time": -58504354.68750286, "progress": 0.04608780444243088, "end_time": -60226455.34309055, "user": "Pronghorn", "owner": { "_id": "8d519bbe7b4d65a7dff91b31", "provenance": "nostrud consectetur veniam ut proident", "username": "commodo nulla", "firstname": "et id minim", "memberOf": [ { "groupId": "23e306375590207c0e55f8de", "aaaManaged": true }, { "groupId": "986d66405e371ee6bdfc662c", "aaaManaged": false }, { "groupId": "07b372610b652cf08331fe0a", "aaaManaged": true }, { "groupId": "40278364c839ef8fdb08f122", "aaaManaged": false }, { "groupId": "e0197f5ca742722150b2b5d3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non deserunt sint adipisicing" }, { "roleId": "dolore incididunt mollit" }, { "roleId": "ea pariatur dolor sit minim" } ], "inactive": false, "lastLogin": "1971-02-05T21:35:22.675Z", "_meta": { "created": "1992-03-16T01:55:13.93Z", "updated": "1964-09-10T06:06:11.415Z", "migrationVersion": -87180692 }, "email": "exercitation sint sit" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }