HubSpot API Data Model
TableRowsDraftByTableIdOrName |
Get rows from draft tableReturns rows in the `draft` version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.
Catalog: CMSHubdb
Schema: Rows
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive SQL 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 TableRowsDraftByTableIdOrName. 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 cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. |
tableIdOrName |
string |
☑ |
|
The ID or name of the table to query. |
Columns of Table Function
The columns of the table function TableRowsDraftByTableIdOrName are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
childTableId |
string |
Child Table ID |
☐ |
Specifies the value for the column child table id |
createdAt |
datetime |
Created at |
☐ |
Timestamp at which the row is created |
id |
string |
ID |
☐ |
The id of the table row |
name |
string |
Name |
☐ |
Specifies the value for `hs_name` column, which will be used as title in the dynamic pages |
path |
string |
Path |
☐ |
Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages |
publishedAt |
datetime |
Published at |
☐ |
|
updatedAt |
datetime |
Updated at |
☐ |
Timestamp at which the row is updated last time |
values |
string |
Values |
☐ |
List of key value pairs with the column name and column value |
17-08-2023 07:25 Version 22.1.262-BETA+4120
