POST /gui_app_framework/application_definitions/{application_definition_id}

Cancels the creation or upgrade of an application definition

Cancels the creation or upgrade of an application definition

Table 1. POST /gui_app_framework/application_definitions/{application_definition_id} resource details
MIME Type

application/json

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

- The application definition identifier

status

query

Optional

String

text/plain

- The status to set: 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_definitions/{application_definition_id} response codes
HTTP Response Code Unique Code Description

200

The creation or upgrade of the application definition has been cancelled successfully

404

33900

The application definition ID does not exist.

409

33700

The application framework is currently disabled.

409

33902

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

422

33501

An invalid value was supplied for the status parameter.

500

1020

The request could not be completed.

Response Description

Application definition details showing whether definition was UPGRADING or CREATING when the cancel request was submitted.

Response Sample


{
    "application_definition_id": 42,
    "error_messages": "String",
    "status": "String <one of: CREATING, UPGRADING, COMPLETED, ERROR, DELETING, CANCELLED>"
}