Retrieves a list of schedule events associated with your employees or company.
Table Specific Information
Query the ScheduleEvents table. The driver will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver.
- Id and ScheduleCalendarId fields support the '=' and IN operators.
- Start supports the '>=' operator.
- End supports the '<=' operator.
- Active, Draft and TeamEvents fields support the '=' operator.
- LastModified field supports the <=,<,>=,>,= operators.
For example, the following queries are processed server side:
SELECT * FROM ScheduleEvents WHERE TeamEvents = 'instance' SELECT * FROM ScheduleEvents WHERE LastModified > '2019-01-01 18:30' AND Id IN (1,2,3) SELECT * FROM ScheduleEvents WHERE End <= '2019-12-31 18:00'
|Id [KEY]||Integer||Id of the schedule calendar.|
|ScheduleCalendarId||Integer||Id of the calendar that contains this event.|
|Start||Datetime||Date/time that represents the start time of this schedule event.|
|End||Datetime||Date/time that represents the end time of this schedule event.|
|AllDay||Boolean||If true, the event duration is all day on the day specified in start. If false, the event duration is determined by date/time specified in end.|
|AssignedUserIds||String||Ids of the user(s) assigned to this event. Empty array if the event is unassigned.|
|JobcodeId||String||Id of the jobcode associated with this event.|
|Active||Boolean||Whether the event is active. If false, the event has been deleted/archived.|
|Draft||Boolean||Whether the event the event is a draft. If false, the event is published. Saving a published event will send the appropriate event published notifications to the assigned users.|
|TimeZone||String||Timezone of the schedule event.|
|Title||String||Title or name of this event.|
|Notes||String||Notes associated with the event.|
|Loation||String||Location of the event. Location can be an address, business name, GPS coordinate, etc., so when users click on the location it will open it up in their mapping application.|
|Color||String||Hex color code assigned to this schedule event.|
|Created||Datetime||Date/time when this schedule event was created|
|LastModified||Datetime||Date/time when this schedule event was last modified.|
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
|TeamEvents||String||Possible values: base or instance. Default is 'instance'. If 'instance' is specified, events that are assigned to multiple users will be returned as individual single events for each assigned user. If 'base' is specified, events that are assigned to multiple users will be returned as one combined event for all assignees.|