View a Gateway App Instance Configuration (Deprecated since 24.2)
get
/api/restapi/pims/appInstanceConfigurations/{id}
This endpoint returns Gateway app instance configurations that meet the following requirements:
- The object has an ID that matches the value of the {id} path parameter.
Request
Path Parameters
-
id(required): integer(int64)
ID of application configuration instance.Default Value:
0
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : AppInstanceConfig
Type:
object
Title:
AppInstanceConfig
A list of application instance configurations associated with the application instance.
Show Source
-
appConfig(required): object
AppConfig
Title:
AppConfig
The application configuration associated with the application instance configuration. -
appInstance(required): object
AppInstance
Title:
AppInstance
The list of application instances associated with a flow. -
id(required): integer
(int64)
The unique ID of the application instance configuration generated by the system.
-
value(required): string
The value of the application instance configuration entered by the user.
Nested Schema : AppConfig
Type:
object
Title:
AppConfig
The application configuration associated with the application instance configuration.
Show Source
-
id(required): integer
(int64)
The unique ID of the application instance configuration generated by the system.
-
name(required): string
The name of the application configuration.
-
required: boolean
-
type(required): string
Allowed Values:
[ "String", "Integer", "Long", "Date", "Boolean", "Password", "File", "Readonly", "Enum" ]
The category of application configuration.
Nested Schema : AppInstance
Type:
object
Title:
AppInstance
The list of application instances associated with a flow.
Show Source
-
app(required): object
App
Title:
App
A reference to the App business object. -
description(required): string
A description of the application instance.
-
id(required): integer
(int64)
The unique ID of the application instance generated by the system.
-
name(required): string
The name of the application instance associated with the application instance ID.
Nested Schema : App
Type:
object
Title:
App
A reference to the App business object.
Show Source
-
appInstances(required): array
appInstances
Unique Items Required:
true
The list of application instances associated with a flow. -
description(required): string
A description of the application.
-
external: boolean
The indicator which determines whether the provider is external.
-
id(required): integer
(int64)
The unique ID of the application generated by the system.
-
name(required): string
The name of the application associated with the flow.
-
providerName(required): string
The Oracle Primavera Gateway provider associated with an application.
-
providerPath(required): string
The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Cloud application.
-
supportFeedback: boolean
The indicator which determines whether the feedback step in a business flow is enabled.
-
version(required): string
The application version number.
Nested Schema : appInstances
Type:
array
Unique Items Required:
true
The list of application instances associated with a flow.
Show Source
-
Array of:
object AppInstance
Title:
AppInstance
The list of application instances associated with a flow.
404 Response
The requested Gateway app instance configuration does not exist, or you do not have access to it.