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": "81854ac84147106f715ed7bb", "uuid": "a9e0ebff-97d7-60b2-6145-60ae38aed891", "font_size": 13043573, "type": "resource:compliance", "created": "1979-05-13T06:00:32.428Z", "last_updated": "2017-07-10T21:09:56.109Z", "createdVersion": "869121.62897554660.3815-0049.06250.259063590", "lastUpdatedVersion": "1.02052293586.7127857927", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 59542369, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -87976380.28682604, "sla": -63906426.4399746, "decorators": [ { "type": "encryption", "pointer": "/oW0o-h" } ], "status": "running", "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": "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_end", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "occaecat aliqua" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "adipisicing" } ], "ancestors": null, "validationErrors": [ { "keyword": "eiusmod non nostrud", "instancePath": "consequat cupidatat", "schemaPath": "nostrud", "message": "Duis" } ], "created_by": "8acc699da06c87396deab91e", "last_updated_by": { "_id": "2a678ea0d59ad2917a2277cd", "provenance": "aliquip et do eu labore", "username": "ipsum adipisicing do nulla", "firstname": "qui quis fugiat", "memberOf": [ { "groupId": "c9a5ce362624170169eefd34", "aaaManaged": false }, { "groupId": "5d1c7e6b8b87baf0c19d4166", "aaaManaged": true }, { "groupId": "f3ad5b0727cd4fc6e690f30e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem Ut culpa" }, { "roleId": "consequat elit in" } ], "inactive": false, "lastLogin": "2003-08-28T11:31:51.772Z", "_meta": { "created": "1965-04-27T14:46:48.705Z", "updated": "1950-10-02T15:19:35.163Z", "migrationVersion": 73099230 }, "email": "ea Duis" }, "tasks": { "workflow_start": { "x": -21206000.76587929, "y": -86938925.80675068, "gridCoordinate": { "x": -77035872.94145241, "y": 87315661.57043487 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 89883715.75300184, "finish_state": "failure", "user": null }, "groups": [ "914928886ea6a46ee5582c38", { "_id": "b80bcb1a5fdc16e2efb82ddc", "provenance": "tempor in enim in mollit", "name": "Ut", "description": "sed", "memberOf": [ { "groupId": "751657148fcda82aa6ecc2a5", "aaaManaged": true }, { "groupId": "bfd7cde5d1edbaced6325426", "aaaManaged": false }, { "groupId": "d8290ced0d4d2eedd363663a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "anim nisi et" } ], "inactive": true, "_meta": { "created": "1959-05-28T21:05:53.538Z", "updated": "2015-09-28T12:47:01.784Z", "migrationVersion": 3934895 } }, { "_id": "4a9fbb172bdac20be3ee1169", "provenance": "tempor", "name": "quis reprehenderit dolore eu Ut", "description": "voluptate Excepteur enim aliquip", "memberOf": [ { "groupId": "313344c14796d94ca0c9d258", "aaaManaged": true }, { "groupId": "0aaa3841f148102fa82e7306", "aaaManaged": false }, { "groupId": "ecc786d461e77f56626d7cb4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur" } ], "inactive": true, "_meta": { "created": "1997-06-10T08:15:25.091Z", "updated": "2002-10-07T02:51:11.077Z", "migrationVersion": -11019173 } } ], "iterations": [] }, "workflow_end": { "x": -32872612.382967412, "y": -65690072.51203618, "gridCoordinate": { "x": -4213853.201765612, "y": 75333701.56378081 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "3a1f" ], "complete": [ "error_handler", "e28f", "error_handler", "workflow_end" ], "error": [ "e28f", "workflow_start", "e28f", "e28f" ] }, "metrics": { "end_time": 49700001.609777, "run_time": -82514464.1328547 }, "groups": [ "4f6b25bfb2daeaf7da02ad6c", { "_id": "48b56136088d7524ff2d66b6", "provenance": "eiusmod labore", "name": "sunt nulla Excepteur", "description": "ex", "memberOf": [ { "groupId": "c227f2742702017daacc71ad", "aaaManaged": false }, { "groupId": "4077f44261dc97579ffc4632", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation veniam sunt Duis commodo" } ], "inactive": false, "_meta": { "created": "1973-06-12T00:48:30.971Z", "updated": "1994-05-21T11:51:19.016Z", "migrationVersion": 53203560 } }, "f053f7604938510ac1b6b6fa" ], "iterations": [ "Bddf42FA-06bD-fa0C-fEc3-DaCEB2f99A00", "6B22CE7a-4B58-e3FB-65D3-cfBB5089F594", "B9dCA835-bC4d-f4A4-cF9E-4f3f11e08D82" ] }, "error_handler": { "x": -58698508.316987395, "y": -14269107.306587443, "gridCoordinate": { "x": 65510648.61426875, "y": -11128683.95554316 }, "name": "childJob", "location": "Application", "locationType": null, "app": "Excepteur consectetur", "canvasName": "non aliquip cupidatat aute", "displayName": "officia", "summary": "laboris sed", "description": "aliquip ullamco aute in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ullamco nisi", "highlightString": "ad in sunt est" }, { "key": "dolore", "highlightString": "velit ipsum non" } ], "status": "error", "previous": { "incomplete": [ "workflow_end", "error_handler", "3a1f", "e28f" ], "complete": [ "e28f" ], "error": [ "3a1f", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "voluptate ipsum laborum", "start_time": "1957-04-03T06:51:16.644Z", "end_time": 66072511.35403317, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": null, "groups": [ { "_id": "d33dfee701532fb39f98f3ce", "provenance": "laborum commodo Lorem ad", "name": "laboris in irure minim", "description": "aute dolore ipsum", "memberOf": [ { "groupId": "1cc6538bd2dc2be6d885ab14", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua" }, { "roleId": "do non" }, { "roleId": "ut adipisicing ut nulla do" }, { "roleId": "esse" }, { "roleId": "dolor Lorem" } ], "inactive": true, "_meta": { "created": "1992-07-06T03:35:45.402Z", "updated": "1993-04-03T15:21:36.995Z", "migrationVersion": 53126187 } }, { "_id": "4cb2e9e35354d5eab7b3fae5", "provenance": "Lorem adipisicing pariatur in ad", "name": "id sed qui ullamco pariatur", "description": "in Duis velit officia dolor", "memberOf": [ { "groupId": "f8ccdf7d671a37da3674dc75", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut ex dolor eiusmod aute" }, { "roleId": "consequat aute velit esse Duis" }, { "roleId": "Ut dolore" } ], "inactive": true, "_meta": { "created": "2006-04-27T00:27:51.688Z", "updated": "1975-02-10T05:32:03.914Z", "migrationVersion": 36968498 } }, "default", { "_id": "fee651716c8d1a94cd37bfb4", "provenance": "et nostrud laborum proident", "name": "nisi Ut", "description": "amet eiusmod deserunt esse exercitation", "memberOf": [ { "groupId": "942e68e445ab6067eac5e150", "aaaManaged": false }, { "groupId": "27bb23a3322068c0eb512d40", "aaaManaged": true }, { "groupId": "087e21b3772e5a5e3ff4bd62", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur amet in aliqua" }, { "roleId": "consectetur consequat in adipisicing sint" }, { "roleId": "sed nostrud fugiat" }, { "roleId": "qui Ut sit in pariatur" }, { "roleId": "consectetur" } ], "inactive": true, "_meta": { "created": "2009-02-20T17:58:04.648Z", "updated": "1958-09-27T09:06:00.067Z", "migrationVersion": -65642935 } } ], "iterations": [ "Ebac502d-e4F0-7B5e-AAd7-32eFCc3BcdA2", "c0327D84-8DE4-eC40-E818-E8df3De1Cf13" ] }, "58e": { "actor": "job", "groups": [ { "_id": "7b76ee0dc98ece40383c93e8", "provenance": "in fugiat labore", "name": "Ut ipsum eu ut", "description": "dolor Lorem sunt eu aliqua", "memberOf": [ { "groupId": "6aac50e2320999bc1d46c328", "aaaManaged": true }, { "groupId": "e96a424e716ce512ffbaedeb", "aaaManaged": true }, { "groupId": "7ec69a9326216c1c1b596dd1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit laborum nulla aliquip ullamco" }, { "roleId": "et sed veniam" }, { "roleId": "culpa dolore Duis" } ], "inactive": true, "_meta": { "created": "1982-04-29T03:44:06.942Z", "updated": "1959-02-25T03:38:17.659Z", "migrationVersion": 38833426 } }, { "_id": "fdd59ced73403a51fa7877c6", "provenance": "commodo", "name": "aliqua cillum pariatur occaecat", "description": "non in", "memberOf": [ { "groupId": "3b22f41cfab1b738eb52bdd1", "aaaManaged": false }, { "groupId": "4a0984a48d8c1ebf0fac88fa", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor" } ], "inactive": false, "_meta": { "created": "1991-10-07T12:17:32.729Z", "updated": "1998-07-02T14:51:59.787Z", "migrationVersion": -15178720 } }, "default" ], "iterations": [ "0CC25432-f71d-4ff4-0a2E-2EAe9ACeB313", "194B3B8B-bC01-B6e7-A8CB-E2fBbbaf5aE7" ], "x": -51773225.25684853, "y": 73857634.6582596, "gridCoordinate": { "x": -27252625.75566764, "y": 48016350.946008325 }, "name": "do est nulla", "location": "Adapter", "locationType": null, "app": "ipsum sint aute esse", "canvasName": "childJob", "displayName": "laborum dolore ut", "summary": "elit incididunt Lorem ex", "description": "proident velit ea", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/EAXZO" }, { "type": "encryption", "pointer": "/Zj58jF" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "non do pariatur et", "highlightString": "laborum dolore ad dolor Duis" }, { "key": "magna dolore adipisicing", "highlightString": "laboris veniam" }, { "key": "qui consectetur", "highlightString": "dolor velit dolore" }, { "key": "officia ut in Ut", "highlightString": "sint ullamco" } ], "status": "running", "previous": { "incomplete": [ "3a1f" ], "complete": [ "e28f", "error_handler" ], "error": [ "error_handler", "error_handler", "workflow_start", "workflow_end" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "eiusmod enim", "start_time": "2002-01-20T01:30:11.916Z", "end_time": -42189420.18082643, "finish_state": "success", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": 28581976.986440122, "outgoing": [] }, "childJobs": [ { "_id": "Duis esse laboris reprehenderit", "name": "est", "iteration": 2655393.8615647703 }, { "_id": "Lorem", "name": "officia est exercitation proident qui", "iteration": -4751565.635007322 }, { "_id": "nostrud proident irure tempor", "name": "labore non", "iteration": 60062357.785951674 } ] } }, "parent": { "job": "magna Excepteur", "task": "ad occaecat veniam nisi velit", "iteration": 43644524.47365555, "element": -81478970.73583627 }, "errorHandler": { "actor": "job", "groups": [ "default", "default" ], "iterations": [ "52Ac4DC7-A96D-fF72-FE08-40F0030F4c0c" ], "x": 61712686.79271966, "y": -38294974.613438934, "gridCoordinate": { "x": 83384704.6502327, "y": -89599388.73595221 }, "name": "ut proident laboris amet velit", "location": "Adapter", "locationType": "ut pariatur aliquip cupidatat", "app": "aliqua qui do dolor", "canvasName": "childJob", "displayName": "exercitation Lorem aliquip tempor culpa", "summary": "velit ipsum minim non aute", "description": "pariatur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/A6/u2Qiz/~1/Zq4jhgoLSqM/~0/~1/nuG/xPawth/~0" }, { "type": "encryption", "pointer": "/Bh/I/X4/~1/qM/iwzWM0M/~0/xA684v7/kv/UL3UVH6bDZg" }, { "type": "encryption", "pointer": "/~1/~1/H0v3ayvo/wpXdm/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "consequat laboris esse officia", "highlightString": "eu eiusmod" }, { "key": "non", "highlightString": "veniam in proident" }, { "key": "sunt", "highlightString": "dolor mollit adipisicing" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "error_handler", "3a1f" ], "error": [ "e28f", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "adipisicing occaecat dolor", "start_time": "2001-12-14T05:39:18.772Z", "end_time": 58202056.58158645, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": false, "finishedCount": 73708840.48479503, "outgoing": [] }, "childJobs": [ { "_id": "amet sint", "name": "elit mollit est velit", "iteration": 97632371.50087342 }, { "_id": "eiusmod", "name": "incididunt", "iteration": -6555126.186268717 } ] }, "groups": [ "cac858cb89f54dabf29ca450", "a235e3703410b382a3defa2f", { "_id": "6d86fabbd8f3e3fe274ef5ff", "provenance": "laboris", "name": "in nisi nostrud", "description": "commodo velit ea in", "memberOf": [ { "groupId": "b4f8c83904ae84a6c523dcbc", "aaaManaged": false }, { "groupId": "feda1ab2c4bb0f547408610c", "aaaManaged": false }, { "groupId": "49bbbd5fe955c9ea4c474320", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut aliqua amet proident" }, { "roleId": "enim cupidatat Excepteur magna qui" }, { "roleId": "tempor eu aliqua quis eiusmod" } ], "inactive": true, "_meta": { "created": "1963-06-09T00:32:01.548Z", "updated": "1955-09-03T06:48:00.784Z", "migrationVersion": -42988266 } } ], "watchers": [ null, null, "Pronghorn", "Pronghorn" ], "metrics": { "start_time": -8775339.275921285, "progress": 0.7443562744160712, "end_time": 14845784.87382096, "user": { "_id": "c46d6c529091f4403a0195ef", "provenance": "aute elit est", "username": "dolore aliqua", "firstname": "labore voluptate ex", "memberOf": [ { "groupId": "3ac4bf72089b6c330a286a76", "aaaManaged": false }, { "groupId": "3e819ed8ab9877c8f91ebb84", "aaaManaged": true }, { "groupId": "fe0280353786e8e9d9239ffd", "aaaManaged": true }, { "groupId": "4ba8e37d31d391ad149ed2d6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat est magna in pariatur" }, { "roleId": "cupidatat consequat eiusmod velit ex" }, { "roleId": "in consequat qui" }, { "roleId": "in pariatur aute consequat in" }, { "roleId": "do ea cillum exercitation officia" } ], "inactive": false, "lastLogin": "1963-03-09T19:27:57.583Z", "_meta": { "created": "2004-12-28T00:51:14.178Z", "updated": "1966-04-27T18:24:48.745Z", "migrationVersion": 54964596 }, "email": "qui aliqua enim commodo minim" }, "owner": "16a7dd162af543dd17e0fe69" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }