Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

PUT /gui_app_framework/application_definitions/ {application_definition_id}

Upgrades an application definition.

Upgrades an application definition.

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

MIME Type

application/json

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

include_stopped_application

header

Optional

Boolean

text/plain

Optional - Indicates if STOPPED application is included for this upgrade process

fields

header

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: PUT /gui_app_framework/application_definitions/{application_definition_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

package

zip

application/zip

Required - A zip file that contains the application's manifest and source code files.

null

Table 4: PUT /gui_app_framework/application_definitions/{application_definition_id} Response Codes

HTTP Response Code

Unique Code

Description

202

 

The request for an application upgrade was accepted.

404

33900

The application definition ID does not exist.

409

33000

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

409

33001

This is a core JSA app. You cannot upgrade or delete it.

409

33007

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

409

33603

The definition cannot be upgraded to support oauth or change existing oauth capabilities when it has more than one associated instance.

409

33700

The application framework is currently disabled.

409

33702

null

422

33102

The application zip file structure is invalid. Check that required folders are present.

422

33103

The manifest.json file is missing from the application zip file.

422

33104

The application manifest.json file does not conform to the manifest schema.

422

33105

The application manifest.json file contains duplicate keys.

422

33106

An error occurred while parsing the manifest.json file from the application zip file.

422

33201

An error occurred while processing the application RPM/Python dependencies.

422

33301

The UUID in the application manifest.json file does not match the existing UUID for this app.

422

33302

The application requested more memory than is currently available.

422

33303

The application manifest.json file contains an unsupported OAuth flow type.

422

33304

The application manifest.json file requested an invalid OAuth capability.

422

33307

The application manifest.json file contains an invalid required_capabilities entry.

422

33403

The application image supplied is not supported.

422

1005

null

500

33100

The uploaded application zip file could not be saved to disk.

500

33101

An error occurred while reading the application zip file.

500

33202

An error occurred while generating the application Dockerfile.

500

33204

An error occurred while loading the application sacrosanct files list.

500

33305

The updated application manifest.json file could not be saved to disk.

500

33306

An error occurred while parsing the copy of the app manifest stored in the database.

500

1020

The request could not be completed.

Response Description

Upgrade status details:

  • application_id - Integer - Application identifier.

  • status - String

    • UPGRADING - the upgrade is in progress.

    • AUTH_REQUIRED - the upgrade is waiting for a response to an authorisation request. See /application_creation_task/{application_id}/auth for details.

Response Sample