| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The Schedule ID |
integer |
None. |
| Name |
The name of the schedule |
string |
None. |
| Description |
Description of the schedule |
string |
None. |
| StartDate |
Start date and time for the schedule |
date |
None. |
| FinishDate |
Finish date and time for the schedule |
date |
None. |
| Progress |
The overall Progress of the Schedule |
decimal number |
None. |
| ApprovedDate |
The Date and Time when the Schedule was Approved |
date |
None. |
| ApprovedBy |
The integer ID of the User that Approved the Schedule |
integer |
None. |
| CancelledDate |
The Date and Time when the Schedule was Cancelled |
date |
None. |
| CancelledBy |
The integer ID of the User that Cancelled the Schedule |
integer |
None. |
| Status |
The status of the schedule (Enumeration: ScheduleState) |
ScheduleStatus |
None. |
| Message |
Generic-purpose string, used for reporting more specific information regarding errors |
string |
None. |
| Editable |
Whether or not the Schedule can be Edited |
boolean |
None. |
| Settings |
Optional settings that affect the running of the Schedule |
ScheduleSettings |
None. |
| Steps |
Steps for the schedule |
Collection of Step |
None. |