How Can We Help?

This section describes the usage of Query APIs to get information on an application in HEAL.

Details for All Applications

To get details of all the Applications for a specific account, use the ‘applicationsQuery API as follows:
API Name – applications
Format – GET /config/accounts/{accountId}/applications
Input Parameter

TypeNameDescriptionSchemaMandatory / Optional
PathaccountIdID or Identifier of an AccountstringMandatory

 

Output Parameters
Output Type: CSV

  • Application ID – Unique ID of an application
  • Application Name – Name of an application

Sample Input

http://<keycloak_host>:<keycloak_port>/appsone-query-api/v1.0/config/accounts/5/applications

Details for an Application

To get details of a specific application for an account, use the ‘applicationsQuery API as follows:
API Name – applications
Format – GET /config/accounts/{accountId}/applications/{applicationId}

Input Parameter

TypeNameDescriptionSchemaMandatory / Optional
PathaccountIdID or Identifier of an AccountstringMandatory
PathapplicationIdID or Identifier of an ApplicationstringMandatory

Output Parameters
Output Type: CSV

  • Application Id – Unique Id of an application
  • Application Name – Name of an application

Sample Input

http://<keycloak_host>:<keycloak_port>/appsone-query-api/v1.0/config/accounts/5/applications/31

Table of Contents