Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /gui_app_framework/application_definitions

SUMMARY Retrieve list of application definitions.

Retrieves a list of all application definitions.

Retrieved details include the application definition manifest and current status.

Table 1: GET /gui_app_framework/application_definitions resource details:

GET /gui_app_framework/application_definitions resource details
MIME Type

application/json

Table 2: GET /gui_app_framework/application_definitions request parameter details:

GET /gui_app_framework/application_definitions request parameter details
Parameter Type Optionality Data Type MIME Type Description

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.

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.

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/application_definitions response codes:

GET /gui_app_framework/application_definitions response codes
HTTP Response Code Unique Code Description

200

Application definition 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 definition details. For a description of what each list entry contains, see GET /application_definitions/{application_definition_id}.

Response Sample