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 created the requested item", "data": { "_id": "d60b5ee1118875b190c80896", "font_size": 15007050, "type": "resource:action", "created": "1974-12-22T08:29:50.227Z", "last_updated": "1991-08-09T00:42:31.989Z", "createdVersion": "7.840.2870", "lastUpdatedVersion": "5.9.5808-1152.855.822993", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 65076087, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -52395917.35335063, "sla": 23907516.370786875, "decorators": [ { "type": "encryption", "pointer": "/y4mzU+PC1rf/S/rx1Tqwdu9h" }, { "type": "encryption", "pointer": "/~0" } ], "status": "paused", "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "officia incididunt dolor anim" } ], "ancestors": null, "validationErrors": [ { "keyword": "dolore nisi", "instancePath": "ut", "schemaPath": "commodo ex", "message": "qui tempor aliqua esse" }, { "keyword": "fugiat", "instancePath": "Excepteur ut eu anim", "schemaPath": "esse eu ullamco ut", "message": "id do esse aliqua culpa" }, { "keyword": "sunt Duis eu adipisicing quis", "instancePath": "nisi", "schemaPath": "labore", "message": "reprehenderit sint ipsum est sit" } ], "created_by": null, "last_updated_by": null, "tasks": { "9": { "actor": "job", "groups": [ { "_id": "4574e921f4d71043ffa7ade2", "provenance": "incididunt cupidatat nulla labore sint", "name": "ut mollit commodo est enim", "description": "in", "memberOf": [ { "groupId": "70d90d0e619c6ff7c064f5d0", "aaaManaged": false }, { "groupId": "4acbb87e774b332909cb7f24", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse sunt enim" }, { "roleId": "quis" }, { "roleId": "qui ad" }, { "roleId": "officia non in mollit commodo" } ], "inactive": false, "_meta": { "created": "2018-05-03T09:21:28.524Z", "updated": "1969-10-27T12:41:49.726Z", "migrationVersion": 19268632 } }, "a04bf1c8bd41c1df50995771" ], "iterations": [ "EBFaaaA3-Ad18-6E48-fbC7-3966Dc8FD1C0", "6240c0EF-9A7b-83cd-B5F2-970eacB45CE9" ], "x": 70487318.3704406, "y": -17853498.483498648, "gridCoordinate": { "x": 88309237.92079946, "y": -29333215.231685728 }, "name": "pending", "summary": "cupidatat in", "description": "sit sunt qui" }, "workflow_start": { "x": 51545006.18439427, "y": 58773132.241888076, "gridCoordinate": { "x": -93759934.42994174, "y": -6573494.402361214 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -82067228.18886782, "finish_state": "error", "user": { "_id": "95ef3453c51d09d0d1cf0eb2", "provenance": "nulla est", "username": "fugiat aliquip aute culpa in", "firstname": "sunt ea cillum", "memberOf": [ { "groupId": "dac0308ed5e874709620fbfe", "aaaManaged": true }, { "groupId": "8e2d846e291038bb40737c83", "aaaManaged": true }, { "groupId": "5f1d0dfcfb7ea286bfc680a1", "aaaManaged": false }, { "groupId": "a6e35294409c7c918b39cef8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum sint dolor" }, { "roleId": "non sit proident Duis eu" }, { "roleId": "minim" }, { "roleId": "tempor incididunt do in mollit" } ], "inactive": true, "lastLogin": "1995-09-04T04:20:13.045Z", "_meta": { "created": "2011-08-01T02:09:08.322Z", "updated": "1960-08-26T03:23:23.204Z", "migrationVersion": 10920235 }, "email": "in est non amet incididunt" } }, "groups": [ { "_id": "dd2257fa747bcfb43621d912", "provenance": "commodo sed occaecat", "name": "dolor", "description": "esse ad dolor pariatur do", "memberOf": [ { "groupId": "f57e2534b4902ce58d968dda", "aaaManaged": false }, { "groupId": "36883acb8a3069c17a8efc20", "aaaManaged": true }, { "groupId": "0dee816d2a9d33f9c9352c5c", "aaaManaged": false }, { "groupId": "77f28368b408d1566c1977a9", "aaaManaged": true }, { "groupId": "2de1f0422a81424c2d3fe061", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua" } ], "inactive": true, "_meta": { "created": "1985-11-13T23:12:27.198Z", "updated": "1958-02-01T06:14:47.636Z", "migrationVersion": 9634405 } }, { "_id": "a8eae0fccc3bd00b60df47e2", "provenance": "consequat minim veniam ad", "name": "et cillum nostrud nisi", "description": "aliquip consectetur Ut sit", "memberOf": [ { "groupId": "d2900f6f259f1be8669131c1", "aaaManaged": true }, { "groupId": "a63c8804334fa9dc1f3cb354", "aaaManaged": false }, { "groupId": "627b99d0587703502b038e61", "aaaManaged": false }, { "groupId": "5672367a5a1f3b9358c2fc90", "aaaManaged": false }, { "groupId": "02f8c15d379837ddf688dd83", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum velit anim aliquip Lorem" }, { "roleId": "velit ipsum enim" }, { "roleId": "dolore" } ], "inactive": false, "_meta": { "created": "1970-03-11T02:18:37.589Z", "updated": "1999-01-18T06:02:59.276Z", "migrationVersion": -5904849 } } ], "iterations": [] }, "workflow_end": { "x": 94340913.5377765, "y": -87512558.18831098, "gridCoordinate": { "x": 8733867.357287958, "y": 71489143.85561463 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler" ], "complete": [ "workflow_start", "3a1f", "workflow_start", "workflow_end", "e28f" ], "error": [ "3a1f", "workflow_start" ] }, "metrics": { "end_time": 39466645.2903679, "run_time": 23574978.927722648 }, "groups": [ "default", { "_id": "f288146206a353f2ac8d18ab", "provenance": "velit laboris", "name": "reprehenderit mollit aliqua", "description": "labore exercitation adipisicing elit", "memberOf": [ { "groupId": "7537516a1191431fbb37efd9", "aaaManaged": false }, { "groupId": "a0625b73ea72d58b1a59e74c", "aaaManaged": true }, { "groupId": "ff01e61332570a955d36a3cb", "aaaManaged": true }, { "groupId": "f85d47a3d3d9369985f5c89c", "aaaManaged": false }, { "groupId": "541ce3fb9624335b96556fbf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in sint enim cillum Lorem" }, { "roleId": "cupidatat" }, { "roleId": "anim officia mollit" } ], "inactive": false, "_meta": { "created": "1956-04-21T00:25:11.479Z", "updated": "1972-04-11T23:23:34.996Z", "migrationVersion": -29388391 } }, "default", "default" ], "iterations": [ "Ec98Cd9f-33cf-b1A9-E18B-aC441f29aDE6", "71db46AA-5F8a-BC13-B2D7-95b554Ab19Ab" ] }, "error_handler": { "x": 33243220.1158202, "y": 81519217.26252785, "gridCoordinate": { "x": -54669414.602216415, "y": 86863967.94430578 }, "name": "childJob", "location": "Application", "locationType": "dolore commodo qui", "app": "dolore in dolore laborum sint", "canvasName": "in dolore commodo", "displayName": "nisi irure", "summary": "do reprehenderit", "description": "cupidatat dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/fcx/uq2V/~0/K.KHH5/~1/Ok68CEI/v" }, { "type": "encryption", "pointer": "/~1/MRNzPgFt-0/~1/G/~1/~0" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~0/RQkb/UFfvL0GS8aB/bfM/~1/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "cillum eiusmod velit occaecat Excepteur", "highlightString": "deserunt Duis enim irure" } ], "status": "complete", "previous": { "incomplete": [ "e28f", "error_handler", "workflow_end", "3a1f" ], "complete": [ "workflow_start", "workflow_start", "3a1f", "workflow_start" ], "error": [ "workflow_start", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "revert" } ] }, "serverId": "proident sint magna incididunt labore", "start_time": "1990-04-01T12:13:13.701Z", "end_time": -84788981.11314565, "finish_state": "failure", "retrySettings": { "state": [ "success", "success", "success" ], "autoRetry": true, "limit": 24691719, "delay": 42483694, "count": 80105876, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "0a2ca22443d22a875d08b70d", "provenance": "in occaecat in Duis velit", "name": "dolore adipisicing magna", "description": "Excepteur eiusmod ut et enim", "memberOf": [ { "groupId": "912517cb5f70cdc61848045e", "aaaManaged": false }, { "groupId": "8c4f2af22fc5ec1d216e4949", "aaaManaged": false }, { "groupId": "e4f0173c79333fde70998350", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip commodo ea fugiat in" }, { "roleId": "aute nisi quis fugiat esse" }, { "roleId": "irure et cupidatat ut" } ], "inactive": false, "_meta": { "created": "2015-12-21T04:40:41.912Z", "updated": "1960-02-22T15:15:33.957Z", "migrationVersion": -97480243 } }, "default" ], "iterations": [ "D2cfCeB7-Bcad-a2D2-74EB-33499899bc1f" ] } }, "parent": { "job": "proident consequat mollit aliquip", "task": "eiusmod proident esse", "iteration": 56495494.83162776, "element": 46672057.561455786 }, "errorHandler": null, "groups": [ { "_id": "27fc874032922e99c5951ebe", "provenance": "quis non irure", "name": "dolore consectetur culpa laborum enim", "description": "cupidatat sit commodo enim", "memberOf": [ { "groupId": "8ce514d71b9057b3da873425", "aaaManaged": false }, { "groupId": "ccb31a0702401d019ad4f78a", "aaaManaged": true }, { "groupId": "127de3fddf340e28ead4a9f4", "aaaManaged": false }, { "groupId": "a46ad089546fb9df671db475", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliquip in in dolor enim" }, { "roleId": "occaecat" }, { "roleId": "dolore Duis" }, { "roleId": "nulla adipisicing enim elit Excepteur" }, { "roleId": "aliquip sed reprehenderit esse" } ], "inactive": false, "_meta": { "created": "2022-04-21T21:00:24.476Z", "updated": "2009-02-19T00:43:58.332Z", "migrationVersion": 19279493 } }, { "_id": "887d72297d28502e51291ce4", "provenance": "sed dolor", "name": "et elit fugiat esse laboris", "description": "amet ex", "memberOf": [ { "groupId": "754745f24830a9f3e1c65fb8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris qui et" }, { "roleId": "aliqua" }, { "roleId": "sunt dolor id labore laborum" }, { "roleId": "est incididunt" }, { "roleId": "commodo et in" } ], "inactive": false, "_meta": { "created": "1979-01-07T13:10:01.887Z", "updated": "2006-05-29T01:40:09.54Z", "migrationVersion": -77176773 } }, { "_id": "196ed44673fb8f0f74d8113f", "provenance": "labore sed", "name": "reprehenderit Duis", "description": "laboris consequat reprehenderit dolor", "memberOf": [ { "groupId": "fa76bec1e040906c7824cd7a", "aaaManaged": false }, { "groupId": "ad26fb7aca6f5ae646d0ac5d", "aaaManaged": false }, { "groupId": "34bc76c054147228567fb7d5", "aaaManaged": false }, { "groupId": "57eb7a4ac19e530f58fcccf9", "aaaManaged": true }, { "groupId": "374a47506c7b84963ce6240f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "id Duis esse in quis" }, { "roleId": "magna cupidatat incididunt esse Duis" }, { "roleId": "commodo adipisicing dolore eu" }, { "roleId": "culpa Lorem occaecat nostrud" } ], "inactive": true, "_meta": { "created": "2015-10-21T22:40:53.992Z", "updated": "1976-11-04T09:38:01.997Z", "migrationVersion": 258183 } }, { "_id": "1f2ef94e0da37c41321a4f7b", "provenance": "sunt tempor pariatur culpa", "name": "Excepteur Ut", "description": "exercitation in dolor laboris", "memberOf": [ { "groupId": "d48e7b8efa7c3bfd1b9102ae", "aaaManaged": false }, { "groupId": "b96c47c2d19d5d61bef537d3", "aaaManaged": false }, { "groupId": "a46a1e6ec9320c742f33a4da", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat enim exercitation" }, { "roleId": "ipsum dolore eu" }, { "roleId": "sit dolore aliqua veniam commodo" }, { "roleId": "laboris ea amet" } ], "inactive": true, "_meta": { "created": "1967-08-05T14:11:34.66Z", "updated": "1968-10-08T12:59:31.578Z", "migrationVersion": 79135510 } }, { "_id": "18b970efbbc9e0e7955e72b7", "provenance": "ut sit sunt mollit", "name": "sunt", "description": "consectetur occaecat quis nostrud officia", "memberOf": [ { "groupId": "47197a223ce4d03791f9eb96", "aaaManaged": true }, { "groupId": "786fc6b1283e0a20053f0368", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia" }, { "roleId": "exercitation elit laborum" }, { "roleId": "ex nostrud" } ], "inactive": true, "_meta": { "created": "1990-11-21T16:57:36.189Z", "updated": "1974-05-13T10:44:03.366Z", "migrationVersion": 43570696 } } ], "watchers": [ { "_id": "5cba7945a48b660bc8fbc1e2", "provenance": "qui quis", "username": "fugiat voluptate minim labore occaecat", "firstname": "consectetur dolore nulla", "memberOf": [ { "groupId": "47902850ff966f745cfe380b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla sint amet" }, { "roleId": "laboris in Excepteur aliquip" } ], "inactive": false, "lastLogin": "1945-07-17T16:54:15.389Z", "_meta": { "created": "1948-04-23T06:22:40.185Z", "updated": "1996-06-12T07:53:41.9Z", "migrationVersion": -81329505 }, "email": "dolor do deserunt magna" }, "9f72180bebec6585ac800a66", "7a0ea88ce6d86c0b7352245d" ], "metrics": { "start_time": 94424100.84897798, "progress": 0.9100325569143934, "end_time": 89049459.23006457, "user": null, "owner": "64b623a1e93b3b3e61206033" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }