Get details for a draft table

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing Hub -Professional

Sales Hub -Grátis

Service Hub -Grátis

Content Hub -Professional

Escopos Necessários

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

tableIdOrName

string

required

O ID ou nome da tabela a ser retornada.

Query Parameters

archived

boolean

Defina como "true" para retornar uma tabela arquivada. O padrão é "false".

includeForeignIds

boolean

Defina como "true" para preencher os valores de ID externo no resultado.

isGetLocalizedSchema

boolean

Indica se deve recuperar o esquema localizado para a tabela.

Response

successful operation

allowChildTables

boolean

required

Especifica se as tabelas secundárias podem ser criadas

allowPublicApiAccess

boolean

required

Especifica se a tabela pode ser lida pelo público sem autorização

columnCount

integer<int32>

required

Número de colunas, incluindo as excluídas

columns

object[]

required

Lista de colunas na tabela

Mostrar atributos filhos

columns.deleted

boolean

required

Indicates whether the column has been deleted.

columns.description

string

required

The description of the column.

columns.id

string

required

ID da coluna

columns.label

string

required

Rótulo da coluna

columns.name

string

required

Nome da coluna

columns.type

enum<string>

required

Tipo de coluna

Opções disponíveis:

BOOLEAN,

CODE,

COMPOSITE,

CTA,

CURRENCY,

DATE,

DATETIME,

EMBED,

FILE,

FOREIGN_ID,

HUBSPOT_VIDEO,

IMAGE,

JSON,

LOCATION,

MULTISELECT,

NULL,

NUMBER,

RICHTEXT,

SELECT,

TEXT,

URL,

VIDEO

columns.createdAt

string<date-time>

The timestamp when the column was created.

columns.createdBy

object

Mostrar atributos filhos

columns.createdBy.email

string

required

The email address of the user.

columns.createdBy.firstName

string

required

The first name of the user.

columns.createdBy.id

string

required

The unique identifier for the user.

columns.createdBy.lastName

string

required

The last name of the user.

columns.createdByUserId

integer<int32>

The ID of the user who created the column.

columns.foreignColumnId

integer<int32>

ID de coluna externo

columns.foreignIds

object[]

IDs externos

Mostrar atributos filhos

columns.foreignIds.id

string

required

Unique identifier for the foreign ID.

columns.foreignIds.name

string

required

Name of the foreign ID.

columns.foreignIds.type

string

required

Type of the foreign ID.

columns.foreignIdsById

object

IDs externos

Mostrar atributos filhos

columns.foreignIdsById.{key}

object

Mostrar atributos filhos

columns.foreignIdsById.{key}.id

string

required

Unique identifier for the foreign ID.

columns.foreignIdsById.{key}.name

string

required

Name of the foreign ID.

columns.foreignIdsById.{key}.type

string

required

Type of the foreign ID.

columns.foreignIdsByName

object

IDs externos por nome

Mostrar atributos filhos

columns.foreignIdsByName.{key}

object

Mostrar atributos filhos

columns.foreignIdsByName.{key}.id

string

required

Unique identifier for the foreign ID.

columns.foreignIdsByName.{key}.name

string

required

Name of the foreign ID.

columns.foreignIdsByName.{key}.type

string

required

Type of the foreign ID.

columns.foreignTableId

integer<int64>

ID externo da tabela referenciado

columns.optionCount

integer<int32>

Número de opções disponíveis

columns.options

object[]

Opções para escolher para colunas de seleção única e múltipla

Mostrar atributos filhos

columns.options.createdAt

string<date-time>

required

A data e hora em que a opção foi criada, no formato ISO 8601.

columns.options.id

string

required

O ID exclusivo da opção.

columns.options.label

string

required

Um rótulo amigável que identifica a opção.

columns.options.name

string

required

Um nome interno atribuído à opção, diferente do rótulo.

columns.options.order

integer<int32>

required

The order in which the option appears, represented as an integer.

columns.options.type

string

required

Indica a categoria ou tipo de dado da opção (por exemplo, string, número).

columns.options.updatedAt

string<date-time>

required

A data e hora da última atualização da opção, no formato ISO 8601.

columns.options.createdBy

object

Mostrar atributos filhos

columns.options.createdBy.email

string

required

The email address of the user.

columns.options.createdBy.firstName

string

required

The first name of the user.

columns.options.createdBy.id

string

required

The unique identifier for the user.

columns.options.createdBy.lastName

string

required

The last name of the user.

columns.options.createdByUserId

integer<int32>

O ID do usuário que criou a opção.

columns.options.updatedBy

object

Mostrar atributos filhos

columns.options.updatedBy.email

string

required

The email address of the user.

columns.options.updatedBy.firstName

string

required

The first name of the user.

columns.options.updatedBy.id

string

required

The unique identifier for the user.

columns.options.updatedBy.lastName

string

required

The last name of the user.

columns.options.updatedByUserId

integer<int32>

O ID do usuário que atualizou a opção pela última vez.

columns.updatedAt

string<date-time>

The timestamp when the column was last updated.

columns.updatedBy

object

Mostrar atributos filhos

columns.updatedBy.email

string

required

The email address of the user.

columns.updatedBy.firstName

string

required

The first name of the user.

columns.updatedBy.id

string

required

The unique identifier for the user.

columns.updatedBy.lastName

string

required

The last name of the user.

columns.updatedByUserId

integer<int32>

The ID of the user who last updated the column.

columns.width

integer<int32>

Largura da coluna para a interface do HubDB

Example:

"{name: \"column1\""

createdAt

string<date-time>

required

A data e hora em que a tabela foi criada

deleted

boolean

required

Specifies whether the table is marked as deleted.

deletedAt

string<date-time>

required

The timestamp indicating when the table was deleted.

dynamicMetaTags

object

required

Especifica os pares de valores-chave dos campos de metadados com os IDs de coluna associados.

Mostrar atributos filhos

dynamicMetaTags.{key}

integer<int32>

enableChildTablePages

boolean

required

Especifica a criação de páginas dinâmicas de vários níveis usando tabelas secundárias

string

required

ID da tabela

label

string

required

Rótulo da tabela

name

string

required

Nome da tabela

published

boolean

required

Indicates whether the table is currently published.

publishedAt

string<date-time>

required

A data e hora em que a tabela foi publicada recentemente

rowCount

integer<int32>

required

Número de linhas na tabela

updatedAt

string<date-time>

required

A data e hora em que a tabela foi atualizada recentemente

useForPages

boolean

required

Especifica se a tabela pode ser usada para criação de páginas dinâmicas

createdBy

object

Mostrar atributos filhos

createdBy.email

string

required

The email address of the user.

createdBy.firstName

string

required

The first name of the user.

createdBy.id

string

required

The unique identifier for the user.

createdBy.lastName

string

required

The last name of the user.

isOrderedManually

boolean

Indicates whether the table rows are ordered manually.

updatedBy

object

Mostrar atributos filhos

updatedBy.email

string

required

The email address of the user.

updatedBy.firstName

string

required

The first name of the user.

updatedBy.id

string

required

The unique identifier for the user.

updatedBy.lastName

string

required

The last name of the user.

Posts de blog

Configurações do blog

Tags do blog

HubDB

Páginas

Autores do blog

Código fonte do CMS

Auditoria de conteúdo

Redirecionamentos de URL

Domínios

Media Bridge

Pesquisa do site

Arquivos

Get details for a draft table

Authorizations

Path Parameters

Query Parameters

Response