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

 

Creates a new application instance.

Initiates the creation of a new application instance within the Application framework.

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

Table 1: POST /gui_app_framework/applications Resource Details

MIME Type

application/json

Table 2: POST /gui_app_framework/applications Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_

definition_id

query

Required

Number (Integer)

text/plain

null

security_

profile_id

query

Optional

Number (Integer)

text/plain

- The security profile ID to associate with the Application instance

force_

multitenancy_

safe

query

Optional

Boolean

text/plain

- If provided, this will change the multitenancy flag on the instance definition

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 Response Codes

HTTP Response Code

Unique Code

Description

201

 

The creation of the application instance was successful.

404

33900

null

409

33000

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

409

33700

The application framework is currently disabled.

409

33701

The supplied application definition ID only allows a single application instance.

422

33302

The application requested more memory than is currently available.

422

33650

The supplied security profile does not exist.

422

33652

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

422

33653

The supplied security profile is invalid for the supplied definition ID as the definition is not both multitenancy safe and non single instance only. Only null or admin is permitted.

422

1005

null

500

1020

The request could not be completed.

Response Description

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

Response Sample