Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /gui_app_framework/applications

Retrieve list of applications.

Retrieves a list of all installed applications.

Retrieved details include the application manifest and current status.

Table 1: GET /gui_app_framework/applications Resource Details

MIME Type

application/json

Table 2: GET /gui_app_framework/applications Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 3: GET /gui_app_framework/applications Response Codes

HTTP Response Code

Unique Code

Description

200

 

Application list was retrieved.

409

33700

The application framework is currently disabled.

500

1020

The request could not be completed.

Response Description

A list of application details. For a description of what each list entry contains, see GET /applications/{application_id}.

Response Sample