Retuns the Flow business object for the specified Flow ID.
get
/gatewayapi/restapi/v1/flows/{id}
Request
Path Parameters
-
id: integer(int64)
ID of flow object.Default Value:
0
Response
Supported Media Types
- application/json
200 Response
successful operation
The flow object associated with a flow instance.
Root Schema : Flow
Type:
object
The flow object associated with a flow instance.
Show Source
-
configSteps:
boolean
Default Value:
false
The indicator determines whether to configure steps -
description:
string
A description of the flow.
-
destinationApp:
object App
A reference to the App business object.
-
disableCompare:
boolean
Default Value:
false
The indicator that determines whether the Compare step is enabled or disabled for a flow. -
enableFeedback:
boolean
Default Value:
false
The indicator which determines whether the feedback step is enabled in a business flow. -
flowDefinition:
object FlowDefinition
The flow definition object associated with a flow.
-
flowType:
string
Flow Type
-
id:
integer(int64)
The unique ID of the flow generated by the system.
-
name:
string
The name of the flow.
-
sourceApp:
object App
A reference to the App business object.
Nested Schema : App
Type:
object
A reference to the App business object.
Show Source
-
appInstances:
array appInstances
Unique Items Required:
true
The list of application instances associated with a flow. -
description:
string
A description of the application.
-
external:
boolean
Default Value:
false
The indicator which determines whether the provider is external. -
id:
integer(int64)
The unique ID of the application generated by the system.
-
name:
string
The name of the application associated with the flow.
-
providerName:
string
The Oracle Primavera Gateway provider associated with an application.
-
providerPath:
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 Prime application.
-
supportFeedback:
boolean
Default Value:
false
The indicator which determines whether the feedback step in a business flow is enabled. -
version:
string
The application version number.
Nested Schema : FlowDefinition
Type:
object
The flow definition object associated with a flow.
Show Source
-
description:
string
A description of the flow definition.
-
hasCompareStep:
boolean
Default Value:
false
An indicator which determines whether the Compare step exists in a flow definition. -
id:
integer(int64)
The unique ID of the flow definition generated by the system.
-
isEnabled:
boolean
Default Value:
false
An indicator which determines whether the flow definition is enabled. -
name:
string
The name of the flow definition.
-
priority:
integer(int32)
The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
-
type:
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
-
[0]:
object AppInstance
The list of application instances associated with a flow.
Nested Schema : AppInstance
Type:
object
The list of application instances associated with a flow.
Show Source
-
app:
object App
A reference to the App business object.
-
description:
string
A description of the application instance.
-
id:
integer(int64)
The unique ID of the application instance generated by the system.
-
name:
string
The name of the application instance associated with the application instance ID.
404 Response
The Activity does not exist or you do not have access to it.