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": "2af440b1d9b28c1d80a52553", "font_size": 2378712, "type": "resource:action", "created": "2017-08-29T03:44:21.12Z", "last_updated": "1985-11-17T05:11:48.105Z", "createdVersion": "89057.562.6775", "lastUpdatedVersion": "830893791.8888369.3-2439.95495.2.4", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -53767171, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -86646991.71526253, "sla": -22161571.651147187, "decorators": [ { "type": "encryption", "pointer": "/AhY,,OA,xH" }, { "type": "encryption", "pointer": "/Xjs/~1/FTuf,/R/~0/~1/~1/R/~1/~1" }, { "type": "encryption", "pointer": "/~1/e/~0/Z5qawnMg/U/Fz3HT2X" }, { "type": "encryption", "pointer": "/~0/~1/YN/~0/~1/~1/~0/fnmXx-c/~1/~1/yci9yVZGC" }, { "type": "encryption", "pointer": "/ueSD,tzcL/T" } ], "status": "complete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "nulla Excepteur ea sint" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "aliquip Excepteur exercitation", "dataPath": "officia exercitation adipisicing in", "schemaPath": "sunt veniam laboris Excepteur", "message": "nostrud laborum et" }, { "keyword": "non officia", "dataPath": "non", "schemaPath": "do", "message": "dolore eiusmod" }, { "keyword": "commodo fugiat laboris", "dataPath": "dolor est occaecat pariatur", "schemaPath": "ex sit nostrud enim dolore", "message": "occaecat consectetur nisi dolor Duis" }, { "keyword": "incididunt aute consequat velit esse", "dataPath": "quis anim", "schemaPath": "magna consectetur aliquip", "message": "est nostrud laboris voluptate fugiat" }, { "keyword": "Lorem pariatur sed ex", "dataPath": "adipisicing", "schemaPath": "enim", "message": "Lorem dolore dolor est" } ], "created_by": "b640cee527cff6d1daaf51a0", "last_updated_by": { "_id": "3bd2866f89081034c450297a", "provenance": "ipsum", "username": "incididunt laboris esse voluptate officia", "firstname": "veniam qui", "memberOf": [ { "groupId": "ae2c4b9a420e4fc0872d8af2", "aaaManaged": true }, { "groupId": "458378761649d4df3bf05f43", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in commodo consectetur occaecat reprehenderit" }, { "roleId": "reprehenderit" }, { "roleId": "ex pariatur" } ], "inactive": true, "lastLogin": "2002-01-02T03:18:54.012Z", "_meta": { "created": "2013-03-08T18:55:54.451Z", "updated": "2006-12-28T10:29:11.814Z", "migrationVersion": -53980904 }, "email": "non quis" }, "tasks": { "workflow_start": { "x": 77860979.13576218, "y": -79928788.70277193, "gridCoordinate": { "x": -77328538.47216408, "y": 81049242.127648 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -87624612.92537558, "finish_state": "success", "user": "d5497013636704e092814820" }, "groups": [ { "_id": "b4945da9b0ed58e395dedb35", "provenance": "ipsum", "name": "elit incididunt qui", "description": "cupidatat ad elit", "memberOf": [ { "groupId": "617aea2911fcc3b4174b6aae", "aaaManaged": true }, { "groupId": "a5a98dccd681337518222718", "aaaManaged": false }, { "groupId": "fc41aa068e639c48481356a0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem" }, { "roleId": "nisi velit Excepteur in non" } ], "inactive": false, "_meta": { "created": "1988-03-19T11:29:05.145Z", "updated": "1986-10-05T04:41:12.454Z", "migrationVersion": -92635823 } }, "default", { "_id": "56365fa9d8281229aba1cf7c", "provenance": "magna ut in", "name": "est aliquip", "description": "officia est", "memberOf": [ { "groupId": "586a8d27e548c1394b42b68d", "aaaManaged": true }, { "groupId": "f74de481c120f071bad299c9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis tempor" }, { "roleId": "proident reprehenderit in minim" }, { "roleId": "Duis dolor tempor" }, { "roleId": "in" } ], "inactive": false, "_meta": { "created": "2002-03-09T14:30:08.857Z", "updated": "1958-01-29T19:25:54.459Z", "migrationVersion": -21142797 } }, "d6e99f51b81a7c39f5d93f83", { "_id": "24559c1ad0211108703f83f9", "provenance": "Excepteur", "name": "cillum dolore in magna", "description": "consectetur", "memberOf": [ { "groupId": "5652486ac1cd51eb82978249", "aaaManaged": true }, { "groupId": "30e3ab18e9b95f802263db2e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor magna" }, { "roleId": "dolore sit ad esse consectetur" }, { "roleId": "ipsum non magna" } ], "inactive": false, "_meta": { "created": "1984-05-17T02:19:37.124Z", "updated": "1979-04-28T15:32:09.67Z", "migrationVersion": -71780376 } } ], "iterations": [ "5bD3bd2a-117e-67AF-Ee55-7838a2a7820A", "8D7bfEd1-9c5B-42Bf-1657-a3EA9A2B1579" ] }, "workflow_end": { "x": 78414553.11042607, "y": 39419372.28841931, "gridCoordinate": { "x": 77675446.8260521, "y": 92991682.87532026 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_end", "workflow_end", "3a1f", "workflow_end", "error_handler" ], "error": [ "error_handler", "workflow_start", "error_handler", "3a1f" ] }, "metrics": { "end_time": 61134283.49516016, "run_time": -34945084.33842163 }, "groups": [ "2963d84dfa01d5432523b840", "default", "default" ], "iterations": [] }, "error_handler": { "x": -89889433.13118796, "y": -80230515.55733396, "gridCoordinate": { "x": 15880230.367346078, "y": 3269114.5672735423 }, "name": "childJob", "location": "Adapter", "locationType": "amet in aute irure", "app": "id", "canvasName": "minim nostrud", "displayName": "exercitation incididunt ex esse laborum", "summary": "anim dolor proident", "description": "adipisicing ex in aute est", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/NXquX" }, { "type": "encryption", "pointer": "/~1/~1/~1/eGkDeHov/ZCpy/gD,DI5w/X6/zPF/~1/v/.i,,9qYYl/OA5J1w2wZH" }, { "type": "encryption", "pointer": "/N/CP.H" }, { "type": "encryption", "pointer": "/~1/gXp/vQepn/LZOteTo/yu/fp5Z/~0/~1/Vq/~1/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "occaecat", "highlightString": "aliquip est" }, { "key": "velit dolor ut sit consequat", "highlightString": "occaecat laborum" }, { "key": "esse non deserunt sed", "highlightString": "est tempor" }, { "key": "voluptate", "highlightString": "nostrud ut proident" } ], "status": "running", "previous": { "incomplete": [ "workflow_end", "workflow_end", "workflow_start" ], "complete": [ "error_handler" ], "error": [ "3a1f", "workflow_end", "workflow_end", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "magna labore do", "start_time": "1970-07-20T17:50:27.652Z", "end_time": 42680368.34108502, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "f75b53b1183cc8800bf212d0", "provenance": "voluptate labore ad", "name": "ex amet Lorem", "description": "ut proident do irure laboris", "memberOf": [ { "groupId": "6059808224205983de867a0e", "aaaManaged": true }, { "groupId": "83ad3b7a75c71189902d8212", "aaaManaged": false }, { "groupId": "ae8fa79b1d15f963748e288f", "aaaManaged": true }, { "groupId": "dfbdd55cf1af481140bf738b", "aaaManaged": false }, { "groupId": "09c08b56a1960098465d4355", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sint labore voluptate" }, { "roleId": "Lorem aute" }, { "roleId": "aute" }, { "roleId": "est Ut culpa nisi" } ], "inactive": false, "_meta": { "created": "1990-11-21T11:52:27.503Z", "updated": "2003-01-22T21:48:07.519Z", "migrationVersion": -83626311 } }, { "_id": "58fa2c58e94da320d98024e1", "provenance": "quis cillum sunt pariatur tempor", "name": "tempor", "description": "ut id aliqua occaecat", "memberOf": [ { "groupId": "b6b076c4caa96a2819058629", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit nisi non" }, { "roleId": "dolore id fugiat" }, { "roleId": "qui sed tempor" }, { "roleId": "Duis veniam" } ], "inactive": true, "_meta": { "created": "1984-10-06T00:15:08.233Z", "updated": "1947-10-23T06:13:02.826Z", "migrationVersion": 10617303 } }, { "_id": "296860fdee88aca4d6713b15", "provenance": "magna aliquip consequat", "name": "minim exercitation", "description": "ullamco exercitation", "memberOf": [ { "groupId": "6b5b0e9287aa022caa71794b", "aaaManaged": true }, { "groupId": "4f20f15f62e3870119811719", "aaaManaged": false }, { "groupId": "ca9f4ef481f9385f34986c2a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor quis aliquip irure sint" }, { "roleId": "tempor sed consectetur laborum" }, { "roleId": "voluptate velit dolor qui" } ], "inactive": true, "_meta": { "created": "1972-10-22T05:48:06.21Z", "updated": "1995-08-20T18:37:37.072Z", "migrationVersion": 3196775 } }, "default", "213b1b1f8e520b3d0ee64990" ], "iterations": [ "bffAd2DB-a499-d7D3-A59C-Ac9fDefB652a", "d2661AE4-6508-4071-50DF-9E7E924CFedf", "bD5aBae9-ddFf-84f9-1ae1-B5bF38DEF8aF" ] }, "fb": { "actor": null, "groups": [ "default", "default" ], "iterations": [ "27ABe7B1-6036-5F67-0767-0Ceec1221680", "635c5B4a-8F85-0F0A-A994-ea097F1E4f2d" ], "x": -63346571.300066404, "y": 41512580.89616495, "gridCoordinate": { "x": -40587330.50429249, "y": -80063684.02398479 }, "name": "officia eiusmod non dolor laborum", "location": "Adapter", "locationType": "veniam aliquip", "app": "amet exercitation sit aliquip", "canvasName": "childJob", "displayName": "proident Ut occaecat", "summary": "dolor id ut", "description": "dolore sint anim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/UtBKly7n70/L/X/SExOr1GzS/mH96lD3rnr/~0/~1/UVz4FgcZb7/mbLp-/~1/PIGE.FWl" }, { "type": "encryption", "pointer": "/~0/~0/AqOu4h3B/d/~0/~1/~0/Vl" }, { "type": "encryption", "pointer": "/d5Mzwv/lqri/~1/~0/HFf/~0/~1/~0/~1/AWQ/Akw6" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "non ipsum esse ullamco laboris", "highlightString": "do pariatur anim dolore" }, { "key": "fugiat enim ullamco veniam", "highlightString": "minim labore" }, { "key": "sed id in pariatur", "highlightString": "nisi dolore Excepteur" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start", "workflow_end" ], "complete": [ "e28f", "3a1f" ], "error": [ "error_handler", "e28f", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "nisi amet esse", "start_time": "1980-04-05T23:49:43.715Z", "end_time": 89494383.08062145, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -59271532.90068823, "outgoing": [ null, null, null ] }, "childJobs": [ { "_id": "Excepteur enim ut aliqua quis", "name": "deserunt non veniam", "iteration": 67882702.52660426 }, { "_id": "Excepteur labore nisi", "name": "pariatur enim est Duis", "iteration": -73356103.38978644 }, { "_id": "nulla mollit cillum magna", "name": "adipisicing ea deserunt", "iteration": -57882812.36830182 } ] } }, "parent": { "task": "ut voluptate", "iteration": -95367712.83335401, "element": 1821706.5208398104 }, "errorHandler": { "actor": "job", "groups": [ "79305cb1d5504b7f2b7ea2d4", { "_id": "71caa05c016f1b45a96db517", "provenance": "esse in et", "name": "deserunt commodo in nisi exercitation", "description": "commodo Lorem", "memberOf": [ { "groupId": "29bcad930b6d2a182a4146f7", "aaaManaged": false }, { "groupId": "46ad49c82015991efbd89bf5", "aaaManaged": true }, { "groupId": "31b62db4d45de44c798d1e77", "aaaManaged": false }, { "groupId": "6b571bee20a62db2265bddf9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit ullamco dolore Excepteur cillum" }, { "roleId": "in" } ], "inactive": true, "_meta": { "created": "1984-12-16T13:54:54.672Z", "updated": "2021-12-01T12:13:27.167Z", "migrationVersion": 8773613 } }, "8202e8f1c2ce8f0b5cd80ecd", "824deda94a920ab4efd59d7d" ], "iterations": [ "8c61EF34-DB35-A1c5-593e-3df8eAfdE020", "6CCcAd2D-B30b-Dac8-aACE-5C0499F86638", "f8EeEC1f-A883-c9aE-aaD5-d8c03e75Da0d", "06fDEECf-aBaf-Af60-4206-F3bBecbFE0a5" ], "x": -17875638.370591894, "y": -77187849.62858787, "gridCoordinate": { "x": -27249489.03534758, "y": 88901419.45453566 }, "name": "Lorem Excepteur cillum elit", "location": "Broker", "locationType": null, "app": "eiusmod", "canvasName": "childJob", "displayName": "consectetur ea anim Excepteur nulla", "summary": "sint minim occaecat consectetur", "description": "ullamco in ad in commodo", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/eYxp/agQ/~1/a/DDma/Eq8jokF9bok/JpDCy-" }, { "type": "encryption", "pointer": "/LKU/~1/~0/~0/~0/ZjE/9gRtzn8" }, { "type": "encryption", "pointer": "/~1/E,/~1/~1/QBj3myiF/mtQSXiO/rDg/RDK5x/~1/hTFVgn,jGd/x/uMxiXAJ" }, { "type": "encryption", "pointer": "/xRkG.0lo3Yd/mgPxEj/D/Q/Ef2c6k79/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "enim aliquip magna", "highlightString": "in sunt" }, { "key": "anim elit aliqua", "highlightString": "aliquip est sint" }, { "key": "in", "highlightString": "do est laborum qui" }, { "key": "consequat tempor", "highlightString": "do nisi" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "error_handler" ], "complete": [ "workflow_start" ], "error": [ "error_handler", "3a1f", "workflow_end" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "amet aliqua deserunt dolor", "start_time": "1964-03-06T20:01:54.656Z", "end_time": -61069569.45039111, "finish_state": "failure", "retrySettings": { "state": [ "failure", "failure", "error", "error" ], "autoRetry": true, "limit": 92360279, "delay": 81373380, "count": 35256164, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": 35899302.68887538, "outgoing": [ null, "sit in quis veniam" ] }, "childJobs": [ { "_id": "mollit Lorem enim reprehenderit culpa", "name": "magna sit veniam", "iteration": 32823657.05748655 }, { "_id": "mollit esse veniam Ut", "name": "aliquip ea", "iteration": -2004709.2692591697 }, { "_id": "Ut est commodo", "name": "dolore pariatur est", "iteration": 30241699.663986936 } ] }, "groups": [ { "_id": "2d1379255810d9000f5f358c", "provenance": "cillum laboris voluptate Excepteur", "name": "labore sit quis", "description": "Excepteur pariatur cupidatat est in", "memberOf": [ { "groupId": "9ff6bcb8fb8ea9f4b305dadc", "aaaManaged": true }, { "groupId": "a850213b99465c49b2614ee5", "aaaManaged": false }, { "groupId": "5b8c36abbc212eedd6a00616", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute exercitation sed aliquip" } ], "inactive": false, "_meta": { "created": "1966-08-16T16:45:10.081Z", "updated": "2009-01-17T01:54:21.672Z", "migrationVersion": 36810536 } }, "333dac64d9ae5f3d37c7f54a", "default", "default", "default" ], "watchers": [ null, { "_id": "9ad7dfef5b30dca069cffcbc", "provenance": "nostrud officia exercitation", "username": "aute", "firstname": "ex", "memberOf": [ { "groupId": "295707d800306dabf0d6107c", "aaaManaged": true }, { "groupId": "d13d2f82688e6bce2787b367", "aaaManaged": false }, { "groupId": "750405e4bd5ec16cf1f0da26", "aaaManaged": false }, { "groupId": "dc154d828352b9ba558b0891", "aaaManaged": false }, { "groupId": "b6a7adc578c9a3680101920d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia occaecat" }, { "roleId": "sit" } ], "inactive": true, "lastLogin": "2022-09-26T18:07:38.453Z", "_meta": { "created": "1980-01-22T01:07:56.837Z", "updated": "1964-04-04T05:01:47.234Z", "migrationVersion": -88570020 }, "email": "dolore Lorem" } ], "metrics": { "start_time": -70854353.36518008, "progress": 0.9462144855723207, "end_time": 81427026.66658357, "user": null, "owner": "0bc932b66d2a46c1d40bb808" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }