View All Business Flow Schedules (Deprecated since 24.2)
get
/api/restapi/pims/synchronizations/list
This endpoint returns all Gateway business flow schedules.
Request
Query Parameters
-
deploymentName(required): string
The name of deployment.
This is a required field.Default Value: -
flowDefinitiontype(required): string
The flow definition type.
This is a required field.Default Value:
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<FlowSchedule>
Type:
array
Title:
Show Source
List<FlowSchedule>
-
Array of:
object FlowSchedule
Title:
FlowSchedule
The flow schedule object associated with a flow instance.
Nested Schema : FlowSchedule
Type:
object
Title:
FlowSchedule
The flow schedule object associated with a flow instance.
Show Source
-
active(required): boolean
An indicator which determines whether the flow schedule is active.
-
description(required): string
A description of the flow schedule.
-
destinationAppInstance(required): object
AppInstance
Title:
AppInstance
The list of application instances associated with a flow. -
eventListenerInstance(required): object
EventListenerInstance
Title:
EventListenerInstance
A reference to the event listener instance object. -
externalStepStatus(required): string
Custom external step status
-
flow(required): object
Flow
Title:
Flow
The flow object associated with a flow instance. -
flowDefId(required): integer
(int64)
The id of the flow definition.
-
flowDefName(required): string
The name of the flow definition.
-
flowInstRuns(required): integer
(int32)
The number of flow instance runs associated with a flow schedule.
-
id(required): integer
(int64)
The unique ID of the flow schedule generated by the system.
-
isParent(required): boolean
The indicator that determines whether a flow schedule is a parent object.
-
lastCompletionDate(required): string
(date-time)
The last completion date of the flow schedule.
-
lastJobRunStatus(required): string
Allowed Values:
[ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED", "New,Queued,Running,Delegated,On Hold,Rejected,Completed,Completed with Errors,Failed,Noop,Completed with Warnings" ]
The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings. -
lastRunJobId(required): integer
(int64)
The unique ID of the last job run in the flow schedule generated by the system.
-
lastStartDate(required): string
(date-time)
The last start date associated with the flow schedule.
-
maxRuns(required): integer
(int32)
The maximum number of runs allowed for a flow schedule.
-
name(required): string
The name of the flow schedule.
-
nextRunDate(required): string
(date-time)
The next run date associated with a flow schedule.
-
noEndDate(required): boolean
An indicator which determines whether the flow schedule has no end date specified.
-
predecessorFlowScheduleId: integer
(int64)
The predecessor ID of the flow schedule
-
predecessorFlowScheduleName: string
The predecessor Name of the flow schedule
-
previousFlowScheduleId(required): integer
(int64)
Previous FlowSchedule Id
-
recurring(required): boolean
The indicator that determines whether a flow schedule recurs.
-
schedule(required): object
Schedule
Title:
Schedule
The schedule object associated with a flow schedule. This is used for scheduling jobs. -
sourceAppInstance(required): object
AppInstance
Title:
AppInstance
The list of application instances associated with a flow. -
status(required): string
Allowed Values:
[ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]
The status of the flow schedule.
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 : EventListenerInstance
Type:
object
Title:
EventListenerInstance
A reference to the event listener instance object.
Show Source
-
delayInMinutes(required): integer
(int32)
The delay in minutes before triggering a event-based synchronization job.
-
eventDisabled(required): boolean
The indicator which determines whether the event is disabled or enabled.
-
eventInstanceConfigs(required): array
eventInstanceConfigs
Unique Items Required:
true
A reference to the eventInstConfig object. -
eventListener(required): object
EventListener
Title:
EventListener
A reference to the event listener object. -
flowSchedule(required): object
FlowSchedule
Title:
FlowSchedule
The flow schedule object associated with a flow instance. -
id(required): integer
(int64)
The unique ID of the event listener instance generated by the system.
Nested Schema : Flow
Type:
object
Title:
Flow
The flow object associated with a flow instance.
Show Source
-
configSteps: boolean
The indicator determines whether to configure steps
-
description(required): string
A description of the flow.
-
destinationApp(required): object
App
Title:
App
A reference to the App business object. -
disableCompare(required): boolean
The indicator that determines whether the Compare step is enabled or disabled for a flow.
-
enableFeedback(required): boolean
The indicator which determines whether the feedback step is enabled in a business flow.
-
flowDefinition(required): object
FlowDefinition
Title:
FlowDefinition
The flow definition object associated with a flow. -
flowType: string
Flow Type
-
id(required): integer
(int64)
The unique ID of the flow generated by the system.
-
name(required): string
The name of the flow.
-
sourceApp(required): object
App
Title:
App
A reference to the App business object.
Nested Schema : Schedule
Type:
object
Title:
Schedule
The schedule object associated with a flow schedule. This is used for scheduling jobs.
Show Source
-
endDate(required): string
(date-time)
The end date of a schedule.
-
predecessorFlowScheduleId(required): integer
(int64)
The predecessor ID of the schedule
-
scheduleExpression(required): string
The job schedule in CRON format.
-
scheduleId(required): integer
(int64)
The unique ID of the schedule generated by the system.
-
scheduleName(required): string
The name of the schedule.
-
startDate(required): string
(date-time)
The start date of a schedule.
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.
Nested Schema : eventInstanceConfigs
Type:
array
Unique Items Required:
true
A reference to the eventInstConfig object.
Show Source
-
Array of:
object EventInstanceConfig
Title:
EventInstanceConfig
The value of the event instance configuration.
Nested Schema : EventListener
Type:
object
Title:
EventListener
A reference to the event listener object.
Show Source
-
description(required): string
A description of the event listener.
-
flowSchedule(required): object
FlowSchedule
Title:
FlowSchedule
The flow schedule object associated with a flow instance. -
id(required): integer
(int64)
The unique ID of the event listener generated by the system.
-
name(required): string
The name of the event listener.
-
type(required): string
The type of event listener.
Nested Schema : EventInstanceConfig
Type:
object
Title:
EventInstanceConfig
The value of the event instance configuration.
Show Source
-
eventConfig(required): object
EventConfig
Title:
EventConfig
A reference to the eventConfig object. -
eventListenerInstance(required): object
EventListenerInstance
Title:
EventListenerInstance
A reference to the event listener instance object. -
id(required): integer
(int64)
The ID of the eventInstConfig object generated by the system.
-
value(required): string
The value of the event instance configuration.
Nested Schema : EventConfig
Type:
object
Title:
EventConfig
A reference to the eventConfig object.
Show Source
-
id(required): integer
(int64)
The unique ID of the event configuration generated by the system.
-
name(required): string
The name of the event configuration.
-
title(required): string
The title of the event configuration.
-
type(required): string
Allowed Values:
[ "String", "Integer", "Double", "Boolean", "HiddenString", "Criteria", "String,Integer,Double,Boolean,HiddenString,Criteria" ]
The type of event configuration. Choices include: String, Integer, Double, Boolen, HiddenString, and Criteria.
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.
404 Response
The requested business flow schedule does not exist, or you do not have access to it.