View All Gateway Business Flow Instances (Deprecated since 24.2)

get

/api/restapi/pims/flowInstances/list

This endpoint returns all Gateway business flow instances.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : List<FlowInstance>
Type: array
Title: List<FlowInstance>
Show Source
Nested Schema : FlowInstance
Type: object
Title: FlowInstance
A reference to the flow instance business object.
Show Source
Nested Schema : childInstances
Type: array
A list of child flow instances associated with a flow instance object.
Show Source
Nested Schema : Flow
Type: object
Title: Flow
The flow object associated with a flow instance.
Show Source
Nested Schema : FlowSchedule
Type: object
Title: FlowSchedule
The flow schedule object associated with a flow instance.
Show Source
Nested Schema : flowStepInstances
Type: array
Unique Items Required: true
Set of flow step instances
Show Source
Nested Schema : flowInstancetStat
Type: array
Unique Items Required: true
Stat for child jobs
Show Source
Nested Schema : App
Type: object
Title: App
A reference to the App business object.
Show Source
Nested Schema : FlowDefinition
Type: object
Title: FlowDefinition
The flow definition object associated with a flow.
Show Source
Nested Schema : appInstances
Type: array
Unique Items Required: true
The list of application instances associated with a flow.
Show Source
Nested Schema : AppInstance
Type: object
Title: AppInstance
The list of application instances associated with a flow.
Show Source
Nested Schema : EventListenerInstance
Type: object
Title: EventListenerInstance
A reference to the event listener instance object.
Show Source
Nested Schema : Schedule
Type: object
Title: Schedule
The schedule object associated with a flow schedule. This is used for scheduling jobs.
Show Source
Nested Schema : eventInstanceConfigs
Type: array
Unique Items Required: true
A reference to the eventInstConfig object.
Show Source
Nested Schema : EventListener
Type: object
Title: EventListener
A reference to the event listener object.
Show Source
Nested Schema : EventInstanceConfig
Type: object
Title: EventInstanceConfig
The value of the event instance configuration.
Show Source
Nested Schema : EventConfig
Type: object
Title: EventConfig
A reference to the eventConfig object.
Show Source
Nested Schema : FlowStepInstance
Type: object
Title: FlowStepInstance
A reference to the flowStepInst business object.
Show Source
Nested Schema : FlowStep
Type: object
Title: FlowStep
A reference to the flowStep business object.
Show Source
Nested Schema : flowStepInstanceMessages
Type: array
Unique Items Required: true
A reference to the flowStepInstMsg business object.
Show Source
Nested Schema : FlowStepInstanceMessage
Type: object
Title: FlowStepInstanceMessage
A reference to the flowStepInstMsg business object.
Show Source
Nested Schema : data
Type: array
The input and output byte data of each step in a flow.
Show Source
Nested Schema : FlowInstanceStat
Type: object
Title: FlowInstanceStat
A Reference to jobs statistic by status
Show Source

404 Response

The requested Gateway business flow instance does not exist, or you do not have access to it.
Back to Top