Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /gui_app_framework/application_definitions

 

Installs a new application.

Initiates the asynchronous installation of a new application within the Application framework.

The returned application identifier should be used in subsequent API calls for that application.

Table 1: POST /gui_app_framework/application_definitions Resource Details

MIME Type

application/json

Table 2: POST /gui_app_framework/application_definitions Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

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: POST /gui_app_framework/application_definitions 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: POST /gui_app_framework/application_definitions Response Codes

HTTP Response Code

Unique Code

Description

201

 

The installation of the application was initiated successfully.

409

33700

The application framework is currently disabled.

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

33300

The UUID in the application manifest.json file is already in use by another app.

422

33302

The application requested more memory than is currently available.

422

33307

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

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

33200

An error occurred while loading the application configuration properties file.

500

33202

An error occurred while generating the application Dockerfile.

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

Installation status details:

  • application_id - Integer - Application identifier.

  • status - String

    • CREATING - the install is in progress.

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

Response Sample