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 imported 3 of 4 documents", "data": { "_id": "9dda68771e116f2401fde6f4", "uuid": "8e2d0a0a-6396-d31d-3bfb-97a3dab2f485", "font_size": -35798441, "type": "automation", "created": "1989-06-12T14:49:14.702Z", "last_updated": "1955-03-02T08:33:01.384Z", "createdVersion": "7888385786.3.0747768-0110.8184160.659459", "lastUpdatedVersion": "2717.5094446491.4504", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -97531198, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -98250783.99694775, "sla": 70452606.1492953, "decorators": [ { "type": "encryption", "pointer": "/raS2/XowII9/tGjFD4a/lVmBfldTxGB/~0/sSg1bKD/LZ/~1/~0/kGin/DLPxw.vEu/~0" }, { "type": "encryption", "pointer": "/~0/~0/vJAYARP/~0/~0/RXth//~0/W3/LNI2v/~1/t3SxHQ" }, { "type": "encryption", "pointer": "/GYr/Y7/~0/~1/jePg/QwnM5a/~1" }, { "type": "encryption", "pointer": "/~1/lBxx/~0/~0/U+tC/~0/~0/~0/~1/R,/~0" }, { "type": "encryption", "pointer": "/~0/ujZ/t8u" } ], "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 }, { "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 }, { "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": "workflow_start", "name": "myCoolDocumentName", "message": "id nulla minim" } ], "ancestors": null, "validationErrors": [ { "keyword": "amet do exercitation sed ut", "instancePath": "in pariatur laboris fugiat", "schemaPath": "occaecat culpa aliqua nisi", "message": "aliquip velit" } ], "created_by": null, "last_updated_by": { "_id": "24482f602419247bfc2278bf", "provenance": "aliquip pariatur laboris qui in", "username": "consequat in Duis enim", "firstname": "sunt mollit magna", "memberOf": [ { "groupId": "4ae4116556ab735a9d9686a6", "aaaManaged": false }, { "groupId": "61c9db28dfaeba075f28bbc6", "aaaManaged": true }, { "groupId": "e765321684386f7ed383623a", "aaaManaged": true }, { "groupId": "38a4c4a8075c218db53c0894", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore exercitation proident et culpa" }, { "roleId": "ut id consectetur officia cupidatat" } ], "inactive": true, "lastLogin": "1993-12-23T07:33:25.365Z", "_meta": { "created": "1978-05-02T01:47:16.841Z", "updated": "1960-02-12T15:49:16.46Z", "migrationVersion": -51389564 }, "email": "consequat in eiusmod amet mollit" }, "tasks": { "74": { "x": 51159658.183960855, "y": 13246539.069777131, "gridCoordinate": { "x": 73589982.92112914, "y": -56934991.13029956 }, "name": "reprehenderit sed labore quis", "location": "Application", "locationType": null, "app": "occaecat", "canvasName": "anim", "displayName": "fugiat minim", "summary": "do nostrud dolor", "description": "quis enim minim laboris ullamco", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1" }, { "type": "encryption", "pointer": "/WZ8Kkqt/X1QkJgy5l/UM/cf/D6rqumicM/Z/VJAvT" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~0/~0/QL6IAK/~1/lBjG,1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "non", "highlightString": "laboris qui magna" }, { "key": "tempor ut", "highlightString": "cillum sit consequat pariatur" }, { "key": "esse mollit", "highlightString": "tempor dolore commodo cupidatat nisi" }, { "key": "in", "highlightString": "nisi aliquip eu" } ], "status": "failure", "previous": { "incomplete": [ "error_handler", "workflow_start" ], "complete": [ "workflow_start", "workflow_start" ], "error": [ "workflow_start", "error_handler", "workflow_start", "workflow_start", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "qui Excepteur ipsum laborum est", "start_time": "1969-08-24T06:57:33.282Z", "end_time": -78090791.37018387, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "c737fceb2b1c07d0490ede9c", { "_id": "d1b1985f4382359875b827f3", "provenance": "magna culpa in nisi dolore", "name": "ut", "description": "sit", "memberOf": [ { "groupId": "c3ba964b5a5ed0712a949012", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod nulla qui sit incididunt" }, { "roleId": "culpa" }, { "roleId": "tempor irure dolore pariatur" }, { "roleId": "ad" }, { "roleId": "cillum non deserunt sint" } ], "inactive": true, "_meta": { "created": "2020-12-28T15:08:02.99Z", "updated": "1947-06-14T23:34:06.752Z", "migrationVersion": -13284526 } }, "fa9dc4e878aff4fbcf5a6d2a" ], "iterations": [ "D9955d3c-90ca-5A5a-E4B9-a7aCe98CBCC8", "Ee208e86-838E-6eAd-Eca3-A97F6412EFeE" ] }, "workflow_start": { "x": 81232217.0718132, "y": 53015207.19112265, "gridCoordinate": { "x": -28106231.155497372, "y": 18835773.4912775 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 70804881.75664383, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "7000bdb43d03fcf31f471807", "d37160e794514ec8bbf18908", "default" ], "iterations": [ "350FC360-36cE-fEeD-B56A-85Cb0382B9E6" ] }, "workflow_end": { "x": -53567424.64928925, "y": -77266204.57600343, "gridCoordinate": { "x": 27127891.51437129, "y": 60782729.7039561 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "e28f", "workflow_start", "error_handler", "error_handler" ], "complete": [ "workflow_start", "error_handler", "workflow_end", "e28f", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "workflow_end", "workflow_start" ] }, "metrics": { "end_time": -40219959.496046886, "run_time": 54168280.209810644 }, "groups": [ { "_id": "a42372887ee9780f10906421", "provenance": "ad", "name": "fugiat", "description": "ullamco id", "memberOf": [ { "groupId": "a550e453780cf8c8543fd50f", "aaaManaged": true }, { "groupId": "2988ca5e9b202389fab9300b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Ut occaecat commodo culpa" }, { "roleId": "ullamco dolore occaecat dolore elit" }, { "roleId": "non" } ], "inactive": true, "_meta": { "created": "1979-08-11T05:43:51.491Z", "updated": "1992-03-06T22:17:29.607Z", "migrationVersion": -97305990 } }, "b8113f03131dacae7be91584", "default", "2dbbea180e1a56ce3411c894", "c2f8d4498669470b39183ad9" ], "iterations": [] }, "error_handler": { "x": 56925999.09049201, "y": 42124651.752447516, "gridCoordinate": { "x": -79260138.53339896, "y": -85002981.98537037 }, "name": "childJob", "location": "Application", "locationType": "adipisicing fugiat ea Duis voluptate", "app": "occaecat deserunt in", "canvasName": "deserunt commodo cillum eiusmod", "displayName": "minim consequat anim cillum cupidatat", "summary": "in", "description": "Excepteur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/OSLQVDUDlx/~1/I/GgR/~0/e/~1/~0/q0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "et consectetur", "highlightString": "ullamco eu ex proident" }, { "key": "Excepteur quis", "highlightString": "magna ipsum" }, { "key": "ad id cupidatat nisi", "highlightString": "ad esse ex reprehenderit commodo" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler", "workflow_start" ], "complete": [ "workflow_start", "workflow_end" ], "error": [ "e28f", "workflow_start", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "mollit irure aliquip dolore", "start_time": "2015-01-18T03:53:45.646Z", "end_time": 75640318.82169053, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "4ad967b92753368c7291707a", "groups": [ { "_id": "e4a9f0cce3c4ccca621612ef", "provenance": "fugiat sit adipisicing labore", "name": "incididunt ut", "description": "Duis do pariatur", "memberOf": [ { "groupId": "5c6cd0865bcaf81b6d68f0a4", "aaaManaged": true }, { "groupId": "7ac3d90ec584708b0acb185d", "aaaManaged": true }, { "groupId": "580444f73bf785da15b7b70c", "aaaManaged": false }, { "groupId": "226f973da716c7eb9e954ea3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do incididunt veniam quis" } ], "inactive": true, "_meta": { "created": "2024-11-14T14:02:52.382Z", "updated": "2000-07-16T14:29:10.959Z", "migrationVersion": 64770854 } }, "de485115fc800cc762d54b1e" ], "iterations": [ "e0Ebbb1E-D6D3-a6a7-4fae-cCeBeBdD6b81", "46810DEc-edc4-4bbC-308A-fcF3B57a2fbC" ] } }, "parent": { "job": "fugiat dolore ullamco aliqua quis", "task": "irure dolore", "iteration": 67288670.78624296, "element": 50119016.174591064 }, "errorHandler": { "x": -78921677.60129122, "y": 23076757.39472477, "gridCoordinate": { "x": -93840101.56689176, "y": -72899482.26535015 }, "name": "consectetur aliqua occaecat id Excepteur", "location": "Adapter", "locationType": "exercitation dolore", "app": "nostrud ex sed fugiat", "canvasName": "nisi id aute reprehenderit officia", "displayName": "proident", "summary": "occaecat ut proident ex dolore", "description": "nulla", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/YILkF/u7sJxs+/~0/~1/~1/G/~0/s.pZVb//vzR/vTGN1mMRqyz/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "incididunt", "highlightString": "dolor reprehenderit id" } ], "status": "incomplete", "previous": { "incomplete": [ "3a1f", "workflow_start", "workflow_end", "3a1f", "workflow_end" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_end" ], "error": [ "workflow_start", "workflow_start", "e28f", "error_handler", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "do dolor", "start_time": "2007-05-26T13:38:19.414Z", "end_time": -62374184.51131856, "finish_state": "success", "retrySettings": { "state": [ "error", "failure", "error" ], "autoRetry": true, "limit": 65850936, "delay": 89160021, "count": 15441041, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "default", "920a268bdd7d0577397a7951", "default" ], "iterations": [ "585ebAE7-521e-19CC-95FE-42c85cFd2E3D", "B8D9B5Df-eA76-1eDb-0ae7-d05dBf37de03", "38337DCF-bDD7-AccB-Ad0b-15522F7ffd3d" ] }, "groups": [ { "_id": "baf99b6796f4a328a6b83fb2", "provenance": "amet", "name": "pariatur eiusmod consequat elit occaecat", "description": "consequat non", "memberOf": [ { "groupId": "2ea656a5ea6918eaa8a6babf", "aaaManaged": true }, { "groupId": "9cbba05d1bd94d5f4719dba5", "aaaManaged": false }, { "groupId": "cabc4dd0e31f7f01e88cd9b7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum veniam ad sint" }, { "roleId": "sint" } ], "inactive": true, "_meta": { "created": "1996-02-28T21:11:58.06Z", "updated": "1994-02-04T17:41:22.406Z", "migrationVersion": -22250787 } }, "default", "e8e25e646a824999f1d4acc6", "default", "default" ], "watchers": [ null, null ], "metrics": { "start_time": 76046474.65007952, "progress": 0.44605234062128285, "end_time": -96529422.0397932, "user": null, "owner": { "_id": "e63a5affc0d918f1e0e3e396", "provenance": "esse Duis", "username": "aute", "firstname": "anim", "memberOf": [ { "groupId": "ff83d56e9675862ab9f11844", "aaaManaged": true }, { "groupId": "e4af1dd6d7809f3df41a2320", "aaaManaged": false }, { "groupId": "ef6c828183715d17cbad33bc", "aaaManaged": true }, { "groupId": "1b9ec86d35125e66a92c245f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "magna cillum" }, { "roleId": "fugiat eu" }, { "roleId": "laborum reprehenderit et" }, { "roleId": "ut aliqua do nulla" } ], "inactive": false, "lastLogin": "2007-10-17T20:48:31.737Z", "_meta": { "created": "1955-06-22T20:13:35.302Z", "updated": "1982-07-22T08:33:18.575Z", "migrationVersion": 20925258 }, "email": "aliqua" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }