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": "a75c95a363050af2c90f37a7", "font_size": 4246621, "type": "resource:action", "created": "1949-11-14T10:29:29.802Z", "last_updated": "1996-07-10T13:23:13.587Z", "createdVersion": "357.11617811.84409-3280.5747203.532.340551120", "lastUpdatedVersion": "853351099.2899687600.50948", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -55295655, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 61212999.79758254, "sla": -81820281.67002317, "decorators": [ { "type": "encryption", "pointer": "/eyUZkttjeDA/sjA/Bu5XNV/HPWsR/HSkdKU/oyHh3YJX/dx3a/tQCYHGn" }, { "type": "encryption", "pointer": "/~1/~0/~0/~1/~1" }, { "type": "encryption", "pointer": "/OzU0803/~0/Sjdc5p5l/~0/~0/Vh+V/~1" }, { "type": "encryption", "pointer": "/~0/~0/p5-qIimoVXr" }, { "type": "encryption", "pointer": "/Me56e/BdMoV," } ], "status": "error", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "tempor" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "ut occaecat Excepteur tempor eu" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "et", "dataPath": "sunt", "schemaPath": "pariatur ea deserunt", "message": "nisi eiusmod non cillum" }, { "keyword": "aliqua ipsum dolore sed", "dataPath": "Duis in proident", "schemaPath": "commodo tempor voluptate", "message": "et sit Duis labore est" } ], "created_by": { "_id": "b244286749bde699bcfc38bf", "provenance": "exercitation officia velit dolore Duis", "username": "anim pariatur", "firstname": "reprehenderit do occaecat minim voluptate", "memberOf": [ { "groupId": "66d01ca99f62ae8ff8249d73", "aaaManaged": true }, { "groupId": "78c1edb06be005d3a0b185de", "aaaManaged": true }, { "groupId": "b39ea8eee487ca2fdd803086", "aaaManaged": true }, { "groupId": "1ff898754f8c02fd26fd487d", "aaaManaged": false }, { "groupId": "aaadc54fb7c80fb63b1cdaf9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui non Ut" }, { "roleId": "cupidatat dolor" }, { "roleId": "commodo minim mollit esse dolore" }, { "roleId": "Ut eu dolore minim in" }, { "roleId": "et laboris enim Lorem veniam" } ], "inactive": false, "lastLogin": "1970-08-23T23:33:05.918Z", "_meta": { "created": "2007-01-21T15:55:59.755Z", "updated": "1999-12-28T07:55:50.767Z", "migrationVersion": -66924475 }, "email": "velit anim fugiat ex" }, "last_updated_by": { "_id": "721f973ebf51292d72efb1bd", "provenance": "laboris magna non dolor", "username": "sed in reprehenderit in", "firstname": "culpa voluptate commodo incididunt", "memberOf": [ { "groupId": "05c4a96c3a6a227ef2ea9dfb", "aaaManaged": true }, { "groupId": "e6d7a74005d1a71439894e28", "aaaManaged": true }, { "groupId": "02c8c2b965f644e8620b0ea7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore reprehenderit Ut" }, { "roleId": "est sit labore enim occaecat" }, { "roleId": "cupidatat commodo est" }, { "roleId": "ipsum commodo occaecat in" }, { "roleId": "dolore sed est qui deserunt" } ], "inactive": false, "lastLogin": "1975-12-31T21:32:27.972Z", "_meta": { "created": "1952-05-17T09:53:39.18Z", "updated": "2025-01-02T02:48:20.283Z", "migrationVersion": -81110979 }, "email": "nisi magna occaecat Excepteur esse" }, "tasks": { "workflow_start": { "x": -58681270.71310112, "y": -88057181.7872509, "gridCoordinate": { "x": 25503542.48163864, "y": -20407614.88782747 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -88320823.35792561, "finish_state": "success", "user": null }, "groups": [ "default", "bcc21ca8e7b0449d7d0e2114" ], "iterations": [ "c610fEc2-1C0B-c88e-28E5-AD2edf49b8Ce" ] }, "workflow_end": { "x": -55750858.40782949, "y": 19052828.205850154, "gridCoordinate": { "x": 45706474.706656456, "y": 3895638.8532031626 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "error_handler", "3a1f" ], "complete": [ "workflow_start" ], "error": [ "workflow_end" ] }, "metrics": { "end_time": -28488142.860513672, "run_time": 61797206.18528712 }, "groups": [ "9778c2119a8531c7ed34b92c", "default" ], "iterations": [ "c76B9C96-baed-8ff8-1Dad-6577fE32eb74" ] }, "error_handler": { "x": -53425830.59195349, "y": -12406595.395575956, "gridCoordinate": { "x": -87751660.49928825, "y": 3689033.042807609 }, "name": "childJob", "location": "Adapter", "locationType": "Lorem aliqua", "app": "eu Duis aliquip minim adipisicing", "canvasName": "quis in", "displayName": "nostrud aliquip ea", "summary": "voluptate", "description": "Lorem", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/df" }, { "type": "encryption", "pointer": "/~1/Dt-TmdRnj" }, { "type": "encryption", "pointer": "/w/~0/~0/f4/B07JOOrN/~0/~0/~1/~1/G4+QqEk,uq/Jn6" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "deserunt", "highlightString": "id consequat Excepteur laborum dolor" }, { "key": "qui labore", "highlightString": "mollit incididunt consectetur do" }, { "key": "tempor dolore", "highlightString": "aliquip" }, { "key": "aute", "highlightString": "eiusmod occaecat dolore" }, { "key": "occaecat elit proident qui", "highlightString": "voluptate" } ], "status": "error", "previous": { "incomplete": [ "workflow_start", "workflow_end", "e28f", "3a1f" ], "complete": [ "3a1f", "workflow_end", "workflow_start", "error_handler", "3a1f" ], "error": [ "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "anim magna id ad", "start_time": "2023-03-24T04:57:19.57Z", "end_time": -19243185.088091552, "finish_state": "success", "retrySettings": { "state": [ "error", "failure", "success", "success" ], "autoRetry": false, "limit": 85733618, "delay": 43048336, "count": 26265433, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "4d238c460e16f273ee6e1a4d", "provenance": "adipisicing", "name": "eiusmod ex Lorem non dolor", "description": "ullamco et in eiusmod aliqua", "memberOf": [ { "groupId": "10cb6bff7c262d092999dd23", "aaaManaged": true }, { "groupId": "aee40254c949b8b02694cb1b", "aaaManaged": false }, { "groupId": "6dcdc815f9440511c25ce174", "aaaManaged": false }, { "groupId": "1ba4d27fb01b7a3f57188844", "aaaManaged": true }, { "groupId": "8206e3023903af4115de0284", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt consectetur" }, { "roleId": "cupidatat elit laborum nostrud" }, { "roleId": "adipisicing sint Duis ea" }, { "roleId": "Ut sit deserunt" }, { "roleId": "sint eu" } ], "inactive": true, "_meta": { "created": "1966-02-27T22:09:46.046Z", "updated": "1982-05-31T19:04:58.582Z", "migrationVersion": 65066243 } }, { "_id": "cfbbbff20a3ade68664e5b53", "provenance": "exercitation est ipsum deserunt velit", "name": "ullamco mollit", "description": "officia nostrud", "memberOf": [ { "groupId": "a40a83af7d242a8e0db2c57f", "aaaManaged": true }, { "groupId": "2f6846725a0385e0c90ba1b5", "aaaManaged": false }, { "groupId": "8b48a1375d6b410cbdd4d9f8", "aaaManaged": false }, { "groupId": "29b749944711b0df0cb2fc65", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "magna aliquip ex irure Duis" }, { "roleId": "sint Excepteur occaecat reprehenderit do" }, { "roleId": "sint veniam mollit" }, { "roleId": "nulla do qui ut dolor" } ], "inactive": false, "_meta": { "created": "1957-08-20T10:14:28.837Z", "updated": "2015-03-28T10:52:57.668Z", "migrationVersion": -27051564 } }, { "_id": "62b2bf21e59fea6bcbc5308b", "provenance": "consectetur in ea id elit", "name": "sunt aliquip", "description": "ut et", "memberOf": [ { "groupId": "82815dd018bb216971d41df2", "aaaManaged": true }, { "groupId": "a1729e3f6f9852bc47f1e1c9", "aaaManaged": true }, { "groupId": "caaeaae89161868aa889632d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa" }, { "roleId": "quis officia laboris ut" }, { "roleId": "non est esse aliqua" }, { "roleId": "enim non aliqua" }, { "roleId": "exercitation eu et" } ], "inactive": false, "_meta": { "created": "2007-07-02T02:34:15.363Z", "updated": "1996-07-28T20:12:19.504Z", "migrationVersion": 31480897 } }, { "_id": "7f77c2cf246d69f0916fabd9", "provenance": "Ut", "name": "consequat non id", "description": "labore", "memberOf": [ { "groupId": "ababec697eecfce9eb1a58df", "aaaManaged": true }, { "groupId": "533f2a125f38653783f71196", "aaaManaged": true }, { "groupId": "c733e029ec55e354ca56b3ba", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea" } ], "inactive": true, "_meta": { "created": "1962-10-31T02:27:48.881Z", "updated": "2001-11-05T04:21:20.991Z", "migrationVersion": 6628 } } ], "iterations": [ "3B0CCadE-0e6f-cD7A-f3BE-EEfad67DEaa9" ] }, "c0dd": { "actor": "Pronghorn", "groups": [ "095c5046a9420bae80af80c9", "20a1bc4b731aa5e87b614aa9", "default", "default" ], "iterations": [ "cA14c7eb-8aC7-5D90-39B5-989E8b54D59F" ], "x": 25387214.39993669, "y": 6254288.408000305, "gridCoordinate": { "x": 41675418.63845953, "y": -11399783.780159727 }, "name": "elit reprehenderit minim ipsum", "location": "Broker", "locationType": null, "app": "aliquip et", "canvasName": "incididunt ea Duis", "displayName": "aute nisi", "summary": "laboris sint", "description": "do laborum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ZVcb3TdFo/~1/~0/~1/blBIi7OF/~0/J-Ngf/t/jbj/Dsby" }, { "type": "encryption", "pointer": "/eKh5G/YPkIjxQo72O/x/kk-1wh" }, { "type": "encryption", "pointer": "/rlu4YgAxc/~0/~1/~0" }, { "type": "encryption", "pointer": "/dqbXDnr/onKk166" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "qui do cupidatat", "highlightString": "elit commodo labore proident magna" }, { "key": "consequat ex cillum", "highlightString": "enim" }, { "key": "minim aliqua", "highlightString": "sit magna" }, { "key": "occaecat est in consequat in", "highlightString": "dolor dolor velit" } ], "status": "failure", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "error_handler" ], "error": [ "error_handler", "workflow_start", "e28f", "3a1f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "ut qui", "start_time": "1999-03-31T06:11:42.647Z", "end_time": -73694747.91607034, "finish_state": "error", "retrySettings": { "state": [ "success", "failure", "success", "failure", "failure" ], "autoRetry": false, "limit": 37886187, "delay": 75647945, "count": 7330701, "finishedRetrying": false }, "type": "manual", "view": "consectetur" } }, "parent": { "job": "culpa", "task": "occaecat", "iteration": -97409661.55179982, "element": 76455536.89889231 }, "errorHandler": null, "groups": [ "d1763d806f2d0a16a693dbdf" ], "watchers": [ null, "Pronghorn", { "_id": "e0a02bdeb0205677578216e7", "provenance": "minim do dolore", "username": "minim aute ex in", "firstname": "sit nisi deserunt enim et", "memberOf": [ { "groupId": "2d0c2bfb581ac64a643e61c6", "aaaManaged": true }, { "groupId": "453138b6bf6f9e7b027c84d4", "aaaManaged": false }, { "groupId": "aab4ee0b45733c4dc6d9edb2", "aaaManaged": true }, { "groupId": "4d99c9dd78d2843f3dd2cc8e", "aaaManaged": false }, { "groupId": "daaefd7f8684ebb4adf2fb74", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor in" } ], "inactive": true, "lastLogin": "1982-10-16T07:41:00.54Z", "_meta": { "created": "2021-03-30T22:28:55.123Z", "updated": "2008-10-21T23:29:35.805Z", "migrationVersion": -84754231 }, "email": "pariatur non" }, null, { "_id": "a5721d0e2f3c32aa4a6e45cb", "provenance": "ut ullamco Lorem Ut", "username": "voluptate", "firstname": "in eu sunt dolor", "memberOf": [ { "groupId": "dc6e65e75be2c8b4bc014d4b", "aaaManaged": false }, { "groupId": "3b8b03d1cdf90b7bfcce66d0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat" }, { "roleId": "ipsum nostrud in" } ], "inactive": false, "lastLogin": "2010-05-08T23:46:46.241Z", "_meta": { "created": "1988-12-02T03:37:03.322Z", "updated": "2004-03-08T06:55:18.475Z", "migrationVersion": 63498855 }, "email": "in nostrud ipsum" } ], "metrics": { "start_time": 65749052.86652708, "progress": 0.017002409445602273, "end_time": -48094702.687723376, "user": "41fb147b3efc759691c34932", "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }