Skip to main content
Version: v11.9.4

Database Service APIs

REST APIs generated for CRUD, searching and listing operations for each Database table integrated within the app can be viewed from API Designer. For easy usability, these APIs are categorized under various heads. They are grouped by the database, then entities, queries, and procedures.

Endpoint​

Selecting an endpoint will display the details of the APIs pertaining to that endpoint.

Method Type​

  • GET - methods which retrieve resources,
  • POST - methods which create new resources,
  • PUT - methods which update resources, or
  • DELETE - methods which delete a resource

URL​

  • The URL for that particular REST API service.
  • a brief description

Visibility​

  • Public - this is the default setting and would enable user access to the API at runtime;
  • Unavailable - this setting can be used when you want to disable a particular API method. For example, you want to ensure that records from employee table are not deleted, then making the DELETE method Unavailable will ensure that it does not happen by mistake.

API Method Details​

API method details can be viewed by selecting the method.

  • Define - this tab gives the definition of the selected method:
    • The Description field which can be customized.
    • The Request Parameters including the name, type, the parameter type and the description of the parameter.
    • The Response Format shows the fields returned along with the type and description.
  • Test - this tab allows you to test an API. Giving a test value for the request parameter and clicking on the test button, displays the result in the Response window.