Favorites
Retrieve a user's favorites data via the API.
Table-Specific Information
SELECT
The provider processes all filters client-side within the provider. The following query is the only one processed server-side:
SELECT * FROM Favorites
INSERT
The following columns can be used to create a new record:
ObjectId, ObjectType
The following pseudo-columns can be used to create a new record:
Name, NextObjectId, NextObjectType, PrevObjectId, PrevObjectType
UPDATE
The following column can be updated:
FolderId
The following pseudo-columns can be used to update a record:
NextObjectId, NextObjectType, PrevObjectId, PrevObjectType
DELETE
You can delete entries by specifying the following columns:
ObjectId, ObjectType
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The favorite object's unique identifier. | |
| AccountId | String | True |
The ID of the account the favorite object belongs to. | |
| FolderId | String | False |
The unique identifier of the folder the favorite object is in (if applicable). | |
| HierarchyListDataId | String | True |
The list's unique identifier. | |
| HierarchyListDataType | String | True |
The list's type. | |
| ObjectId [KEY] | String | True |
The object's unique identifier. | |
| ObjectType [KEY] | String | True |
The object's type. | |
| Position | Double | True |
The favorite object's position within its list or folder. | |
| CreatedAt | Datetime | True |
The timestamp when the favorite object was created. | |
| UpdatedAt | Datetime | True |
The timestamp when the favorite object was last updated. |
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 |
| Name | String |
The name of the object to mark as a favorite. |
| NextObjectId | String |
The next object's unique identifier. |
| NextObjectType | String |
The next object's type. |
| PrevObjectId | String |
The previous object's unique identifier. |
| PrevObjectType | String |
The previous object's type. |