ScheduleEvents
Retrieves a list of schedule events associated with your employees or company.
Table Specific Information
Select
Query the ScheduleEvents table. The 本製品 will use the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the 本製品.
- Id and ScheduleCalendarId fields support the '=' and IN operators.
- Start supports the '>=' operator.
- End supports the '<=' operator.
- ActiveStatus filter, and 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'
Insert
Insert can be executed by specifying ScheduleCalendarId, Start, End and AllDay columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table
INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true') INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay, AssignedUserIds) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true', '11, 1365, 729')
Update
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE ScheduleEvents SET Title = 'New Title' WHERE Id = '14055'
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
Id of the schedule calendar. |
ScheduleCalendarId | Integer | True |
Id of the calendar that contains this event. |
Start | Datetime | False |
Date/time that represents the start time of this schedule event. |
End | Datetime | False |
Date/time that represents the end time of this schedule event. |
AllDay | Boolean | False |
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 | True |
Ids of the user(s) assigned to this event. Empty array if the event is unassigned. |
JobcodeId | String | False |
Id of the jobcode associated with this event. |
Active | Boolean | False |
Whether the event is active. If false, the event has been deleted/archived. |
Draft | Boolean | False |
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 | False |
Timezone of the schedule event. |
Title | String | False |
Title or name of this event. |
Notes | String | False |
Notes associated with the event. |
Location | String | False |
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 | False |
Hex color code assigned to this schedule event. |
Created | Datetime | True |
Date/time when this schedule event was created |
LastModified | Datetime | True |
Date/time when this schedule event was last modified. |
CustomFields | String | False |
Only present if the Advanced Tracking Add-on is installed. This is a key / value map of customfield ids to the customfield items that are associated with the event. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
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. |
ActiveUsers | Integer |
'0', '-1' or '1' . Default is '1'. Only schedule events whose users are active will be returned by default. 0 will return events for inactive users. -1 will return events for active and inactive users. |
ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |