View All Gateway Business Flow Definitions
get
/primeapi/restapi/pims/flowDefinitionApps/list?flowDefinitionId={flowDefinitionId}
This endpoint returns all Gateway business flow definitions.
Request
Query Parameters
-
flowDefinitionId: integer(int64)
ID of flow definition object.Default Value:
0
Response
Supported Media Types
- application/json
200 Response
successful operation
A reference to the flowDefApp business object.
Root Schema : FlowDefinitionApp
Type:
object
A reference to the flowDefApp business object.
Show Source
-
app(optional):
object App
A reference to the App business object.
-
children(optional):
array children
A list of flow definition applications.
-
disableCompare(optional):
boolean
The indicator that determines whether the Compare step is enabled or disabled for a flow.
-
flowDefinition(optional):
object FlowDefinition
The flow definition object associated with a flow.
-
id(optional):
integer(int64)
The unique ID of the flow definition application generated by the system.
Nested Schema : App
Type:
object
A reference to the App business object.
Nested Schema : children
Type:
array
A list of flow definition applications.
Show Source
-
[0]:
object FlowDefinitionApp
A reference to the flowDefApp business object.
Nested Schema : FlowDefinition
Type:
object
The flow definition object associated with a flow.
404 Response
The requested flow definition does not exist, or you do not have access to it.