CrmAssociationsVDefinitionsConfigurationsByFromObjectTypeToObjectType |
Retrieve association limitsRetrieve the configuration details for associations between two specified CRM object types. Use this endpoint to understand limits that have been set for specific association types.
Catalog: AssociationsSchema
Schema: Limits
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 CrmAssociationsVDefinitionsConfigurationsByFromObjectTypeToObjectType. 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 |
|---|---|---|---|---|
fromObjectType |
string |
☑ |
|
|
toObjectType |
string |
☑ |
|
|
Columns of Table Function
The columns of the table function CrmAssociationsVDefinitionsConfigurationsByFromObjectTypeToObjectType are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
category |
string |
Category |
☐ |
The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. |
label |
string |
Label |
☐ |
A descriptor providing context about the relationship between associated records. |
typeId |
int32 |
Type ID |
☐ |
A unique integer identifier for the association type within its category. |
userEnforcedMaxToObjectIds |
int32 |
|
☐ |
The maximum number of target object IDs that a user can enforce in an association. |
HubSpot API Data Model