CustomFieldItemFilters
Create, Update and Query the Custom Field Item Filters in TSheets.
Table Specific Information
Select
Query the CustomFieldItemFilters table. The adapter will use the API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the adapter.
- Id supports the '=,IN'
- Active supports the '='
- JobCodeId supports the '='
- UserId supports the '='
- LastModified supports the '<,<=,>,>='
- GroupId supports the '='
- IncludeUserGroup supports the '='
- IncludeJobCodeFilters supports the '='
- SupplementalData supports the '='
For example, the following queries are processed server side:
SELECT * FROM CustomFieldItemFilters SELECT * FROM CustomFieldItemFilters WHERE Id = 11531340
Insert
Insert can be executed by specifying CustomFieldId, CustomFieldItemId, Active, AppliesTo, and AppliesToId column. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table
INSERT INTO CustomFieldItemFilters (CustomFieldId, Name, ShortCode) VALUES (1140610, 15027812, true, 'jobcodes', 73209298)
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 CustomFieldItemFilters SET Active = true WHERE Id = '15011650'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
Id of the CustomField Item filter. |
| CustomFieldId | Integer | True |
Id of the CustomField that this filter belongs to. |
| CustomFieldItemId | Integer | True |
Id of the CustomField item that this filter belongs to. |
| Active | Boolean | False |
Boolean value. If true, the custom field item filter is active and if false, the custom field item filter is archive. |
| AppliesTo | String | False |
Entity type this filter relates to. Together with applies_to_id, determines what this filtered item relates to. The possible values are: 'jobcodes', 'users', or 'groups'. For example: If this value was 'jobcodes' then the applies_to_id value would indicate which jobcode this filter referred to. If requested, the supplemental data will also contain this jobcode. |
| AppliesToId | Integer | False |
The jobcode, user, or group that this filter relates to. Together with applies_to, determines what this filtered item relates to. For example: If the value of the applies_to field was 'jobcodes' this value would indicate which jobcode this filter referred to. If requested, the supplemental data will also contain this jobcode. |
| LastModified | Datetime | True |
Date/time when this custom field item filter was last modified. |
Pseudo-Columns
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.
| Name | Type | Description |
| JobCodeId | Integer |
Limits the returned filters to only those for the specified jobcode_id. |
| UserId | Integer |
Limits the returned filters to only those for the specified user_id. You can also include items for this user's group automatically if you include the 'include_user_group' parameter. |
| GroupId | Integer |
Limits the returned filters to only those for the specified group_id. |
| IncludeUserGroup | Boolean |
If a user_id is supplied, will return filters for that user's group as well. |
| IncludeJobCodeFilters | Boolean |
If a user_id is supplied, will additionally return jobcode filters. |
| SupplementalData | Boolean |
Default value is 'yes'. Indicates whether supplemental data should be specified. |