The type that defines the fields for a schedule update to a schedule generated with the Feed API.
Types that use UpdateUserScheduleRequest
Not used by any types.
Call that uses UpdateUserScheduleRequest
Fields
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 actual number of days in the month.
This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Minimum: 1
Maximum: 31
This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Minimum: 1
Maximum: 31
preferredTriggerDayOfWeek
The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules.
This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
preferredTriggerHour
The preferred two-digit hour of the day to trigger the schedule.
This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Format: UTC
For example, the following represents 11:00 am UTC:
Minimum:
Maximum:
This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Format: UTC
hhZFor example, the following represents 11:00 am UTC:
11ZMinimum:
00ZMaximum:
23ZscheduleEndDate
The timestamp on which the schedule (report generation) ends. After this date, the schedule status becomes
Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Format: UTC
For example, the following represents UTC October 10, 2021 at 10:00 AM:
INACTIVE. Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Format: UTC
yyyy-MM-ddTHHZFor example, the following represents UTC October 10, 2021 at 10:00 AM:
2021-10-10T10ZscheduleStartDate
The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive.
Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Format: UTC
For example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM:
Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
Format: UTC
yyyy-MM-ddTHHZFor example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM:
2020-01-01T12Z