View all Gateway Business Flow Definitions (Deprecated since 24.2)
get
/api/restapi/pims/flowDefinitionApps/list
This endpoint returns all Gateway business flow definitions.
Request
Query Parameters
-
flowDefinitionId(required): integer(int64)
ID of flow definition object.
This is a required field.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 : List<FlowDefinitionApp>
Type:
array
Title:
Show Source
List<FlowDefinitionApp>
-
Array of:
object FlowDefinitionApp
Title:
FlowDefinitionApp
A reference to the flow definition application business object.
Nested Schema : FlowDefinitionApp
Type:
object
Title:
FlowDefinitionApp
A reference to the flow definition application business object.
Show Source
-
app(required): object
App
Title:
App
A reference to the App business object. -
children(required): array
children
A list of flow definition applications.
-
disableCompare(required): boolean
The indicator that determines whether the Compare step is enabled or disabled for a flow.
-
flowDefinition(required): object
FlowDefinition
Title:
FlowDefinition
The flow definition object associated with a flow. -
id(required): integer
(int64)
The unique ID of the flow definition application generated by the system.
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 : children
Type:
array
A list of flow definition applications.
Show Source
-
Array of:
object FlowDefinitionApp
Title:
FlowDefinitionApp
A reference to the flow definition application business object.
Nested Schema : FlowDefinition
Type:
object
Title:
FlowDefinition
The flow definition object associated with a flow.
Show Source
-
description(required): string
A description of the flow definition.
-
hasCompareStep(required): boolean
An indicator which determines whether the Compare step exists in a flow definition.
-
id(required): integer
(int64)
The unique ID of the flow definition generated by the system.
-
isEnabled(required): boolean
An indicator which determines whether the flow definition is enabled.
-
name(required): string
The name of the flow definition.
-
priority(required): integer
(int32)
The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
-
type(required): string
A description of the flow definition type.
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.
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.
404 Response
The requested flow definition does not exist, or you do not have access to it.