Skip to main content

 

Extensibility and Integration

 

 

OutSystems

Expose REST APIs

  • Edit
    Collaborate with us
    Edit this page on GitHub
  • OutSystems allows you to expose methods using a REST API. These methods can be organized under multiple REST APIs.

    If you want to consume a REST API, check Consume REST APIs.

    REST API Method Flow

    When a request to your REST API Method is received, OutSystems executes the following flow:

    1. Security Validations: After receiving the REST API Method request, OutSystems executes the security validations according to the settings in REST API properties HTTP Security and Internal Access Only.
    2. OnRequest(): OnRequest callback allows you to run logic over the requests after receiving them.
    3. OnAuthentication(): OnAuthentication callback allows you to add basic authentication or custom authentication to requests.
    4. Parameters Deserialization and Validation: Deserialization of the input parameters and validation of the data types, mandatory values, etc.
    5. Execute Method: Executes the action that implements the REST API Method.
    6. Parameters Serialization: Serialization of the output parameters to return in the response.
    7. OnResponse(): OnResponse callback allows you to run logic over the responses before sending them. It is always executed, even in an error situation.

    Articles in this Section