105
Views
6
Comments
How to list REST API methods and they parameters?
Question

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.

2023-01-19 12-23-07
Abhinav Shilwant
AI Generated

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!

This answer was AI-generated. Please read it carefully and use the forums for clarifications
2024-09-17 12-24-07
Rammurthy Naidu Boddu
Champion
AI Generated

Hi @Michal Witek


1. Service Center API Endpoints:

  • OutSystems provides internal API endpoints in Service Center that can be used to fetch metadata related to the modules, including the REST API methods and their parameters.
  • These endpoints are not officially documented but can be useful for obtaining detailed information.

2. Custom SQL Queries on System Tables:

  • You can query the system tables directly, but it requires knowing the correct relationships between the tables to extract meaningful information.

Here's a detailed way to achieve this:

Using SQL Queries to Extract Data

  1. Understanding the Key Tables:

< reference to non-existing table removed by moderator on 30/01/2025>

This answer was AI-generated. Please read it carefully and use the forums for clarifications
UserImage.jpg
candf candf

Hi @rammurthynaidu boddu ,

Thanks for your reply.

I don't see in the database the tables that you mentioned:

  • OSSYS_REST_API: Contains metadata for exposed REST APIs.
  • OSSYS_REST_API_METHOD: Contains methods for exposed REST APIs.
  • OSSYS_REST_WEB_REF_METHOD: Contains methods for consumed REST APIs.
  • OSSYS_REST_API_PARAMETER: Contains parameters for both exposed and consumed APIs.

Only table OSSYS_REST_WEB_REFERENCE is available.

Can you please clarify that? Otherwise your answer is misleading.

2020-09-15 13-07-23
Kilian Hekhuis
 
MVP

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.

2022-12-30 07-28-09
Navneet Garg

I installed the forge component but I only REST_Expose and REST_Web_Reference

  • OSSYS_REST_API: Contains metadata for exposed REST APIs.
  • OSSYS_REST_API_METHOD: Contains methods for exposed REST APIs.
  • OSSYS_REST_WEB_REFERENCE: Contains metadata for consumed REST APIs.
  • OSSYS_REST_WEB_REF_METHOD: Contains methods for consumed REST APIs.
  • OSSYS_REST_API_PARAMETER: Contains parameters for both exposed and consumed APIs.


2025-02-22 18-27-01
Alfaro
 
MVP

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

Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.