FolderSearches |
Search foldersSearch for folders. Does not contain hidden or archived folders.
Catalog: BETA
Schema: Folders
Label: {res:itgen_hubspot_foldersearches_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function FolderSearches. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
after |
string |
☐ |
|
The maximum offset of items for a given search is 10000. Narrow your search down if you are reaching this limit. |
before |
string |
☐ |
|
|
createdAt |
datetime |
☐ |
|
Search for folders with the given creation timestamp. |
createdAtGte |
datetime |
☐ |
|
|
createdAtLte |
datetime |
☐ |
|
|
id |
string |
☐ |
|
Search folder by given ID. |
name |
string |
☐ |
|
Search for folders containing the specified name. |
parentFolderId |
int64 |
☐ |
|
Search for folders with the given parent folderId. |
path |
string |
☐ |
|
Search for folders by path. |
updatedAt |
datetime |
☐ |
|
Search for folder at given update timestamp. |
updatedAtGte |
datetime |
☐ |
|
|
updatedAtLte |
datetime |
☐ |
|
|
Columns of Table Function
The columns of the table function FolderSearches are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
archived |
boolean |
Archived |
☐ |
Marks whether the folder is deleted or not. |
archivedAt |
datetime |
Archived at |
☐ |
Timestamp of folder deletion. |
createdAt |
datetime |
Created at |
☐ |
Timestamp of folder creation. |
id |
string |
ID |
☐ |
ID of the folder. |
name |
string |
Name |
☐ |
Name of the folder. |
parentFolderId |
string |
Parent Folder ID |
☐ |
ID of the parent folder. |
path |
string |
Path |
☐ |
Path of the folder in the file manager. |
updatedAt |
datetime |
Updated at |
☐ |
Timestamp of the latest update to the folder. |
18-12-2024 20:09 Version 24.1.33-BETA+5180