GET /gui_app_framework/application_creation_task/{application_id}

Retrieves the status of an application install.

Table 1. GET /gui_app_framework/application_creation_task/{application_id} resource details
MIME Type
application/json

Table 2. GET /gui_app_framework/application_creation_task/{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/application_creation_task/{application_id} response codes
HTTP Response Code	Unique Code	Description
200		Status 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

Installation status details:

application_id - Integer - Application identifier.
status - String
- CREATING - the install has not yet completed.
- CANCELLED - the install has been cancelled.
- COMPLETED - the install has completed.
- ERROR - the install failed. The reason is in error_messages.
- AUTH_REQUIRED - the install is waiting for a response to an authorisation request. See /application_creation_task/{application_id}/auth for details.
error_messages - String - Error messages, if status is ERROR.

Response Sample


{
    "application_id": 42,
    "error_messages": "String",
    "error_messages_json": [
        {
            "code": "String",
            "message": "String",
            "source": "String"
        }
    ],
    "status": "String <one of: CREATING, UPGRADING, STOPPING, STARTING, AUTH_REQUIRED, COMPLETED, CANCELLED, DELETING, ERROR, UNKNOWN>"
}