The type that defines the fields for a paginated result set of available schedules. The response consists of 0 or more sequenced pages where each page has 0 or more items.
Type that uses UserScheduleResponse
Calls that use UserScheduleResponse
Fields
scheduleId
The ID of the schedule. This ID is generated when the schedule was created by the createSchedule method.
creationDate
The creation date of the schedule in hours based on the 24-hour Coordinated Universal Time (UTC) clock.
preferredTriggerDayOfMonth
The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the number of days in the month.
preferredTriggerDayOfWeek
The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules.
preferredTriggerHour
The preferred two-digit hour of the day to trigger the schedule.
Format: UTC
For example, the following represents 11:00 am UTC:
Format: UTC
hhZ
For example, the following represents 11:00 am UTC:
11Z
scheduleEndDate
The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes
INACTIVE
.scheduleName
The schedule name assigned by the user for the created schedule. Users assign this name for their reference.