RecurringSchedules

Overview

The definition of a series of work items that occur in a repeating pattern.

System fields

System fields are read-only fields found on most objects. These fields are automatically updated during API operations. To learn more see System Fields.

Standard fields

Field Name Details Required
AckAllJobs Type
Checkbox

Description
Indicates whether or not Resources are required to accept each Job in the Recurring Schedule separately.
Yes
Description Type
Text

Description
A brief description of the Recurring Schedule.

Must be between 0 and 255 characters
No
Name Type
Text

Description
The name generated for the Recurring Schedule. For example, RS-1234.

Must be between 0 and 80 characters
Yes
Pattern Type
Text

Description
A JSON object representing the recurrence pattern of the schedule, including frequency, start and end dates, time zone, and any exclusions.

Must be between 0 and null characters
No
Summary Type
Text

Description
A text description that provides more details about the recurring schedule than the shorter “Description” field.

Must be between 0 and 32768 characters
No

This object has the following related objects.

Name Details
ClientAvailabilities Object
Has many (ClientAvailabilities)

Description
Client Availabilities associated with the Recurring Schedule.
Jobs Object
Has many (Jobs)

Description
Jobs associated with the Recurring Schedule.