feed APIv1.3.1

UserScheduleResponse

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

Field
Type
Description
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.
feedType
The feedType associated with the schedule.
lastModifiedDate
The date the schedule was last modified.
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 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.
scheduleStartDate
The timestamp that indicates the start of the report generation.
scheduleTemplateId
The ID of the template used to create this schedule.
schemaVersion
The schema version of the feedType for the schedule.
status
The enumeration value that indicates the state of the schedule.
statusReason
The reason the schedule is inactive.