POST /gui_app_framework/application_creation_task/{application_id}

Cancels an application install.

Cancels the installation of an application within the Application framework.

Table 1. POST /gui_app_framework/application_creation_task/{application_id} resource details
MIME Type

application/json

Table 2. POST /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.

status

query

Required

String

text/plain

Required - "CANCELLED".

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. POST /gui_app_framework/application_creation_task/{application_id} response codes
HTTP Response Code Unique Code Description

200

The application installation was cancelled.

404

33901

The application instance could not be found.

409

33000

The current state of the application does not allow the requested action.

409

33700

The application framework is currently disabled.

422

33501

An invalid value was supplied for the status parameter.

500

1020

The request could not be completed.

Response Description

Installation status details:
  • application_id - Integer - Application identifier.
  • status - String - "CANCELLED".

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>"
}