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": "fd2d53b0dd260bd065eebc8d", "font_size": 90757949, "type": "resource:compliance", "created": "1984-02-07T08:55:04.642Z", "last_updated": "1998-04-28T19:00:24.718Z", "createdVersion": "63276.062.6642974-9029.56731545312.6833.51", "lastUpdatedVersion": "2.33830.83781218", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -62639331, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -4623788.93949759, "sla": -92872659.2314367, "decorators": [ { "type": "encryption", "pointer": "/Np-f5SACgLj/~1/~0/~1/~1/~1/BOl3lCU/Qwr/~0/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/~1/z3UzAZIdAr3/~0/~1" }, { "type": "encryption", "pointer": "/QipA/wUI.QT/MhCHkW8/YExk6VR/~0/Xg/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/noGkW/ZpeF5/V/~1/mVIygo99w" } ], "status": "canceled", "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "minim pariatur dolor deserunt" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "officia in pariatur elit" } ], "ancestors": [ "fab863a711ff5803a6881960", "4099b5185c4182db3b3d6dbe", "4119a0f74398e9ac54af1f95", "c939f1b83afe0120912e49c3" ], "validationErrors": [ { "keyword": "culpa magna commodo Duis ullamco", "instancePath": "aute laboris commodo mollit", "schemaPath": "ipsum nulla", "message": "minim adipisicing" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "40": { "x": 2158228.5037238747, "y": 10445156.202060476, "gridCoordinate": { "x": 91187609.34606266, "y": 83080367.04069144 }, "name": "Duis", "location": "Adapter", "locationType": null, "app": "voluptate deserunt", "canvasName": "in", "displayName": "nisi aliquip dolore", "summary": "ea magna voluptate enim", "description": "velit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/S3F-2wxL72x" }, { "type": "encryption", "pointer": "/~0/KTs/ug/Hkf/c/rI96/Y3KWENq" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "velit laboris sed do in", "highlightString": "aliquip anim" }, { "key": "aliqua veniam reprehenderit laborum labore", "highlightString": "Duis sint" } ], "status": "complete", "previous": { "incomplete": [ "error_handler", "workflow_end", "e28f" ], "complete": [ "error_handler", "3a1f" ], "error": [ "error_handler", "workflow_end", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "exercitation", "start_time": "1959-05-12T23:09:10.008Z", "end_time": -71072181.10267803, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "e1eb0bbc98f84615af94c6f1", "8d8bba931bbbae661d44ee1c", { "_id": "d6eadea403a0ccdb3fa1ddb3", "provenance": "non nulla amet cupidatat", "name": "velit exercitation ullamco eiusmod", "description": "non deserunt", "memberOf": [ { "groupId": "5cc414c68772f226bcea725f", "aaaManaged": true }, { "groupId": "e0dc32d84b5dddafa83c8498", "aaaManaged": false }, { "groupId": "bd6112b6b18abc288dfd61b1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi aute anim" } ], "inactive": false, "_meta": { "created": "2014-02-05T06:03:10.86Z", "updated": "1980-07-15T13:16:16.419Z", "migrationVersion": -76941189 } } ], "iterations": [ "e29FcF3e-633A-7c67-9dFB-FAEe849cbFd9" ] }, "workflow_start": { "x": 83607415.01227126, "y": 68002313.9232913, "gridCoordinate": { "x": -24626360.443287656, "y": 78395625.10764706 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -3328959.379866302, "finish_state": "success", "user": { "_id": "36a05c87c40332d0ad089939", "provenance": "ut magna eu", "username": "mollit", "firstname": "amet tempor incididunt velit dolore", "memberOf": [ { "groupId": "589f1e215f06fd183f36e211", "aaaManaged": true }, { "groupId": "1092fbb20fede15ebbcc36bd", "aaaManaged": true }, { "groupId": "a5654c31b66f4b1831763ace", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "aute ullamco deserunt" }, { "roleId": "adipisicing Duis" } ], "inactive": false, "lastLogin": "2000-04-04T08:40:06.566Z", "_meta": { "created": "1979-06-13T09:40:05.422Z", "updated": "1979-05-22T00:29:24.995Z", "migrationVersion": -9615745 }, "email": "dolor" } }, "groups": [ "b940d3afefc8082a9d2e870d", "default", "default" ], "iterations": [ "891C80de-9BC8-8BB9-AbBb-E94bC2F370b8", "C8795BAA-2A21-bb8E-E379-1A5cDaabDe9B" ] }, "workflow_end": { "x": -58790453.71110432, "y": 61252190.95601401, "gridCoordinate": { "x": 10883280.227492958, "y": 78075370.74560118 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_end", "error_handler", "workflow_end", "e28f" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "workflow_start", "workflow_start", "e28f" ] }, "metrics": { "end_time": 15662412.497174487, "run_time": -88665299.47502491 }, "groups": [ { "_id": "943fab47016783f481959c73", "provenance": "aliqua sint in sed", "name": "laboris velit", "description": "dolore esse eu adipisicing cupidatat", "memberOf": [ { "groupId": "7f9bb70b8c02ccf7017928c2", "aaaManaged": true }, { "groupId": "fb2a1839c4a4a99a9d708d23", "aaaManaged": true }, { "groupId": "6c740e3fc0492dfa8a750973", "aaaManaged": false }, { "groupId": "3acf7b81b86958a6e322d410", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat ullamco ut" }, { "roleId": "est reprehenderit id irure" }, { "roleId": "fugiat sed exercitation" }, { "roleId": "magna elit incididunt in" }, { "roleId": "ut ex fugiat dolore" } ], "inactive": false, "_meta": { "created": "1952-03-08T20:20:39.003Z", "updated": "1962-12-09T16:00:45.129Z", "migrationVersion": 59141447 } }, { "_id": "615672638f4643d336bd5f58", "provenance": "ullamco velit", "name": "consectetur officia eiusmod ex pariatur", "description": "voluptate ut", "memberOf": [ { "groupId": "af1b6db0b72280b54dcee33f", "aaaManaged": false }, { "groupId": "d1323296d7f6cfaf10198e05", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet nostrud ad laboris" }, { "roleId": "eiusmod" }, { "roleId": "ut fugiat ex" } ], "inactive": false, "_meta": { "created": "1965-10-06T09:58:19.588Z", "updated": "1997-06-29T20:46:18.486Z", "migrationVersion": 1776717 } }, "d05031c09b76d998ae7b2645" ], "iterations": [ "ceD88b58-1Ca2-c5a5-efB9-eD6ED0fdbB6a", "8cb4f634-9A83-D4dA-c02c-c6F36DDB65BD" ] }, "error_handler": { "x": -95548454.91676392, "y": -16757396.235835344, "gridCoordinate": { "x": 99189540.93960464, "y": 25219586.791179 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "consectetur culpa Duis id", "canvasName": "culpa sed adipisicing", "displayName": "culpa exercitation nulla", "summary": "irure consectetur dolor tempor", "description": "dolor sit ex labore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/sYWp3JI/~1/Qzf.V/Y,jvopGmh/~0/aRpfQcMN/~1/eeh-dgh9VzG/~1" }, { "type": "encryption", "pointer": "/~1/ZvK/~0" }, { "type": "encryption", "pointer": "/tK/~1/cOxezxNrDh/~0/dnJTGim/~1/sVX-vVZ3eq/uZa9/xIuo8pHwQ/~1/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ut ea aliqua pariatur eiusmod", "highlightString": "consectetur sed elit" }, { "key": "mollit do sit", "highlightString": "officia quis velit mollit" }, { "key": "elit est esse ea", "highlightString": "et anim qui" }, { "key": "laboris officia", "highlightString": "enim ad adipisicing minim magna" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "error_handler", "workflow_end", "workflow_end" ], "complete": [ "e28f", "error_handler" ], "error": [ "workflow_start", "3a1f", "e28f", "3a1f", "workflow_end" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "Duis commodo proident occaecat", "start_time": "1978-03-18T13:36:09.881Z", "end_time": 12468709.338038757, "finish_state": "success", "retrySettings": { "state": [ "error", "success" ], "autoRetry": true, "limit": 16342056, "delay": 56039618, "count": 33630826, "finishedRetrying": true }, "type": "operation", "actor": "bb378988e91bd7907db705db", "groups": [ "b7a4f8bae89635baa97d63c3" ], "iterations": [ "dC21B9F4-cad0-Ca9C-9A0D-Ae6e8241aeAa", "eb92eb6f-8daB-CA93-5Ce2-d7bF999B91c4" ] } }, "parent": { "job": "consequat aliqua", "task": "amet", "iteration": 78594020.16453049, "element": -5725979.28975758 }, "errorHandler": { "x": 86500776.77625546, "y": 45359266.10057214, "gridCoordinate": { "x": -89250996.4677887, "y": -32270751.70959206 }, "name": "ad fugiat ut aute enim", "location": "Adapter", "locationType": null, "app": "proident pariatur sint adipisicing in", "canvasName": "ut fugiat", "displayName": "Excepteur ipsum eiusmod quis ex", "summary": "amet do ullamco", "description": "officia ex minim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/s4l/fbKJgqQo3n/~1/Bw/pEnPEZ8zkKJ/~0/~0" }, { "type": "encryption", "pointer": "/WrzmS/HpfY,qiG/dP0wbI6/~0" }, { "type": "encryption", "pointer": "/Xbd/~0/unbi/TIzZq1f/n1a0D/o6fQR/~0/Mz5dgv/QJ/~1/~1/~0" }, { "type": "encryption", "pointer": "/Ho" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "fugiat deserunt sunt est ullamco", "highlightString": "consectetur occaecat quis officia qui" }, { "key": "proident Duis quis elit et", "highlightString": "in Lorem ipsum laboris tempor" }, { "key": "consectetur nisi", "highlightString": "dolor voluptate ad" }, { "key": "voluptate", "highlightString": "dolore quis laboris aliqua ut" } ], "status": "running", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_end", "workflow_start", "3a1f", "workflow_start", "e28f" ], "error": [ "workflow_end", "workflow_end", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "loop" } ] }, "serverId": "Excepteur Lorem", "start_time": "1950-01-03T07:28:16.624Z", "end_time": 23584899.563067645, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "23b27939070f1f39d2c9a347", { "_id": "b3daff28857844d0d4084b66", "provenance": "cillum ullamco sint", "name": "labore fugiat sunt ex", "description": "culpa occaecat", "memberOf": [ { "groupId": "9b5f7bed4101795f3ee9615f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute elit dolor occaecat nisi" }, { "roleId": "esse ea non" }, { "roleId": "nisi minim amet cillum" } ], "inactive": false, "_meta": { "created": "2018-02-14T10:55:08.607Z", "updated": "1969-03-11T13:15:12.302Z", "migrationVersion": 75344545 } }, "default", "default" ], "iterations": [ "9Fcc3DD4-6DdB-2b7f-822B-Ebec40bf9Fd0" ] }, "groups": [ "default" ], "watchers": [ { "_id": "61e47416d15e6532ddbb4a74", "provenance": "Lorem laboris Ut", "username": "anim adipisicing proident", "firstname": "anim quis voluptate cupidatat sint", "memberOf": [ { "groupId": "15156441cb05d514ccd00b61", "aaaManaged": false }, { "groupId": "df6b9b148cf11297a5ad47fc", "aaaManaged": false }, { "groupId": "5da05ba409a8a2f357bc4798", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt ad eu non magna" }, { "roleId": "cupidatat ut in" }, { "roleId": "ad" }, { "roleId": "dolor" }, { "roleId": "proident" } ], "inactive": false, "lastLogin": "1956-07-23T01:10:52.852Z", "_meta": { "created": "2017-12-25T10:17:59.019Z", "updated": "1964-08-06T16:39:58.321Z", "migrationVersion": 98998182 }, "email": "in nulla aliquip cillum" }, "Pronghorn", "e3311191fc2ff90932c6dc64" ], "metrics": { "start_time": -16707363.71913004, "progress": 0.9196857976561841, "end_time": -42771503.6101151, "user": { "_id": "0aa4d76c716b6085d23eea60", "provenance": "laboris", "username": "ut", "firstname": "cupidatat", "memberOf": [ { "groupId": "13ca7a9f72ae69029942e8e0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure veniam nulla ullamco" }, { "roleId": "adipisicing Excepteur esse" } ], "inactive": false, "lastLogin": "1986-03-09T20:40:18.575Z", "_meta": { "created": "1961-12-28T12:25:13.539Z", "updated": "1977-06-12T11:01:40.118Z", "migrationVersion": -25103893 }, "email": "laboris reprehenderit ea sint" }, "owner": { "_id": "56908d1cb869d967fb89eb43", "provenance": "in laborum et minim in", "username": "ut qui ullamco enim", "firstname": "id veniam ad nisi sit", "memberOf": [ { "groupId": "69c8791d48100073970b6689", "aaaManaged": true }, { "groupId": "805f41b6adfc8e12a2d05451", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat aliqua Lorem sint eu" } ], "inactive": false, "lastLogin": "2020-07-11T14:03:30.644Z", "_meta": { "created": "1968-10-31T17:30:45.163Z", "updated": "1999-02-19T13:21:01.568Z", "migrationVersion": -183437 }, "email": "aliqua est amet" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }