Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /gui_app_framework/applications/{application_id}

 

Updates an application.

Updates an application.

Supply status=RUNNING to start a stopped application.

Supply status=STOPPED to stop a running application.

Supply oauth_user_id to change the OAuth user associated with the application.

Supply security_profile_id to change the security profile associated with the application.

Note only one of these can be updated at a time, please supply only one query parameter below.

Table 1: POST /gui_app_framework/applications/{application_id} Resource Details

MIME Type

application/json

Table 2: POST /gui_app_framework/applications/{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

Optional

String

text/plain

- The status to set: RUNNING or STOPPED.

oauth_user_id

query

Optional

Number (Integer)

text/plain

- The OAuth user ID to set. This parameter is ignored when status is supplied.

security_profile_id

query

Optional

Long

text/plain

- The security profile ID to associate with the Application instance

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/applications/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The application has been successfully updated.

404

1002

The application identifier could not be found.

409

33000

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

409

33006

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

409

33402

The application image does not exist in the docker registry

409

33600

The application does not have an associated OAuth user.

409

33602

The supplied OAuth user does not have the capabilities required by the application.

409

33700

The application framework is currently disabled.

409

33703

The current state of the system hosts file does not allow the requested action.

409

1008

The application is in a state that does not allow the requested update.

422

33302

The application requested more memory than is currently available.

422

33500

A valid query parameter must be supplied to this API request.

422

33501

An invalid value was supplied for the status parameter.

422

33502

Only one query parameter can be supplied at a time to this API request.

422

33601

The supplied OAuth user does not exist.

422

33650

The supplied security profile does not exist.

422

33651

The supplied security profile is invalid as you can only change from the admin security profile id to null or vice versa.

422

33652

There is already an instance with the supplied security profile with the same app definition

422

1005

A supplied parameter is invalid.

500

33203

An error occurred while loading resource bundle properties from the application zip file.

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

Application details, see GET /applications/{application_id}.

Response Sample