Question
This article will aim to cover
Q1. What external RestAPI's are available? / Where is the documentation for how to implement?
Q2. Basic Troubleshooting steps?
Answer
A1. What external RestAPI's are available? Where is the documentation for how to implement?
(Valid as of EPM v10.10)
-
EPM Authentication = EPM Authentication API Requirements
- WIndows AD Authentication (on-premise only) = Windows Authentication API Requirements
- Get EPM Version = Get EPM Version API Requirements
- Get Set List = Get Sets List API Requirements
- Get Aggregated Events = Get Aggregated Events API Requirements
- Get Raw Events = Get Raw Events API Requirements
- Get Raw Event Details = Get Raw Event Details API RequirementsA2. Basic Troubleshooting steps?
The tool used by EPM Support for testing/troubleshooting EPM RestAPI is Postman (
https://www.getpostman.com/apps)
This will allow you to create the request which is failing for you in your environment and export it to us. If same request works in postman, it indicates the issue is in the surrounding code and out of the scope of EPM Support.
Instructions for using Postman to export a .JSON file and sending it to us. 1. Kindly install Postman and assemble your request in it. Test if it works.
2. If still broken, you can export the collection/environment by performing the following:
3. Clicking Postman's 'File' top menu entry at the top-left side of the screen.
4. Choose 'Settings' from the drop-down menu.
5. Click 'Data' in the upper-navigation menu.
6. Click 'Download' - This will download all collections, environments, global variables and header presets to a single JSON file.
7. Send Support the JSON file and to import and review.
8. (for On-premise customer's only) - please also export the EPM Server Trace taken after the failed API requests were tested. (Instructions for
EPM - Exporting Server Trace / ServerData)
Additional Reference =
EPM - RestAPI Limitations