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": "51476679d1a62638f179e6d2", "font_size": 66205108, "type": "resource:action", "created": "1966-02-01T16:44:26.715Z", "last_updated": "2021-03-13T12:42:21.079Z", "createdVersion": "23.97089599355.7640877021-5046.37314.0061614170", "lastUpdatedVersion": "6207.07284622.482597822-8771.531.775337", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -38222920, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 90090465.61249048, "sla": -45763299.83617855, "decorators": [ { "type": "encryption", "pointer": "/JBB5yZ" }, { "type": "encryption", "pointer": "/Z/~0/g" }, { "type": "encryption", "pointer": "/qsCyqWjMlWf/~1/xs7A8xeA/LanW2Ye/~0/~1/Xii/~0" }, { "type": "encryption", "pointer": "/Osm2" } ], "status": "complete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "culpa enim ut" } ], "ancestors": null, "validationErrors": [ { "keyword": "ea sit deserunt irure est", "dataPath": "sit et incididunt irure", "schemaPath": "non minim cupidatat aliqua culpa", "message": "amet tempor ut" }, { "keyword": "pariatur", "dataPath": "amet tempor", "schemaPath": "pariatur", "message": "dolor aliquip adipisicing voluptate minim" } ], "created_by": "Pronghorn", "last_updated_by": "1d1174441c824e415fa22f6a", "tasks": { "workflow_start": { "x": 20618688.897372678, "y": 23988422.872393623, "gridCoordinate": { "x": 82072582.67943817, "y": 23008141.783430338 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 51542382.39971304, "finish_state": "error", "user": null }, "groups": [ "8f0cf65c62ba814b00e055e4", "c11f71abc61e2538d5225987", { "_id": "2488b701482fa7d0624fc33f", "provenance": "Lorem", "name": "in Lorem", "description": "ipsum in proident Excepteur", "memberOf": [ { "groupId": "a042b131870e94f29560db76", "aaaManaged": true }, { "groupId": "57d0ce7280c4095b15fcfe29", "aaaManaged": true }, { "groupId": "8e2c822503a1bf54125a5f82", "aaaManaged": true }, { "groupId": "9f75eee099125517616f0822", "aaaManaged": true }, { "groupId": "a218e41c6e89f04f4f66e6be", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nostrud Lorem occaecat" }, { "roleId": "Duis do" }, { "roleId": "deserunt est aliqua exercitation" } ], "inactive": true, "_meta": { "created": "1984-09-06T04:57:09.786Z", "updated": "1966-01-03T19:30:22.461Z", "migrationVersion": -91274767 } }, { "_id": "448901e399e89a4c2b235234", "provenance": "officia labore aute esse", "name": "dolore in in", "description": "officia dolor in consectetur", "memberOf": [ { "groupId": "55305d5fd889a4ca53fe99c9", "aaaManaged": true }, { "groupId": "31b160563def7c15e81d4f9d", "aaaManaged": true }, { "groupId": "6193f91c47daf63b93dd3f9c", "aaaManaged": false }, { "groupId": "40e6ca74f60ea2c2dc561693", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in sit tempor" } ], "inactive": false, "_meta": { "created": "2006-05-26T22:55:06.252Z", "updated": "2011-09-16T13:32:51.787Z", "migrationVersion": -32262316 } } ], "iterations": [ "c1Cd32cA-Eaff-cD6d-f3BF-74BB8A87A1f3", "bebE0aC6-054F-3cE6-d4a4-efC1Fedd97AF" ] }, "workflow_end": { "x": -56121311.85474363, "y": -49414541.49956748, "gridCoordinate": { "x": 10646131.040343001, "y": -21039528.348337427 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "e28f", "e28f" ], "complete": [ "workflow_end", "e28f" ], "error": [ "workflow_start", "workflow_start", "error_handler", "workflow_start" ] }, "metrics": { "end_time": -48350941.110107824, "run_time": -94798447.61583692 }, "groups": [ "default", "default", { "_id": "381f004ff10f52201f368e76", "provenance": "et", "name": "incididunt", "description": "magna velit nostrud", "memberOf": [ { "groupId": "19735d70c61d8abb8e545506", "aaaManaged": false }, { "groupId": "24314f7ac8f7d524d11a6a34", "aaaManaged": false }, { "groupId": "e6079528c254c73ea123d826", "aaaManaged": true }, { "groupId": "a90fffef901f5806d79bca82", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet dolore" }, { "roleId": "occaecat do voluptate" } ], "inactive": true, "_meta": { "created": "2009-12-14T11:20:55.583Z", "updated": "1986-04-10T20:47:26.51Z", "migrationVersion": 54929652 } }, { "_id": "df3b12c6bcc5daeb15918df5", "provenance": "voluptate occaecat consectetur Duis proident", "name": "ullamco exercitation qui est non", "description": "non", "memberOf": [ { "groupId": "edc51404328ae15fad9f9d8b", "aaaManaged": false }, { "groupId": "99b7187701c87e310f990d9a", "aaaManaged": true }, { "groupId": "5fa952e4e041d79480d379ee", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore qui enim anim consectetur" }, { "roleId": "ut cupidatat tempor" } ], "inactive": true, "_meta": { "created": "1971-02-26T08:27:11.14Z", "updated": "2025-03-10T08:54:51.063Z", "migrationVersion": 556202 } } ], "iterations": [ "456DbF09-7C61-19B8-b61A-42F3beDB2A5E", "3CEA9CAa-55d6-73Fe-Ac9a-8C356e0CB69e", "5FD431D0-43Bc-19C7-6EC9-De62e94e90F3" ] }, "error_handler": { "x": -22566487.060741916, "y": -42679764.393858254, "gridCoordinate": { "x": -18101045.951325074, "y": -15555516.517921925 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "ad ea mollit amet", "canvasName": "ad id exercitation qui", "displayName": "est", "summary": "dolor officia do", "description": "eiusmod Lorem", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/~1/vys6X" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~0/Wi/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "esse", "highlightString": "aute qui ut in" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "workflow_start", "e28f" ], "complete": [ "e28f", "3a1f" ], "error": [ "3a1f", "3a1f", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "qui enim", "start_time": "2020-03-25T03:43:01.922Z", "end_time": 58019598.20508075, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": { "_id": "7a784877a35c3ecc87ba9851", "provenance": "nostrud ut", "username": "eu consequat", "firstname": "aute dolore adipisicing nisi", "memberOf": [ { "groupId": "b9976feb65d459cf85ce2e4f", "aaaManaged": false }, { "groupId": "6dcc3ccc39860f0221c07554", "aaaManaged": false }, { "groupId": "1639a379f05a7d39a1204089", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse in Duis anim" }, { "roleId": "reprehenderit dolore irure in" } ], "inactive": true, "lastLogin": "1951-11-07T02:18:35.593Z", "_meta": { "created": "1947-07-23T02:41:57.337Z", "updated": "1980-04-19T17:23:46.155Z", "migrationVersion": -63511380 }, "email": "Duis" }, "groups": [ "373643fb562621e0bef66f37", "default" ], "iterations": [ "b2b88A7E-ffa3-64EF-b18b-e98dA7aB1bdd" ] }, "6f": { "actor": { "_id": "7c090a10a9bcd18a96c319df", "provenance": "labore magna ad", "username": "dolor ullamco nostrud pariatur", "firstname": "commodo amet ea est consequat", "memberOf": [ { "groupId": "ad6bfe0793731ee85537a87d", "aaaManaged": true }, { "groupId": "f56fc254d66621057c0fc9cc", "aaaManaged": false }, { "groupId": "f9dc420abf78fd073315f028", "aaaManaged": false }, { "groupId": "5d96ba7f88606d309d10d7e2", "aaaManaged": false }, { "groupId": "8825894d4d09c86585efc717", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim officia aliqua ad" } ], "inactive": true, "lastLogin": "1990-02-27T03:10:00.216Z", "_meta": { "created": "1996-02-06T05:01:04.886Z", "updated": "1958-08-24T13:30:32.72Z", "migrationVersion": 96780766 }, "email": "labore" }, "groups": [ "default", "633a9c01c50c86bca2f13fac", "cb7ad514c84ce0bbdff1931b" ], "iterations": [ "faD360a5-f2cb-C80E-FD59-709eCf2C2AFc", "5fde9eEb-f2a8-61a9-a4DE-C6DBE7d91966" ], "x": -73690791.96389219, "y": -68363523.28471462, "gridCoordinate": { "x": -987106.438897863, "y": -27555583.214395568 }, "name": "pending", "summary": "quis nostrud do", "description": "voluptate nostrud dolor magna cillum" } }, "parent": { "task": "deserunt in sint", "iteration": 64934104.45413205, "element": -90415384.48332837 }, "errorHandler": { "actor": "job", "groups": [ "5fe6cdb6d9832314ff485219", "5d669ee2e149c1d402971964", "default" ], "iterations": [ "E9AeE0C0-fEe1-e577-6EB9-fB88CFb0Db52", "bcCcCF16-ceA8-d9A9-e89C-DeC01fcDfb4D" ], "x": 65208460.75023511, "y": 34601202.21841934, "gridCoordinate": { "x": 57444215.38827565, "y": 62427324.62059495 }, "name": "pending", "summary": "qui culpa aliquip enim amet", "description": "reprehenderit sint culpa" }, "groups": [ { "_id": "3efe485315e0e0957a9342b2", "provenance": "culpa sint aliqua amet", "name": "deserunt aute Excepteur laboris esse", "description": "veniam dolore dolor ad", "memberOf": [ { "groupId": "4d0564f8e7b9b19efae3e6d2", "aaaManaged": false }, { "groupId": "e11d1c26c3de535f8930d36f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt" } ], "inactive": false, "_meta": { "created": "2005-09-09T21:48:08.929Z", "updated": "2005-07-28T05:49:53.357Z", "migrationVersion": 23989293 } }, "default" ], "watchers": [ { "_id": "ed8cccdb005c57a1f6a4e100", "provenance": "deserunt", "username": "nulla esse commodo", "firstname": "cillum mollit", "memberOf": [ { "groupId": "6f892e8836fb5331d6ec9ea2", "aaaManaged": false }, { "groupId": "cc0c31b5a225bb2e5a7d399e", "aaaManaged": true }, { "groupId": "e5621524b09596a4e8a4d2b1", "aaaManaged": false }, { "groupId": "1cc0aea9523b6d5219a8034f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non" } ], "inactive": false, "lastLogin": "1969-10-03T22:54:45.37Z", "_meta": { "created": "1992-09-03T01:51:00.51Z", "updated": "1953-01-22T15:46:40.735Z", "migrationVersion": -25822518 }, "email": "dolore Ut magna minim officia" }, { "_id": "9dee50f1081f67f49b505d0f", "provenance": "eiusmod", "username": "quis proident", "firstname": "Excepteur aute", "memberOf": [ { "groupId": "918bdb414ef4a420ffc10235", "aaaManaged": true }, { "groupId": "ef60d01b771e179546aaf57a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam cillum eiusmod" }, { "roleId": "culpa cillum ea eu nostrud" }, { "roleId": "dolor" } ], "inactive": false, "lastLogin": "2016-05-10T10:47:10.972Z", "_meta": { "created": "1990-07-10T09:11:38.282Z", "updated": "1974-09-30T05:10:56.184Z", "migrationVersion": 15568301 }, "email": "veniam pariatur qui" }, "10b0ff2acdfe5f591bd9c064", null, null ], "metrics": { "start_time": 80183622.79681343, "progress": 0.43216260565600106, "end_time": 4300475.60810633, "user": "0e83420d54d001a0215226dc", "owner": { "_id": "c183c311280a361e2863a112", "provenance": "mollit in tempor incididunt consectetur", "username": "consequat cillum", "firstname": "id", "memberOf": [ { "groupId": "ce7187f7ae50188bc3c60394", "aaaManaged": false }, { "groupId": "a034e94bb43a5bce9642a49c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia elit fugiat" }, { "roleId": "dolor cillum aliqua" }, { "roleId": "enim tempor quis" } ], "inactive": true, "lastLogin": "2022-09-26T04:14:23.013Z", "_meta": { "created": "1949-02-15T19:08:15.802Z", "updated": "1987-08-07T20:25:40.373Z", "migrationVersion": 66226680 }, "email": "consectetur ipsum" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }