This appendix provides guidance on how to access and interact with the backend APIs available in the OpenEdge Memory Profiler tool. These APIs allow you to retrieve profiling data in a structured format, such as JSON, which can be used for custom integrations or reporting. The APIs are exposed through a built-in SwaggerUI viewer that ships with every PAS for OpenEdge instance created using the oemp install command. For more information about this command, see Install the OpenEdge Memory Profiler tool. This viewer offers an interactive interface to test and execute API requests without requiring additional setup.

The SwaggerUI viewer is accessible at the following URL on the standard HTTP port for the PAS for OpenEdge instance:
http://localhost:8880/report/static/catalog.html

SwaggerUI opens and displays a consolidated view of all available services, allowing you to quickly verify whether you are accessing the correct API endpoint.

The SwaggerUI displays a list of services grouped by the following categories:
  • Source—Provides any source of recording data. In OpenEdge Memory Profiler Release 1.0, this is limited only to the .oemp files and enables you to:
    • Discover available recordings
    • Initiate imports
    • View the progress of current imports

  • Data—Returns all of the application data imported from a source recording.

  • Catalog—Provides endpoints for accessing and retrieving the data displayed in the SwaggerUI.
  • Debug—Reserved for internal use and testing. Enables viewing of API request messages and error responses. This service is not intended for standard user operations.

Steps to access, view, and execute the SwaggerUI viewer

Here are the step-by-step instructions for accessing and using the SwaggerUI viewer:
  1. Ensure that the PAS for OpenEdge instance created using the oemp install command is running and accessible on the configured HTTP port.
  2. Navigate to the following URL in your browser:
    http://localhost:8880/report/static/catalog.html
    The page displays an interactive catalog of all available backend APIs.
  3. The viewer lists endpoints grouped by functionality. Each endpoint includes:
    • HTTP method (GET, POST, PUT, DELETE)
    • Endpoint path with placeholders for application and agent identifiers
    • Description of the operation
  4. Click Execute to send the request and view the JSON response.