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": "e080b7d09b7ecb08201425ac", "font_size": 50948468, "type": "automation", "created": "2003-03-22T15:33:04.097Z", "last_updated": "2022-08-12T03:30:35.699Z", "createdVersion": "12.59419.05597079835-0835.672677.1691.535345473", "lastUpdatedVersion": "898640.257.664-9509.0.39805628902.173794823", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -22254480, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 95489978.01928037, "sla": -86105875.6609867, "decorators": [ { "type": "encryption", "pointer": "/deNWqrwWP/RFEkvJ8xf/~1/u0uJ94QaRrE/~1/yO/T/~0/JFOxd/Oi-b/P5E/X/~1" }, { "type": "encryption", "pointer": "/K6A+/t80aG" }, { "type": "encryption", "pointer": "/gigwTeHrJWF/q/~1/pTvGN5h/~0" }, { "type": "encryption", "pointer": "/lGN0-P+n/~1/~1/~1/Vg2" }, { "type": "encryption", "pointer": "/lIY3wdAQ/ZU/W6VF2/tFZ/gFZYJ5RE/pAcKkK/NJ-dNOma" } ], "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 }, { "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": "e28f", "name": "myCoolDocumentName", "message": "incididunt" } ], "ancestors": null, "validationErrors": [ { "keyword": "quis", "dataPath": "Excepteur cillum in", "schemaPath": "deserunt nisi amet", "message": "consectetur adipisicing" } ], "created_by": { "_id": "07eb9fa2d18bd883ce54d3f2", "provenance": "non sed in sunt in", "username": "id laborum", "firstname": "magna", "memberOf": [ { "groupId": "ba6db4dc5ccaf32b805ada24", "aaaManaged": false }, { "groupId": "3234af682955bbaa6b0e0acb", "aaaManaged": false }, { "groupId": "6235d5394ca20cbd8cfdebe1", "aaaManaged": true }, { "groupId": "9f44789f8dd5519fd5efe4ba", "aaaManaged": false }, { "groupId": "40eb55badadbfe5cc0156ee5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "magna incididunt aute eu et" }, { "roleId": "pariatur proident" }, { "roleId": "nisi do in magna" }, { "roleId": "deserunt dolore" }, { "roleId": "aliqua Lorem" } ], "inactive": false, "lastLogin": "2007-08-11T01:04:35.861Z", "_meta": { "created": "1995-09-04T03:40:43.747Z", "updated": "2009-11-09T16:14:52.776Z", "migrationVersion": 28130335 }, "email": "occaecat laborum" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -17061928.024022207, "y": -3449691.2458051145, "gridCoordinate": { "x": 76156790.8895661, "y": -67853268.27082665 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -6594173.38940002, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "aefbe929a4b61de7c189c9c3", { "_id": "e7eb5031b79c1b1f362167bf", "provenance": "eiusmod enim do dolor", "name": "eu", "description": "culpa ut aliqua est ea", "memberOf": [ { "groupId": "d4e0c689bb5f519fb17bb63c", "aaaManaged": true }, { "groupId": "351d960287b90b597a0c7edf", "aaaManaged": false }, { "groupId": "ac2a38c5ab80d90ac3b39ac4", "aaaManaged": false }, { "groupId": "41d3922e5885434cd7f7696e", "aaaManaged": true }, { "groupId": "ea45c333527398f8ca54bc38", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nostrud do ut voluptate minim" }, { "roleId": "magna esse" }, { "roleId": "Excepteur nisi incididunt" }, { "roleId": "incididunt do" }, { "roleId": "eu" } ], "inactive": false, "_meta": { "created": "2005-06-17T07:51:35.744Z", "updated": "1982-08-13T12:34:38.81Z", "migrationVersion": 26970045 } }, { "_id": "c2745a82c04096ac8e5cf72b", "provenance": "exercitation mollit", "name": "amet", "description": "adipisicing officia ad anim dolore", "memberOf": [ { "groupId": "99689591dbd1129aaedafc81", "aaaManaged": false }, { "groupId": "d227f08f56394ff4d139ac1a", "aaaManaged": false }, { "groupId": "1f40dd027d34d421a7191c7d", "aaaManaged": true }, { "groupId": "558233f80de35b805f879245", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "enim veniam" } ], "inactive": false, "_meta": { "created": "1969-11-09T19:15:40.605Z", "updated": "1997-09-03T18:29:43.892Z", "migrationVersion": 86838751 } }, "default" ], "iterations": [ "dFC5Fc1c-c2Fa-E96D-FC09-736AC019dCfB", "0413b30D-a0Ea-CDCd-dbeb-318ebDc7b8eA", "a463eAd9-633B-deB8-fE85-bAac05CAA400" ] }, "workflow_end": { "x": -42420431.42585361, "y": -21513579.568458676, "gridCoordinate": { "x": 47742927.39543912, "y": -40213612.780932985 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "3a1f", "workflow_start", "e28f", "workflow_start" ], "complete": [ "error_handler", "error_handler", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 19720862.31587857, "run_time": -36374694.74449588 }, "groups": [ "b76bf4c39d6ce7cff171d06d", "default", { "_id": "2ce8e3d0d860c4d1f4320144", "provenance": "sint in in exercitation officia", "name": "dolore ut ullamco ex aliquip", "description": "ad est proident magna exercitation", "memberOf": [ { "groupId": "ab6f6d2f92dacad441a17cff", "aaaManaged": true }, { "groupId": "3e6301a43e4686c24562cc98", "aaaManaged": true }, { "groupId": "cb64021719e4f0691ac88df1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Ut voluptate sed reprehenderit" }, { "roleId": "ullamco do" }, { "roleId": "ea" }, { "roleId": "exercitation cillum" }, { "roleId": "ullamco fugiat" } ], "inactive": false, "_meta": { "created": "2022-02-03T19:39:01.192Z", "updated": "1975-11-19T23:21:09.858Z", "migrationVersion": -36841315 } }, "default" ], "iterations": [ "C03f1ad1-6f8e-d42b-C3eF-de7ca916f071" ] }, "error_handler": { "x": -27534949.195815757, "y": 85529517.07621026, "gridCoordinate": { "x": 90038626.56430131, "y": 53200199.10643619 }, "name": "childJob", "location": "Application", "locationType": null, "app": "dolore", "canvasName": "voluptate reprehenderit minim", "displayName": "cillum", "summary": "esse laborum in", "description": "in incididunt nulla aliquip", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/IOXpJhPSJ8/~1" }, { "type": "encryption", "pointer": "/~1/~1/X967/TbO7yB+g0Z/s8g4T/IV.Y/~0/KyNm8uGp/ep9mDOaez44/MHHsQHz-f" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "ut laboris sit Lorem", "highlightString": "commodo nostrud mollit" }, { "key": "nulla", "highlightString": "sunt" }, { "key": "amet quis magna laboris minim", "highlightString": "quis nisi" }, { "key": "quis", "highlightString": "nulla" }, { "key": "dolor incididunt veniam", "highlightString": "laboris cupidatat Lorem" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_end", "3a1f", "workflow_start", "workflow_start", "workflow_end" ], "complete": [ "workflow_start", "workflow_start", "e28f" ], "error": [ "3a1f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "eiusmod ad cupidatat sunt", "start_time": "1996-04-16T09:09:12.406Z", "end_time": 43508720.36495343, "finish_state": "error", "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 19902074, "delay": 94156228, "count": 72116232, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "default", "default" ], "iterations": [] }, "6e": { "x": 4698486.046790332, "y": -91753126.4492076, "gridCoordinate": { "x": 9439600.782066122, "y": 18662888.20490673 }, "name": "laboris", "location": "Application", "locationType": "Lorem ad quis", "app": "sint mollit tempor laborum", "canvasName": "nisi sed irure dolor", "displayName": "nostrud", "summary": "ex", "description": "veniam Duis sed", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/~0/~1/~1/~1/~0/uPvUmNrIHeE" }, { "type": "encryption", "pointer": "/~0/TMn7/lDs/WzAx-t1/~1" }, { "type": "encryption", "pointer": "/~1/~0/OB/Ntc6ba-n8F/~1/H9-" }, { "type": "encryption", "pointer": "/BvL/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "anim commodo reprehenderit sunt laboris", "highlightString": "in elit anim non" }, { "key": "velit sunt nulla tempor", "highlightString": "in aliquip" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "e28f", "error_handler" ], "complete": [ "error_handler", "e28f" ], "error": [ "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "sunt consequat Duis", "start_time": "1968-11-02T09:10:16.402Z", "end_time": 4833572.618099511, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "daa6d30b72d6a034ab5b8eb3", "groups": [ "default", "default" ], "iterations": [ "94EDAC2a-15B4-095F-7f88-9869fca1aFEC" ] } }, "parent": { "job": "sed labore reprehenderit quis anim", "task": "tempor", "iteration": 13412761.049539983, "element": 62606905.76458126 }, "errorHandler": null, "groups": [ { "_id": "d514dd5d5a769e30d1b09f09", "provenance": "esse eiusmod qui et do", "name": "sed deserunt aliquip tempor proident", "description": "incididunt", "memberOf": [ { "groupId": "0e36819514036e2016bd9f13", "aaaManaged": true }, { "groupId": "57d8941ac92992f0a8dfde3b", "aaaManaged": false }, { "groupId": "203e532d4b44d5db1801cd3d", "aaaManaged": false }, { "groupId": "f71e25de36dd5d5902bedf33", "aaaManaged": true }, { "groupId": "a9d78008ef01ed0e1ce6d0cd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse" } ], "inactive": true, "_meta": { "created": "1979-05-05T01:51:33.546Z", "updated": "1953-11-22T08:12:51.034Z", "migrationVersion": 10129294 } }, { "_id": "f1543066abcb119bbb0339e0", "provenance": "cillum sint", "name": "esse fugiat commodo", "description": "Excepteur", "memberOf": [ { "groupId": "1392ce43d27f462949186fcb", "aaaManaged": false }, { "groupId": "30b6773b2f52f7ced2a36b3d", "aaaManaged": true }, { "groupId": "d759ed9d0158ac082d7acf1c", "aaaManaged": false }, { "groupId": "96fdf6b5a4f40dfcfae96a29", "aaaManaged": true }, { "groupId": "1127840f2c74584dd37501b8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit non magna nulla velit" } ], "inactive": true, "_meta": { "created": "1949-06-08T09:27:23.459Z", "updated": "1986-11-11T23:21:36.872Z", "migrationVersion": 40606539 } }, { "_id": "08c986d30d8bc1b67771172b", "provenance": "consectetur", "name": "mollit dolor", "description": "qui dolore reprehenderit", "memberOf": [ { "groupId": "0ff1bc135f9b342c56dcd9e1", "aaaManaged": false }, { "groupId": "f9ee9903f6f379d8939a4b5d", "aaaManaged": false }, { "groupId": "4d1d8ddeab6bf83fecbc9896", "aaaManaged": true }, { "groupId": "33874c1b5102f24d84ade00d", "aaaManaged": false }, { "groupId": "9b49ad42afce9075de2703bd", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt culpa in exercitation est" }, { "roleId": "adipisicing dolore sit" } ], "inactive": false, "_meta": { "created": "1950-07-02T18:58:44.562Z", "updated": "2009-03-18T04:27:57.842Z", "migrationVersion": 35114321 } }, "default" ], "watchers": [ null, "Pronghorn", "Pronghorn", "Pronghorn", "922a8acd65317da4ad8e7182" ], "metrics": { "start_time": 76027192.56423533, "progress": 0.05504533157004654, "end_time": -5843929.852228552, "user": { "_id": "4cdaab52b6946c390e6912a5", "provenance": "proident laboris", "username": "dolore", "firstname": "exercitation laboris", "memberOf": [ { "groupId": "069b2f7b94375164984e5c5d", "aaaManaged": true }, { "groupId": "59e9ab9f5a2a211ef66bf6cb", "aaaManaged": false }, { "groupId": "1c36e92d2de72cbd3279cf46", "aaaManaged": false }, { "groupId": "d920efa981df04e6d3a3d2ba", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod" } ], "inactive": false, "lastLogin": "2000-06-29T09:47:28.763Z", "_meta": { "created": "1966-12-10T01:42:16.205Z", "updated": "1946-06-12T18:14:01.848Z", "migrationVersion": 51289952 }, "email": "sit" }, "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }