Navigation: Catalog: Hubdb3 > Schemas > Schema: Tables > Tables

TableColumnsForeignIdsByTableIdOrName

Get details of a published tableReturns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table.**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access. To do so, you'll need to include the HubSpot account ID in a `portalId` query parameter.

Catalog: Hubdb3

Schema: Tables

Label: {res:itgen_hubspot_tablecolumnsforeignidsbytableidorname_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 TableColumnsForeignIdsByTableIdOrName. 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	Documentation
archived	boolean	☐	Set this to `true` to return details for an archived table. Defaults to `false`.
includeForeignIds	boolean	☐	Set this to `true` to populate foreign ID values in the result.
isGetLocalizedSchema	boolean	☐
tableIdOrName	string	☑	The ID or name of the table to return.

Columns of Table Function

The columns of the table function TableColumnsForeignIdsByTableIdOrName are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
allowChildTables	boolean	Allow Child Tables	☐	Specifies whether child tables can be created
allowPublicApiAccess	boolean	Allow Public API Access	☐	Specifies whether the table can be read by public without authorization
columnCount	int32	Column Count	☐	Number of columns including deleted
createdAt_2	datetime	{res:itgen_hubspot_createdat_2}	☐	Timestamp at which the table is created
createdAt	datetime	Created at	☐
createdBy_email_2	string	{res:itgen_hubspot_createdby_email_2}	☐
createdBy_email	string	Created by Email	☐
createdBy_firstName_2	string	{res:itgen_hubspot_createdby_firstname_2}	☐
createdBy_firstName	string	Created by First Name	☐
createdBy_id_2	string	{res:itgen_hubspot_createdby_id_2}	☐
createdBy_id	string	Created by ID	☐
createdBy_lastName_2	string	{res:itgen_hubspot_createdby_lastname_2}	☐
createdBy_lastName	string	Created by Last Name	☐
createdByUserId	int32	{res:itgen_hubspot_createdbyuserid}	☐
deleted_2	boolean	{res:itgen_hubspot_deleted_2}	☐
deleted	boolean	Deleted	☐
description	string	Description	☐
dynamicMetaTags	string	Dynamic Meta Tags	☐	Specifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.
enableChildTablePages	boolean	Enable Child Table Pages	☐	Specifies creation of multi-level dynamic pages using child tables
foreignColumnId	int32	Foreign Column ID	☐	Foreign Column id
foreignIdsById	string	Foreign IDs by ID	☐	Foreign ids
foreignIdsByName	string	Foreign IDs by Name	☐	Foreign ids by name
foreignTableId	int64	Foreign Table ID	☐	Foreign table id referenced
id_2	string	ID (Alternate 2)	☐	Column Id
id_3	string	{res:itgen_hubspot_id_3}	☐	Id of the table
id	string	ID	☐
isOrderedManually	boolean	Is Ordered Manually	☐
label_2	string	Label (Alternate 2)	☐	Label of the table
label	string	Label	☐	Label of the column
name_2	string	Name (Alternate 2)	☐	Name of the column
name_3	string	{res:itgen_hubspot_name_3}	☐	Name of the table
name	string	Name	☐
optionCount	int32	Option Count	☐	Number of options available
published	boolean	Published	☐
publishedAt	datetime	Published at	☐	Timestamp at which the table is published recently
rowCount	int32	Row Count	☐	Number of rows in the table
type_2	string	{res:itgen_hubspot_type_2}	☐	Type of the column
type	string	Type	☐
updatedAt_2	datetime	{res:itgen_hubspot_updatedat_2}	☐	Timestamp at which the table is updated recently
updatedAt	datetime	Updated at	☐
updatedBy_email_2	string	{res:itgen_hubspot_updatedby_email_2}	☐
updatedBy_email	string	Updated by Email	☐
updatedBy_firstName_2	string	{res:itgen_hubspot_updatedby_firstname_2}	☐
updatedBy_firstName	string	Updated by First Name	☐
updatedBy_id_2	string	{res:itgen_hubspot_updatedby_id_2}	☐
updatedBy_id	string	Updated by ID	☐
updatedBy_lastName_2	string	{res:itgen_hubspot_updatedby_lastname_2}	☐
updatedBy_lastName	string	Updated by Last Name	☐
updatedByUserId	int32	Updated by User ID	☐
useForPages	boolean	Use for Pages	☐	Specifies whether the table can be used for creation of dynamic pages
width	int32	Width	☐	Column width for HubDB UI

18-12-2024 20:09 Version 24.1.33-BETA+5180

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

TableColumnsForeignIdsByTableIdOrName

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information