Returns all FlowSchedule business objects.
get
/gatewayapi/restapi/v1/synchronizations/list
Request
Query Parameters
-
deploymentName: string
The name of deployment.
-
flowDefinitiontype: string
The flow definition type.
Response
Supported Media Types
- application/json
200 Response
successful operation
The flow schedule object associated with a flow instance.
Root Schema : FlowSchedule
Type:
object
The flow schedule object associated with a flow instance.
Show Source
-
active:
boolean
Default Value:
false
An indicator which determines whether the flow schedule is active. -
description:
string
A description of the flow schedule.
-
destinationAppInstance:
object AppInstance
The list of application instances associated with a flow.
-
eventListenerInstance:
object EventProviderInstance
A reference to the event listener instance object.
-
externalStepStatus:
string
Custom external step status
-
flow:
object Flow
The flow object associated with a flow instance.
-
flowDefName:
string
The name of the flow definition.
-
flowInstRuns:
integer(int32)
The number of flow instance runs associated with a flow schedule.
-
id:
integer(int64)
The unique ID of the flow schedule generated by the system.
-
isParent:
boolean
Default Value:
false
The indicator that determines whether a flow schedule is a parent object. -
lastCompletionDate:
string(date-time)
The last completion date of the flow schedule.
-
lastJobRunStatus:
string
Allowed Values:
[ "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:
integer(int64)
The unique ID of the last job run in the flow schedule generated by the system.
-
lastStartDate:
string(date-time)
The last start date associated with the flow schedule.
-
maxRuns:
integer(int32)
The maximum number of runs allowed for a flow schedule.
-
name:
string
The name of the flow schedule.
-
nextRunDate:
string(date-time)
The next run date associated with a flow schedule.
-
noEndDate:
boolean
Default Value:
false
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:
integer(int64)
Previous FlowSchedule Id
-
recurring:
boolean
Default Value:
false
The indicator that determines whether a flow schedule recurs. -
schedule:
object Schedule
The schedule object associated with a flow schedule. This is used for scheduling jobs.
-
sourceAppInstance:
object AppInstance
The list of application instances associated with a flow.
-
status:
string
Allowed Values:
[ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]
The status of the flow schedule.
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.
Nested Schema : EventProviderInstance
Type:
object
A reference to the event listener instance object.
Show Source
-
delayInMinutes:
integer(int32)
The delay in minutes before triggering a event-based synchronization job.
-
eventDisabled:
boolean
Default Value:
false
The indicator which determines whether the event is disabled or eneabled. -
eventInstanceConfigs:
array eventInstanceConfigs
Unique Items Required:
true
A reference to the eventInstConfig object. -
eventListener:
object EventListener
A reference to the event listener object.
-
flowSchedule:
object FlowSchedule
The flow schedule object associated with a flow instance.
-
id:
integer(int64)
The unique ID of the event listener instance generated by the system.
Nested 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 : Schedule
Type:
object
The schedule object associated with a flow schedule. This is used for scheduling jobs.
Show Source
-
endDate:
string(date-time)
The end date of a schedule.
-
predecessorFlowScheduleId:
integer(int64)
The predecessor ID of the schedule
-
scheduleExpression:
string
The job schedule in CRON format.
-
scheduleId:
integer(int64)
The unique ID of the schedule generated by the system.
-
scheduleName:
string
The name of the schedule.
-
startDate:
string(date-time)
The start date of a schedule.
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 : 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 : eventInstanceConfigs
Type:
array
Unique Items Required:
true
A reference to the eventInstConfig object.
Show Source
-
[0]:
object InstanceConfig
The value of the event instance configuration.
Nested Schema : EventListener
Type:
object
A reference to the event listener object.
Show Source
-
description:
string
A description of the event listener.
-
flowSchedule:
object FlowSchedule
The flow schedule object associated with a flow instance.
-
id:
integer(int64)
The unique ID of the event listener generated by the system.
-
name:
string
The name of the event listener.
-
type:
string
The type of event listener.
Nested Schema : InstanceConfig
Type:
object
The value of the event instance configuration.
Show Source
-
eventConfig:
object EventProviderConfig
A reference to the eventConfig object.
-
eventListenerInstance:
object EventProviderInstance
A reference to the event listener instance object.
-
id:
integer(int64)
The ID of the eventInstConfig object generated by the system.
-
value:
string
The value of the event instance configuration.
Nested Schema : EventProviderConfig
Type:
object
A reference to the eventConfig object.
Show Source
-
id:
integer(int64)
The unique ID of the event configuration generated by the system.
-
name:
string
The name of the event configuration.
-
title:
string
The title of the event configuration.
-
type:
string
Allowed Values:
[ "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
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.
404 Response
The FlowSchedule does not exist or you do not have access to it.