Skip to main content

The type that defines the fields for a paginated result set of available schedule templates. The response consists of 0 or more sequenced pages where each page has 0 or more items.

Type that uses ScheduleTemplateResponse

ScheduleTemplateCollection

Calls that use ScheduleTemplateResponse

GET
/schedule_template/{schedule_template_id}
GET
/schedule_template

Fields

Field
Type
Description
feedType
string
The feed type of the schedule template.

Note: When calling createSchedule and updateSchedule methods you must match the feed type specified by the schedule template (this feedType).

frequency
FrequencyEnum
This field specifies how often the schedule is generated. If set to HALF_HOUR or ONE_HOUR, you cannot set a preferredTriggerHour using createSchedule or updateSchedule.
name
string
The template name provided by the template.
scheduleTemplateId
string
The ID of the template. Use this ID to create a schedule based on the properties of this schedule template.
status
StatusEnum
The present status of the template. You cannot create or modify a schedule using a template with an INACTIVE status.
supportedConfigurations
array of SupportedConfiguration
An array of the configuration supported by this template.