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/{application_id}

Retrieve an installed application.

Retrieve an installed application.

Retrieved details include the application manifest and current status.

Table 1: GET /gui_app_framework/applications/{application_id} Resource Details

MIME Type

application/json

Table 2: GET /gui_app_framework/applications/{application_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application 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/applications/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The application was retrieved.

404

1002

The application identifier could not be found.

409

33700

The application framework is currently disabled.

500

1020

The request could not be completed.

Response Description

Application details:

  • application_state

    • application_id - String - Application identifier.

    • status - String

      • CREATING - the application install has not yet completed.

      • UPGRADING - the application upgrade has not yet completed.

      • RUNNING - the application is running.

      • STARTING - the application is starting.

      • STOPPING - the application is stopping.

      • DELETING - the application is being deleted.

      • STOPPED - the application has been stopped manually.

      • ERROR - the application is no longer running due to an error. The reason is in error_messages.

    • error_messages - String - Any error message associated with the application.

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

    • memory - Integer - The amount of memory allocated to the application

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

  • installed_on - Timestamp - The timestamp of when the application was created (in milliseconds since epoch).

  • installed_by - String - The user who created the application.

  • managed_host_id - Integer - The id of the managed host the application is running on.

  • application_definition_id - Long - The definition associated with this application.

Response Sample