| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID |
The Integer ID of the user this timetable is for.Either use this property or UserName to indicate the User this Timetable is for. If both are supplied, UserID takes preference and UserName is ignored. |
integer |
None. |
| UserName |
The UserName of the user this timetable is forEither use this property or UserID to indicate the User this Timetable is for. If both are supplied, UserID takes preference and UserName is ignored |
string |
None. |
| ID |
The Timetable ID |
integer |
None. |
| Name |
The name of the Timetable |
string |
None. |
| Description |
Description of the Timetable |
string |
None. |
| Enable |
Whether or not this is enabled |
boolean |
None. |
| Time |
Time for the Timetable to take effect, in UTC |
time interval |
None. |
| IntervalType |
Interval Type, i.e. Daily, Weekly, etc |
TimetableIntervalType |
None. |
| IntervalTypeName |
Name of the Interval Type, i.e. Daily, Weekly, etc |
string |
None. |
| IntervalSetting1 |
Interval Setting 1, usage dependent on the Interval Type. If the IntervalType is set to Daily, this indicates the recurrence period. i.e. recur every n days. If the IntervalType is set to Weekly, this indicates the recurrence period. i.e. recur every n weeks. If the IntervalType is set to Monthly, this is a bitfield indicating the months to run on, where Bit 0 is January and Bit 11 is December. i.e. setting this to 2987 (0b101110100010) indicates Feb/June/Aug/Sep/Oct/Dec. |
integer |
None. |
| IntervalSetting2 |
Interval Setting 2, usage dependent on the Interval Type. If the IntervalType is set to Daily, this is not currently used. If the IntervalType is set to Weekly, this is a bitfield indicating the Days of the Week to run on, where Bit 0 is Sunday and Bit 6 is Saturday. i.e. setting this to 62 (0b0111110) indicates Mon-Fri. If the IntervalType is set to Monthly, this is a bitfield indicating the Days of the Month to run on, where Bit 0 is the 1st and Bit 30 is the 31st. i.e. setting this to 15790320 (0b00000000111100001111000011110000) indicates 5-8, 13-16, 21-24. |
integer |
None. |
| Repeat |
Whether or not to repeat the timetable. If used, values must be provided for RepeatEvery and RepeatDuration |
boolean |
None. |
| RepeatEvery |
Number of minutes between each repeat |
integer |
None. |
| RepeatDuration |
Number of minutes to indicate the maximum amount of time to continue repeating the timetable for |
integer |
None. |
| LastInterval |
The last Date/Time for the last recur interval |
date |
None. |
| LastRun |
The last Date/Time that this timetable was run, indicating the last interval or the last repeat |
date |
None. |
| NextInterval |
The Date/Time for the next recur interval |
date |
None. |
| NextRun |
The Date/Time for the next run, either on an interval or a repeat |
date |
None. |
| ApprovalPeriod |
The period for approving the Timetable's target before it starts |
time interval |
None. |
| TargetID |
The Integer ID of the object that is acted upon in this Entry |
integer |
None. |
| TargetType |
The Type of target this is for, i.e. Program or Schedule. Schedule will be removed from this list once Programs are officially introduced. |
TimetableTargetType |
None. |