Defines the schema for configuring a schedule.
API Endpoint | |
|---|---|
Supported Methods |
|
Parameters
The Schedules object schema includes the following attributes:
Attribute | Description | Type | Example |
|---|---|---|---|
id | System-generated unique identifier for a schedule. | String |
|
name | User defined name for a schedule. | String |
|
description | Brief user defined summary of the schedule. | String |
|
starts_on | Date and time the schedule starts in Unix epoch format. | Long |
|
ends_on | Date and time the schedule ends in Unix epoch format. | Long |
|
duration | The calculated time between the | Long |
|
created_on | Date and time the schedule was created in Unix epoch format. | Long |
|
created_by | The ID of the user who created the schedule. | String |
|
updated_on | Date and time the plan was last updated in Unix epoch format. | Long |
|
updated_by | The ID of the user who last updated the schedule. | String |
|
active | Indicates if the schedule is active and will be processed on the start time. | Boolean |
|