Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /gui_app_framework/application_definitions/ {application_definition_id}

Retrieve an application definition.

Retrieve an application definition.

Retrieved details include the application manifest and current status.

Table 1: GET /gui_app_framework/application_definitions/{application_definition_id} Resource Details

MIME Type

application/json

Table 2: GET /gui_app_framework/application_definitions/{application_definition_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_

definition_id

path

Required

Number (Integer)

text/plain

Required - The application definition identifier.

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.

Table 3: GET /gui_app_framework/application_definitions/{application_definition_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The application definition was retrieved.

404

33900

The application definition ID does not exist.

409

33700

The application framework is currently disabled.

500

1020

The request could not be completed.

Response Description

Application details:

  • application_definition_id - Long - Application Definition identifier.

  • status - String

    • CREATING - application definition is being created.

    • UPGRADING - application definition is being upgraded.

    • DELETING - application definition is being deleted.

    • COMPLETED - application definition creation/upgrade completed successfully.

    • CANCELLED - application definition has been cancelled.

    • ERROR - application definition creation/upgrade did not complete successfully.

  • error_messages - String - The last error that occurred during an async operation on the definition.

  • error_messages_json - String - The last error that occurred during an async operation on the definition in json format.

  • manifest - Object - The application definition's JSON manifest.

  • created_by - String - The user that created the application definition.

  • created_on - Long - A timestamp representing the created on date and time for the application definition

  • user_role_ids - Array - The IDs of the associated user roles

Response Sample