Hi,
I would like to list REST API methods (consumed and exposed) with their parameters (especially URL Path). Can you advise how to do that?
I tried to query OSSYS_REST_WEB_REFERENCE but it only returns API endpoints. I also tried OutDoc logic, although it returns API methods it does not return all parameters (URL Path) is missing.
Hi @Michal Witek,
To list REST API methods (both consumed and exposed) along with their parameters, especially the URL Path, querying directly from the platform’s database may not give all the information you need, as you’ve noticed with OSSYS_REST_WEB_REFERENCE.
< reference to non-existing table removed by moderator on 30/01/2025>
However, since OutDoc does not give the full details (e.g., URL paths), another approach would be using the OutSystems APIs (such as LifeTime API or Service Center API) to extract metadata related to your modules’ REST API definitions.
For a more complete picture, you could develop a custom module to extract this data through introspection or use available community tools like Architecture Dashboard to assist in mapping the endpoints and methods.
Another option would be to explore built-in platform tools like the Integration Manager for documenting APIs.
Hope this helps!
Hi @Michal Witek ,
1. Service Center API Endpoints:
2. Custom SQL Queries on System Tables:
Here's a detailed way to achieve this:
Using SQL Queries to Extract Data
Understanding the Key Tables:
Hi @rammurthynaidu boddu ,
Thanks for your reply.
I don't see in the database the tables that you mentioned:
Only table OSSYS_REST_WEB_REFERENCE is available.
Can you please clarify that? Otherwise your answer is misleading.
Hi Candf,
There's the Extended Metamodel Forge asset that allows you to query those entities. You won't get the parameters though, as far as I know it's impossible to query those.
I installed the forge component but I only REST_Expose and REST_Web_Reference
Hello @Michal Witek ,
You can use the OutDoc tool to get the information on the REST API methods, although it does not document the parameters.
CA