Base Rápida (Editor Independente)

O Quickbase é uma plataforma de desenvolvimento de aplicativos que une equipes de TI e de negócios, permitindo que solucionadores de problemas de qualquer experiência técnica trabalhem juntos para criar com segurança e sustentabilidade um ecossistema de aplicativos. O Quickbase ajuda as empresas a acelerar a inovação contínua de processos exclusivos, permitindo o desenvolvimento de cidadãos em escala em uma plataforma comum.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadados do conector
Publicador	Troy Taylor, Hitachi Solutions
Site	https://www.quickbase.com/
Política de privacidade	https://www.quickbase.com/privacy
Categorias	Produtividade;Operações de TI

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Nome do host realm	cadeia	Especifique o nome do host do realm.	Verdade
Authorization	secureString	O token de usuário no formato "QB-USER-TOKEN yourToken".	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar um aplicativo	Atualiza as principais propriedades e/ou variáveis de aplicativo para um aplicativo específico. Todas as propriedades do aplicativo que você não especificar no corpo da solicitação permanecerão inalteradas.
Atualizar um campo	Atualiza as propriedades e as permissões personalizadas de um campo. A tentativa de atualizar determinadas propriedades pode fazer com que os dados existentes não obedeçam mais às novas propriedades do campo e possam ser rejeitados. Confira as descrições de opções, exclusivas e necessárias abaixo para situações específicas. Todas as propriedades do campo que você não especificar no corpo da solicitação permanecerão inalteradas.
Atualizar uma relação	Use esse ponto de extremidade para adicionar campos de pesquisa e campos de resumo a uma relação existente. A atualização de uma relação não excluirá os campos de pesquisa/resumo existentes.
Atualizar uma tabela	Atualiza as propriedades principais de uma tabela específica. Todas as propriedades da tabela que você não especificar no corpo da solicitação permanecerão inalteradas.
Baixar um anexo	Baixa o anexo de arquivo, com o conteúdo do anexo de arquivo codificado no formato base64. A resposta da API retorna o nome do `Content-Disposition` arquivo no cabeçalho. Metadados sobre arquivos podem ser recuperados dos pontos de extremidade /records e /reports, quando aplicável. Use esses pontos de extremidade para obter as informações necessárias para buscar arquivos.
Clonar um token de usuário	Clona o token de usuário autenticado. Todos os aplicativos associados a esse token são automaticamente associados ao novo token.
Consultar dados	Passe uma consulta na linguagem de consulta Quickbase. Retorna dados de registro com paginação inteligente com base no tamanho aproximado de cada registro. O objeto de metadados incluirá as informações necessárias para iterar sobre a resposta e coletar mais dados.
Copiar um aplicativo	Copia o aplicativo especificado. O novo aplicativo terá o mesmo esquema que o original. Veja abaixo as opções de cópia adicionais.
Criar um aplicativo	Cria um aplicativo em uma conta. Você deve ter direitos de criação de aplicativo na respectiva conta. As principais propriedades e variáveis de aplicativo podem ser definidas com essa API.
Criar um campo	Cria um campo dentro de uma tabela, incluindo as permissões personalizadas desse campo.
Criar um relacionamento	Cria uma relação em uma tabela, bem como campos de pesquisa/resumo. As relações só podem ser criadas para tabelas no mesmo aplicativo.
Criar uma tabela	Cria uma tabela em um aplicativo.
Desativar um token de usuário	Desativa o token de usuário autenticado. Depois que isso for feito, o token de usuário deverá ser reativado na interface do usuário.
Excluir campos	Exclui um ou muitos campos em uma tabela, com base na ID do campo. Isso também excluirá permanentemente todos os dados ou cálculos nesse campo.
Excluir registros	Exclui registros em uma tabela com base em uma consulta. Como alternativa, todos os registros na tabela podem ser excluídos.
Excluir um anexo	Exclui uma versão de anexo de arquivo. Metadados sobre arquivos podem ser recuperados dos pontos de extremidade /records e /reports, quando aplicável. Use esses pontos de extremidade para obter as informações necessárias para excluir versões de arquivo.
Excluir um aplicativo	Exclui um aplicativo inteiro, incluindo todas as tabelas e dados.
Excluir um relacionamento	Use esse ponto de extremidade para excluir uma relação inteira, incluindo todos os campos de pesquisa e resumo. O campo de referência na relação não será excluído.
Excluir um token de usuário	Exclui o token de usuário autenticado. Isso não é reversível.
Excluir uma tabela	Exclui uma tabela específica em um aplicativo, incluindo todos os dados dentro dela.
Executar um relatório	Executa um relatório com base em uma ID e retorna os dados subjacentes associados a ele. O formato dos dados variará com base no tipo de relatório. Relatórios que se concentram em dados de nível de registro (tabela, calendário etc.) retornam os registros individuais. Relatórios agregados (resumo, gráfico) retornarão as informações resumidas conforme configurado no relatório. Elementos específicos da interface do usuário não são retornados, como totais, médias e visualizações. Retorna dados com paginação inteligente com base no tamanho aproximado de cada registro. O objeto de metadados incluirá as informações necessárias para iterar sobre a resposta e coletar mais dados.
Executar uma fórmula	Permite a execução de uma fórmula por meio de uma chamada à API. Use esse método no código personalizado para obter o valor de volta de uma fórmula sem um campo discreto em um registro.
Inserir registros de atualização do andor	Insira e/ou atualize os registros em uma tabela. Nesta única chamada à API, inserções e atualizações podem ser enviadas. A atualização pode usar o campo de chave na tabela ou qualquer outro campo exclusivo com suporte. Consulte a página Tipos de campo para obter mais informações sobre como cada tipo de campo deve ser formatado. Essa operação permite o processamento incremental de registros bem-sucedidos, mesmo quando alguns dos registros falham. Nota: Esse ponto de extremidade dá suporte a um tamanho máximo de carga de 10 MB.
Obter campo	Obtém as propriedades de um campo individual, com base na ID do campo. As propriedades presentes em todos os tipos de campo são retornadas no nível superior. Propriedades exclusivas para um tipo específico de campo são retornadas sob o atributo 'properties'. Consulte a página Tipos de campo para obter mais detalhes sobre as propriedades de cada tipo de campo.
Obter campos para uma tabela	Obtém as propriedades de todos os campos em uma tabela específica. As propriedades de cada campo são as mesmas do campo Get.
Obter eventos de aplicativo	Obtenha uma lista de eventos que podem ser disparados com base em dados ou ações do usuário neste aplicativo, inclui: notificação por email, Lembretes, Assinaturas, Ações do QB, Webhooks, Automações disparadas por alteração de registro (não inclui agendadas).
Obter tabelas para um aplicativo	Obtém uma lista de todas as tabelas que existem em um aplicativo específico. As propriedades de cada tabela são as mesmas que são retornadas na tabela Get.
Obter todos os relacionamentos	Obtenha uma lista de todas as relações e suas definições para uma tabela específica. Detalhes são fornecidos para os lados pai e filho de relações dentro de um determinado aplicativo. Detalhes limitados são retornados para relações entre aplicativos.
Obter todos os relatórios de tabela	Obtenha o esquema (propriedades) de todos os relatórios de uma tabela. Se o usuário que executa a API for um administrador de aplicativos, a API também retornará todos os relatórios pessoais com a ID do usuário do proprietário.
Obter um app	Retorna as principais propriedades de um aplicativo, incluindo variáveis de aplicativo.
Obter um relatório	Obtenha o esquema (propriedades) de um relatório individual.
Obter um token temporário para um DBID	Use esse ponto de extremidade para obter um token de autorização temporário, com escopo para um aplicativo ou uma tabela. Em seguida, você pode usar esse token para fazer outras chamadas à API (consulte autorização). Esse token expira em 5 minutos.
Obter um uso de campo	Obtenha estatísticas de uso de campos únicos. Este é um resumo das informações que podem ser encontradas na tabela de uso das propriedades do campo.
Obter uma tabela	Obtém as propriedades de uma tabela individual que faz parte de um aplicativo.
Obter uso para todos os campos	Obtenha todas as estatísticas de uso de campo para uma tabela. Este é um resumo das informações que podem ser encontradas na tabela de uso das propriedades do campo.

Atualizar um aplicativo

ID da operação:: UpdateApp

Atualiza as principais propriedades e/ou variáveis de aplicativo para um aplicativo específico. Todas as propriedades do aplicativo que você não especificar no corpo da solicitação permanecerão inalteradas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name	True	string	O nome da variável.
value	value	True	string	O valor da variável.
nome	name		string	O nome do aplicativo.
descrição	description		string	A descrição do aplicativo.
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo.

Retornos

Atualizar resposta do aplicativo: updateAppResponse

Atualizar um campo

ID da operação:: UpdateField

Atualiza as propriedades e as permissões personalizadas de um campo. A tentativa de atualizar determinadas propriedades pode fazer com que os dados existentes não obedeçam mais às novas propriedades do campo e possam ser rejeitados. Confira as descrições de opções, exclusivas e necessárias abaixo para situações específicas. Todas as propriedades do campo que você não especificar no corpo da solicitação permanecerão inalteradas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
Auditadas	audited		boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase. Você só poderá definir essa propriedade como "true" se o aplicativo tiver logs de auditoria habilitados. Consulte Habilitar logs de alteração de dados em Logs de Auditoria do Quickbase.
fieldHelp	fieldHelp		string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
negrito	bold		boolean	Indica se o campo está configurado para exibição em negrito no produto.
required	required		boolean	Indica se o campo é necessário (ou seja, se cada registro deve ter um valor não nulo neste campo). Se você tentar alterar um campo de não necessário para necessário, e a tabela contiver atualmente registros com valores nulos nesse campo, você receberá um erro indicando que há valores nulos do campo. Nesse caso, você precisa encontrar e atualizar esses registros com valores nulos do campo antes de alterar o campo para necessário.
comments	comments		string	Os comentários inseridos nas propriedades do campo por um administrador.
doesTotal	doesTotal		boolean	Se esse campo totaliza em relatórios dentro do produto.
salvamento automático	autoSave		boolean	Se o campo de link salvará automaticamente.
defaultValueLuid	defaultValueLuid		integer	Valor de ID do usuário padrão.
maxVersions	maxVersions		integer	O número máximo de versões configuradas para um anexo de arquivo.
format	format		integer	O formato a ser exibido.
carryChoices	carryChoices		boolean	Se o campo deve carregar seus campos de múltipla escolha quando copiado.
comprimento máximo	maxLength		integer	O número máximo de caracteres permitido para entrada no Quickbase para este campo.
linkText	linkText		string	O valor de texto configurado que substitui a URL que os usuários veem no produto.
parentFieldId	parentFieldId		integer	A ID do campo de composição pai, quando aplicável.
displayTimezone	displayTimezone		boolean	Indica se o fuso horário deve ser exibido dentro do produto.
summaryTargetFieldId	summaryTargetFieldId		integer	A ID do campo que é usado para agregar valores do filho, quando aplicável. Isso exibirá 0 se a função de resumo não exigir uma seleção de campo (como contagem).
allowNewChoices	allowNewChoices		boolean	Indica se os usuários podem adicionar novas opções a uma lista de seleção.
defaultToday	defaultToday		boolean	Indica se o valor do campo é padrão hoje para novos registros.
Unidades	units		string	O rótulo de unidades.
lookupTargetFieldId	lookupTargetFieldId		integer	A ID do campo que é o destino na tabela pai para esta pesquisa.
SummaryFunction3	summaryFunction		string	O tipo de acúmulo para o campo resumo.
sourceFieldId	sourceFieldId		integer	A ID do campo de origem.
doesAverage	doesAverage		boolean	Se esse campo tem uma média em relatórios dentro do produto.
fórmula	formula		string	A fórmula do campo, conforme configurado no Quickbase.
decimalPlaces	decimalPlaces		integer	O número de casas decimais exibidas no produto para este campo.
displayMonth	displayMonth		string	Como exibir meses.
seeVersions	seeVersions		boolean	Indica se o usuário pode ver outras versões, além das mais recentes, de um anexo de arquivo dentro do produto.
numLines	numLines		integer	O número de linhas mostradas na Base Rápida para este campo de texto.
defaultKind	defaultKind		string	O tipo padrão do usuário.
displayEmail	displayEmail		string	Como o email é exibido.
coverText	coverText		string	Um texto amigável alternativo que pode ser usado para exibir um link no navegador.
currencySymbol	currencySymbol		string	O símbolo atual usado ao exibir valores de campo dentro do produto.
summaryQuery	summaryQuery		string	A consulta de resumo.
targetFieldId	targetFieldId		integer	A ID do campo de destino.
displayUser	displayUser		string	A opção configurada para como os usuários são exibidos dentro do produto.
blankIsZero	blankIsZero		boolean	Se um valor em branco é tratado como 0 em cálculos dentro do produto.
exacto	exact		boolean	Se uma correspondência exata é necessária para um link de relatório.
defaultDomain	defaultDomain		string	Domínio de email padrão.
defaultValue	defaultValue		string	O valor padrão configurado para um campo quando um novo registro é adicionado.
abreviar	abbreviate		boolean	Não mostre o protocolo de URL ao mostrar a URL.
formatoNúmero	numberFormat		integer	O formato usado para exibir valores numéricos no produto (decimal, separadores, grupo de dígitos).
targetTableName	targetTableName		string	O nome da tabela de destino do campo.
appearsAs	appearsAs		string	O texto do link, se vazio, a URL será usada como texto de link.
largura	width		integer	A largura de entrada html do campo no produto.
CurrencyFormat	currencyFormat		string	O formato de moeda usado ao exibir valores de campo dentro do produto.
displayImages	displayImages		boolean	Indica se as imagens serão exibidas para anexos de arquivo em formulários e relatórios dentro do produto.
displayDayOfWeek	displayDayOfWeek		boolean	Indica se o dia da semana deve ser exibido dentro do produto.
summaryReferenceFieldId	summaryReferenceFieldId		integer	A ID do campo que é a referência na relação deste resumo.
commaStart	commaStart		integer	O número de dígitos antes da exibição de vírgulas no produto, quando aplicável.
choices	choices		array of string	Uma matriz de entradas que existe para um campo que oferece opções para o usuário. Observe que essas opções se referem aos valores válidos de todos os registros adicionados no futuro. Você tem permissão para remover valores da lista de opções mesmo se houver registros existentes com esses valores neste campo. Eles serão exibidos em vermelho quando os usuários examinarem os dados no navegador, mas não houver outro efeito. Ao atualizar um campo com essa propriedade, as opções antigas são removidas e substituídas pelas novas opções.
targetTableId	targetTableId		string	A ID da tabela de destino.
displayRelative	displayRelative		boolean	Se o tempo de exibição deve ser exibido como relativo.
compositeFields	compositeFields		object
summaryTableId	summaryTableId		string	A tabela da qual o campo de resumo faz referência aos campos.
displayTime	displayTime		boolean	Indica se a hora deve ser exibida, além da data.
VersionMode	versionMode		string	Modos de versão para arquivos. Mantenha todas as versões versus mantenha a última versão.
snapFieldId	snapFieldId		integer	A ID do campo que é usado para os valores de instantâneo, quando aplicável.
hours24	hours24		boolean	Indica se o tempo de exibição deve ou não ser exibido no formato de 24 horas dentro do produto.
sortAlpha	sortAlpha		boolean	Se for para classificar em ordem alfabética, a classificação padrão é por ID de registro.
sortAsGiven	sortAsGiven		boolean	Indica se as entradas listadas são classificadas como inseridas em ordem alfabética.
hasExtension	hasExtension		boolean	Se esse campo tem uma extensão de telefone.
useNewWindow	useNewWindow		boolean	Indica se a URL deve abrir uma nova janela quando um usuário clica nela dentro do produto.
appendOnly	appendOnly		boolean	Se esse campo é somente acréscimo.
displayAsLink	displayAsLink		boolean	Indica se um campo que faz parte da relação deve ser mostrado como um hiperlink para o registro pai dentro do produto.
lookupReferenceFieldId	lookupReferenceFieldId		integer	A ID do campo que é a referência na relação para essa pesquisa.
appearsByDefault	appearsByDefault		boolean	Indica se o campo está marcado como padrão em relatórios.
único	unique		boolean	Indica se cada registro na tabela deve conter um valor exclusivo desse campo. Se você tentar alterar um campo de não exclusivo para exclusivo, e a tabela atualmente contiver registros com o mesmo valor desse campo, você receberá um erro. Nesse caso, você precisa encontrar e atualizar esses registros com valores duplicados do campo antes de alterar o campo para exclusivo.
função	role		string	A função associada a uma determinada permissão para o campo
permissionType	permissionType		string	A permissão dada à função para este campo
roleId	roleId		integer	A ID da função determinada
addToForms	addToForms		boolean	Se o campo que você está adicionando deve aparecer nos formulários.
etiqueta	label		string	O rótulo (nome) do campo.
findEnabled	findEnabled		boolean	Indica se o campo está marcado como pesquisável.
noWrap	noWrap		boolean	Indica se o campo está configurado para não encapsular quando exibido no produto.
ID do campo	fieldId	True	integer	O FID (identificador exclusivo) do campo.

Retornos

Atualizar resposta de campo: updateFieldResponse

Atualizar uma relação

ID da operação:: UpdateRelationship

Use esse ponto de extremidade para adicionar campos de pesquisa e campos de resumo a uma relação existente. A atualização de uma relação não excluirá os campos de pesquisa/resumo existentes.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
summaryFid	summaryFid		double	A ID do campo a ser resumida.
etiqueta	label		string	O rótulo do campo resumo.
AccumulationType	accumulationType	True	string	O tipo de acúmulo para o campo resumo.
where	where		string	O filtro, usando a linguagem de consulta Quickbase, que determina os registros a serem retornados.
lookupFieldIds	lookupFieldIds		array of integer	Uma matriz de IDs de campo na tabela pai que se tornará campos de pesquisa na tabela filho.
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela. Esta será a tabela filho.
ID da relação	relationshipId	True	double	A ID da relação. Esta é a ID do campo de referência na tabela filho.

Retornos

Atualizar resposta de relação: updateRelationshipResponse

Atualizar uma tabela

ID da operação:: UpdateTable

Atualiza as propriedades principais de uma tabela específica. Todas as propriedades da tabela que você não especificar no corpo da solicitação permanecerão inalteradas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo
nome	name		string	O nome da tabela.
pluralRecordName	pluralRecordName		string	O substantivo plural para registros na tabela. Se esse valor não for passado, o valor padrão será 'Records'.
singleRecordName	singleRecordName		string	O substantivo singular para registros na tabela. Se esse valor não for passado, o valor padrão será 'Record'.
descrição	description		string	A descrição da tabela. Se esse valor não for passado, o valor padrão estará em branco.
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.

Retornos

Atualizar resposta da tabela: updateTableResponse

Baixar um anexo

ID da operação:: DownloadFile

Baixa o anexo de arquivo, com o conteúdo do anexo de arquivo codificado no formato base64. A resposta da API retorna o nome do Content-Disposition arquivo no cabeçalho. Metadados sobre arquivos podem ser recuperados dos pontos de extremidade /records e /reports, quando aplicável. Use esses pontos de extremidade para obter as informações necessárias para buscar arquivos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
ID do Registro	recordId	True	integer	O identificador exclusivo do registro.
ID do campo	fieldId	True	integer	O identificador exclusivo do campo.
Número de Versão	versionNumber	True	integer	O número da versão do anexo do arquivo.

Retornos

response: string

Clonar um token de usuário

ID da operação:: CloneUserToken

Clona o token de usuário autenticado. Todos os aplicativos associados a esse token são automaticamente associados ao novo token.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name		string	O novo nome do token de usuário clonado.
descrição	description		string	A descrição do token de usuário clonado.

Retornos

Clonar resposta de token de usuário: cloneUserTokenResponse

Consultar dados

ID da operação:: RunQuery

Passe uma consulta na linguagem de consulta Quickbase. Retorna dados de registro com paginação inteligente com base no tamanho aproximado de cada registro. O objeto de metadados incluirá as informações necessárias para iterar sobre a resposta e coletar mais dados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ignorar	skip		integer	O número de registros a serem ignoradas.
compareWithAppLocalTime	compareWithAppLocalTime		boolean	Se a consulta deve ser executada em um campo de data e hora em relação à hora local do aplicativo. A consulta é executada com o tempo UTC por padrão.
top	top		integer	O número máximo de registros a serem exibidos.
where	where		string	O filtro, usando a linguagem de consulta Quickbase, que determina os registros a serem retornados. Se esse parâmetro for omitido, a consulta retornará todos os registros.
fieldId	fieldId		integer	O identificador exclusivo de um campo em uma tabela.
Grouping	grouping		string	Agrupar por com base em ASC (ordem crescente), DESC (ordem decrescente) ou valores iguais (valores iguais)
sortBy	sortBy		object	Por padrão, as consultas serão classificadas pelos campos de classificação fornecidos ou pela classificação padrão se a consulta não fornecer nenhum. Defina como false para evitar a classificação quando a ordem dos dados retornados não for importante. Retornar dados sem classificação pode melhorar o desempenho.
select	select		object
from	from	True	string	O identificador da tabela.

Retornos

Executar resposta de consulta: runQueryResponse

Copiar um aplicativo

ID da operação:: CopyApp

Copia o aplicativo especificado. O novo aplicativo terá o mesmo esquema que o original. Veja abaixo as opções de cópia adicionais.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name	True	string	O nome do aplicativo recém-copiado
descrição	description		string	A descrição do aplicativo recém-copiado
assignUserToken	assignUserToken		boolean	Se deve adicionar o token de usuário usado para fazer essa solicitação ao novo aplicativo
excludeFiles	excludeFiles		boolean	Se keepData for true, se os anexos de arquivo também devem ser copiados. Se keepData for false, essa propriedade será ignorada
keepData	keepData		boolean	Se os dados do aplicativo devem ser copiados junto com o esquema
usersAndRoles	usersAndRoles		boolean	Se for true, os usuários serão copiados junto com suas funções atribuídas. Se for falso, os usuários e as funções serão copiados, mas as funções não serão atribuídas
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo.

Retornos

Copiar resposta do aplicativo: copyAppResponse

Criar um aplicativo

ID da operação:: CreateApp

Cria um aplicativo em uma conta. Você deve ter direitos de criação de aplicativo na respectiva conta. As principais propriedades e variáveis de aplicativo podem ser definidas com essa API.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
assignToken	assignToken		boolean	Defina como true se você quiser atribuir o aplicativo ao token de usuário usado para criar o aplicativo. O padrão é false.
nome	name	True	string	O nome da variável.
value	value	True	string	O valor da variável.
nome	name	True	string	O nome do aplicativo. Você tem permissão para criar vários aplicativos com o mesmo nome, no mesmo realm, pois eles terão valores dbid diferentes. Pedimos que tenha cuidado em fazer isso.
descrição	description		string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.

Retornos

Criar resposta do aplicativo: createAppResponse

Criar um campo

ID da operação:: CreateField

Cria um campo dentro de uma tabela, incluindo as permissões personalizadas desse campo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
Auditadas	audited		boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase. Você só poderá definir essa propriedade como "true" se o aplicativo tiver logs de auditoria habilitados. Consulte Habilitar logs de alteração de dados em Logs de Auditoria do Quickbase.
fieldHelp	fieldHelp		string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
negrito	bold		boolean	Indica se o campo está configurado para exibição em negrito no produto.
comments	comments		string	Os comentários inseridos nas propriedades do campo por um administrador.
doesTotal	doesTotal		boolean	Se esse campo totaliza em relatórios dentro do produto.
salvamento automático	autoSave		boolean	Se o campo de link salvará automaticamente.
defaultValueLuid	defaultValueLuid		integer	Valor de ID do usuário padrão.
maxVersions	maxVersions		integer	O número máximo de versões configuradas para um anexo de arquivo.
format	format		integer	O formato a ser exibido.
carryChoices	carryChoices		boolean	Se o campo deve carregar seus campos de múltipla escolha quando copiado.
comprimento máximo	maxLength		integer	O número máximo de caracteres permitido para entrada no Quickbase para este campo.
linkText	linkText		string	O valor de texto configurado que substitui a URL que os usuários veem no produto.
parentFieldId	parentFieldId		integer	A ID do campo de composição pai, quando aplicável.
displayTimezone	displayTimezone		boolean	Indica se o fuso horário deve ser exibido dentro do produto.
allowNewChoices	allowNewChoices		boolean	Indica se os usuários podem adicionar novas opções a uma lista de seleção.
defaultToday	defaultToday		boolean	Indica se o valor do campo é padrão hoje para novos registros.
Unidades	units		string	O rótulo de unidades.
sourceFieldId	sourceFieldId		integer	A ID do campo de origem.
doesAverage	doesAverage		boolean	Se esse campo tem uma média em relatórios dentro do produto.
fórmula	formula		string	A fórmula do campo, conforme configurado no Quickbase.
decimalPlaces	decimalPlaces		integer	O número de casas decimais exibidas no produto para este campo.
displayMonth	displayMonth		string	Como exibir meses.
seeVersions	seeVersions		boolean	Indica se o usuário pode ver outras versões, além das mais recentes, de um anexo de arquivo dentro do produto.
numLines	numLines		integer	O número de linhas mostradas na Base Rápida para este campo de texto.
defaultKind	defaultKind		string	O tipo padrão do usuário.
displayEmail	displayEmail		string	Como o email é exibido.
coverText	coverText		string	Um texto amigável alternativo que pode ser usado para exibir um link no navegador.
currencySymbol	currencySymbol		string	O símbolo atual usado ao exibir valores de campo dentro do produto.
targetFieldId	targetFieldId		integer	A ID do campo de destino.
displayUser	displayUser		string	A opção configurada para como os usuários são exibidos dentro do produto.
blankIsZero	blankIsZero		boolean	Se um valor em branco é tratado como 0 em cálculos dentro do produto.
exacto	exact		boolean	Se uma correspondência exata é necessária para um link de relatório.
defaultDomain	defaultDomain		string	Domínio de email padrão.
defaultValue	defaultValue		string	O valor padrão configurado para um campo quando um novo registro é adicionado.
abreviar	abbreviate		boolean	Não mostre o protocolo de URL ao mostrar a URL.
formatoNúmero	numberFormat		integer	O formato usado para exibir valores numéricos no produto (decimal, separadores, grupo de dígitos).
targetTableName	targetTableName		string	O nome da tabela de destino do campo.
appearsAs	appearsAs		string	O texto do link, se vazio, a URL será usada como texto de link.
largura	width		integer	A largura de entrada html do campo no produto.
CurrencyFormat	currencyFormat		string	O formato de moeda usado ao exibir valores de campo dentro do produto.
displayImages	displayImages		boolean	Indica se as imagens serão exibidas para anexos de arquivo em formulários e relatórios dentro do produto.
displayDayOfWeek	displayDayOfWeek		boolean	Indica se o dia da semana deve ser exibido dentro do produto.
commaStart	commaStart		integer	O número de dígitos antes da exibição de vírgulas no produto, quando aplicável.
choices	choices		array of string	Uma matriz de entradas que existe para um campo que oferece opções para o usuário. Observe que essas opções se referem aos valores válidos de todos os registros adicionados no futuro. Você tem permissão para remover valores da lista de opções mesmo se houver registros existentes com esses valores neste campo. Eles serão exibidos em vermelho quando os usuários examinarem os dados no navegador, mas não houver outro efeito. Ao atualizar um campo com essa propriedade, as opções antigas são removidas e substituídas pelas novas opções.
targetTableId	targetTableId		string	A ID da tabela de destino.
displayRelative	displayRelative		boolean	Se o tempo de exibição deve ser exibido como relativo.
compositeFields	compositeFields		object
displayTime	displayTime		boolean	Indica se a hora deve ser exibida, além da data.
VersionMode	versionMode		string	Modos de versão para arquivos. Mantenha todas as versões versus mantenha a última versão.
snapFieldId	snapFieldId		integer	A ID do campo que é usado para os valores de instantâneo, quando aplicável.
hours24	hours24		boolean	Indica se o tempo de exibição deve ou não ser exibido no formato de 24 horas dentro do produto.
sortAlpha	sortAlpha		boolean	Se for para classificar em ordem alfabética, a classificação padrão é por ID de registro.
sortAsGiven	sortAsGiven		boolean	Indica se as entradas listadas são classificadas como inseridas em ordem alfabética.
hasExtension	hasExtension		boolean	Se esse campo tem uma extensão de telefone.
useNewWindow	useNewWindow		boolean	Indica se a URL deve abrir uma nova janela quando um usuário clica nela dentro do produto.
appendOnly	appendOnly		boolean	Se esse campo é somente acréscimo.
displayAsLink	displayAsLink		boolean	Indica se um campo que faz parte da relação deve ser mostrado como um hiperlink para o registro pai dentro do produto.
appearsByDefault	appearsByDefault		boolean	Indica se o campo está marcado como padrão em relatórios.
FieldType2	fieldType	True	string	Os tipos de campo, clique em qualquer um dos links de tipo de campo para obter mais informações.
função	role		string	A função associada a uma determinada permissão para o campo
permissionType	permissionType		string	A permissão dada à função para este campo
roleId	roleId		integer	A ID da função determinada
addToForms	addToForms		boolean	Se o campo que você está adicionando deve aparecer nos formulários.
etiqueta	label	True	string	O rótulo (nome) do campo.
findEnabled	findEnabled		boolean	Indica se o campo está marcado como pesquisável.
noWrap	noWrap		boolean	Indica se o campo está configurado para não encapsular quando exibido no produto.

Retornos

Criar resposta de campo: createFieldResponse

Criar um relacionamento

ID da operação:: CreateRelationship

Cria uma relação em uma tabela, bem como campos de pesquisa/resumo. As relações só podem ser criadas para tabelas no mesmo aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
summaryFid	summaryFid		double	A ID do campo a ser resumida.
etiqueta	label		string	O rótulo do campo resumo.
AccumulationType	accumulationType	True	string	O tipo de acúmulo para o campo resumo.
where	where		string	O filtro, usando a linguagem de consulta Quickbase, que determina os registros a serem retornados.
lookupFieldIds	lookupFieldIds		array of integer	Matriz de IDs de campo na tabela pai que se tornará campos de pesquisa na tabela filho.
parentTableId	parentTableId	True	string	A ID da tabela pai da relação.
etiqueta	label		string	O rótulo do campo de chave estrangeira.
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela. Esta será a tabela filho.

Retornos

Criar resposta de relação: createRelationshipResponse

Criar uma tabela

ID da operação:: CreateTable

Cria uma tabela em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo
nome	name	True	string	O nome da tabela.
pluralRecordName	pluralRecordName		string	O substantivo plural para registros na tabela. Se esse valor não for passado, o valor padrão será 'Records'.
singleRecordName	singleRecordName		string	O substantivo singular para registros na tabela. Se esse valor não for passado, o valor padrão será 'Record'.
descrição	description		string	A descrição da tabela. Se esse valor não for passado, o valor padrão estará em branco.

Retornos

Criar resposta de tabela: createTableResponse

Desativar um token de usuário

ID da operação:: DeactivateUserToken

Desativa o token de usuário autenticado. Depois que isso for feito, o token de usuário deverá ser reativado na interface do usuário.

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	id

Excluir campos

ID da operação:: DeleteFields

Exclui um ou muitos campos em uma tabela, com base na ID do campo. Isso também excluirá permanentemente todos os dados ou cálculos nesse campo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
fieldIds	fieldIds	True	array of integer	Lista de IDs de campo a serem excluídas.

Retornos

Excluir resposta de campos: deleteFieldsResponse

Excluir registros

ID da operação:: DeleteRecords

Exclui registros em uma tabela com base em uma consulta. Como alternativa, todos os registros na tabela podem ser excluídos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
from	from	True	string	O identificador exclusivo da tabela.
where	where	True	string	O filtro para excluir registros. Para excluir todos os registros, especifique um filtro que incluirá todos os registros, por exemplo {3.GT.0} em que 3 é a ID do campo ID do registro.

Retornos

Excluir resposta de registros: deleteRecordsResponse

Excluir um anexo

ID da operação:: DeleteFile

Exclui uma versão de anexo de arquivo. Metadados sobre arquivos podem ser recuperados dos pontos de extremidade /records e /reports, quando aplicável. Use esses pontos de extremidade para obter as informações necessárias para excluir versões de arquivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
ID do Registro	recordId	True	integer	O identificador exclusivo do registro.
ID do campo	fieldId	True	integer	O identificador exclusivo do campo.
Número de Versão	versionNumber	True	integer	O número da versão do anexo do arquivo.

Retornos

Excluir resposta de arquivo: deleteFileResponse

Excluir um aplicativo

ID da operação:: DeleteApp

Exclui um aplicativo inteiro, incluindo todas as tabelas e dados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name	True	string	Para confirmar a exclusão do aplicativo, pedimos o nome do aplicativo.
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo.

Retornos

Excluir resposta do aplicativo: deleteAppResponse

Excluir um relacionamento

ID da operação:: DeleteRelationship

Use esse ponto de extremidade para excluir uma relação inteira, incluindo todos os campos de pesquisa e resumo. O campo de referência na relação não será excluído.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela. Esta será a tabela filho.
ID da relação	relationshipId	True	double	A ID da relação. Esta é a ID do campo de referência na tabela filho.

Retornos

Excluir resposta de relação: deleteRelationshipResponse

Excluir um token de usuário

ID da operação:: DeleteUserToken

Exclui o token de usuário autenticado. Isso não é reversível.

Retornos

Excluir resposta do token de usuário: deleteUserTokenResponse

Excluir uma tabela

ID da operação:: DeleteTable

Exclui uma tabela específica em um aplicativo, incluindo todos os dados dentro dela.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.

Retornos

Excluir Resposta da Tabela: deleteTableResponse

Executar um relatório

ID da operação:: RunReport

Executa um relatório com base em uma ID e retorna os dados subjacentes associados a ele. O formato dos dados variará com base no tipo de relatório. Relatórios que se concentram em dados de nível de registro (tabela, calendário etc.) retornam os registros individuais. Relatórios agregados (resumo, gráfico) retornarão as informações resumidas conforme configurado no relatório. Elementos específicos da interface do usuário não são retornados, como totais, médias e visualizações. Retorna dados com paginação inteligente com base no tamanho aproximado de cada registro. O objeto de metadados incluirá as informações necessárias para iterar sobre a resposta e coletar mais dados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador da tabela do relatório.
Ignorar	skip		integer	O número de registros a serem ignoradas. Você pode definir esse valor ao paginar por meio de um conjunto de resultados.
TOP	top		integer	O número máximo de registros a serem retornados. Você pode substituir a paginação de Base Rápida padrão para obter mais ou menos resultados. Se o valor solicitado aqui exceder os máximos dinâmicos, retornaremos um subconjunto de resultados e o restante poderá ser coletado em chamadas à API subsequentes.
			object
ID do Relatório	reportId	True	string	O identificador do relatório, exclusivo da tabela.

Retornos

Executar resposta de relatório: runReportResponse

Executar uma fórmula

ID da operação:: RunFormula

Permite a execução de uma fórmula por meio de uma chamada à API. Use esse método no código personalizado para obter o valor de volta de uma fórmula sem um campo discreto em um registro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
fórmula	formula	True	string	A fórmula a ser executada. Essa deve ser uma fórmula de Base Rápida válida.
livrar	rid		integer	A ID do registro em que executar a fórmula. Necessário apenas para fórmulas que são executadas no contexto de um registro. Por exemplo, a fórmula User() não precisa de uma ID de registro.
from	from	True	string	O identificador exclusivo (dbid) da tabela.

Retornos

Executar resposta de fórmula: runFormulaResponse

Inserir registros de atualização do andor

ID da operação:: UpsertRecords

Insira e/ou atualize os registros em uma tabela. Nesta única chamada à API, inserções e atualizações podem ser enviadas. A atualização pode usar o campo de chave na tabela ou qualquer outro campo exclusivo com suporte. Consulte a página Tipos de campo para obter mais informações sobre como cada tipo de campo deve ser formatado. Essa operação permite o processamento incremental de registros bem-sucedidos, mesmo quando alguns dos registros falham.
Nota: Esse ponto de extremidade dá suporte a um tamanho máximo de carga de 10 MB.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
para	to	True	string	O identificador da tabela.
dados	data		object
mergeFieldId	mergeFieldId		integer	A ID do campo de mesclagem.
fieldsToReturn	fieldsToReturn		array of integer	Especifique uma matriz de IDs de campo que retornarão dados para atualizações ou registro adicionado. A ID do registro (FID 3) sempre será retornada se qualquer ID de campo for solicitada.

Retornos

Uma resposta bem-sucedida que inclui detalhes sobre os registros adicionados, atualizados ou inalterados. No exemplo abaixo, a tabela anteriormente tinha dez registros com IDs de 1 a 10. O usuário posta um upsert que atualiza o valor do registro 1 e adiciona dois novos registros, todos com êxito.

Resposta upsert: upsertResponse

Obter campo

ID da operação:: GetField

Obtém as propriedades de um campo individual, com base na ID do campo.
As propriedades presentes em todos os tipos de campo são retornadas no nível superior. Propriedades exclusivas para um tipo específico de campo são retornadas sob o atributo 'properties'. Consulte a página Tipos de campo para obter mais detalhes sobre as propriedades de cada tipo de campo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.
Incluir permissões de campo	includeFieldPerms		boolean	Defina como 'true' se você quiser obter de volta as permissões personalizadas para os campos.
ID do campo	fieldId	True	integer	O FID (identificador exclusivo) do campo.

Retornos

Obter resposta de campo: getFieldResponse

Obter campos para uma tabela

ID da operação:: GetFields

Obtém as propriedades de todos os campos em uma tabela específica. As propriedades de cada campo são as mesmas do campo Get.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.
Incluir permissões de campo	includeFieldPerms		boolean	Defina como 'true' se você quiser obter de volta as permissões personalizadas para os campos.

Retornos

Nome	Caminho	Tipo	Description
		array of object
ID	id	integer	O identificador.
Etiqueta	label	string	O rótulo.
Tipo de campo	fieldType	string	O tipo de campo.
Sem encapsulamento	noWrap	boolean	Se não há quebra automática.
Negrito	bold	boolean	Seja negrito.
Obrigatório	required	boolean	Se necessário.
Aparece por padrão	appearsByDefault	boolean	Se aparece por padrão.
Localizar Habilitado	findEnabled	boolean	Se a localização está habilitada.
Único	unique	boolean	Seja exclusivo.
Copia dados	doesDataCopy	boolean	Se os dados são copiados.
Ajuda de campo	fieldHelp	string	A ajuda do campo.
Auditadas	audited	boolean	Se auditado.
Chave Primária	properties.primaryKey	boolean	Se a chave primária.
Chave estrangeira	properties.foreignKey	boolean	Se a chave estrangeira.
Linhas num	properties.numLines	integer	O número de linhas.
Comprimento Máximo	properties.maxLength	integer	O comprimento máximo.
Somente acréscimo	properties.appendOnly	boolean	Se acrescentar somente.
allowHTML	properties.allowHTML	boolean	Se deseja permitir HTML.
Classificar conforme dado	properties.sortAsGiven	boolean	Se classificar como dado.
Opções de transporte	properties.carryChoices	boolean	Se deve levar opções.
Permitir novas opções	properties.allowNewChoices	boolean	Se deseja permitir novas opções.
Formula	properties.formula	string	A fórmula.
Valor Padrão	properties.defaultValue	string	O valor padrão.
Formato de número	properties.numberFormat	integer	O formato de número.
Casas Decimais	properties.decimalPlaces	integer	As casas decimais.
Faz Média	properties.doesAverage	boolean	Se a média é média.
Faz Total	properties.doesTotal	boolean	Se o total é total.
Blank Is Zero	properties.blankIsZero	boolean	Se em branco é zero.
Permissions	permissions	array of object
Tipo de permissão	permissions.permissionType	string	O tipo de permissão.
Função	permissions.role	string	A função.
ID de Função	permissions.roleId	integer	O identificador da função.
Adicionar aos Formulários	addToForms	boolean	Se deve ser adicionado aos formulários.

Obter eventos de aplicativo

ID da operação:: GetAppEvents

Obtenha uma lista de eventos que podem ser disparados com base em dados ou ações do usuário neste aplicativo, inclui: notificação por email, Lembretes, Assinaturas, Ações do QB, Webhooks, Automações disparadas por alteração de registro (não inclui agendadas).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo.

Retornos

Nome	Caminho	Tipo	Description
		array of object
Tipo	type	string	O tipo.
Email	owner.email	string	O endereço de email do proprietário.
ID	owner.id	string	O identificador do proprietário.
Nome	owner.name	string	O nome do proprietário.
Nome do usuário	owner.userName	string	O nome de usuário do proprietário.
Está ativo	isActive	boolean	Se está ativo.
ID da tabela	tableId	string	O identificador da tabela.
Nome	name	string	O nome.
URL	url	string	O endereço da URL.

Obter tabelas para um aplicativo

ID da operação:: GetAppTables

Obtém uma lista de todas as tabelas que existem em um aplicativo específico. As propriedades de cada tabela são as mesmas que são retornadas na tabela Get.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo

Retornos

Nome	Caminho	Tipo	Description
		array of object
Nome	name	string	O nome.
Criado	created	string	Quando criado.
Atualizado	updated	string	Quando atualizado.
Alias	alias	string	O alias.
Description	description	string	A descrição.
ID	id	string	O identificador.
Próxima ID do Registro	nextRecordId	integer	O identificador do próximo registro.
ID do próximo campo	nextFieldId	integer	O identificador do próximo campo.
ID do campo de classificação padrão	defaultSortFieldId	integer	O identificador do campo de classificação padrão.
Ordem de Classificação Padrão	defaultSortOrder	string	A ordem de classificação padrão.
ID do campo de chave	keyFieldId	integer	O identificador do campo de chave.
Nome do registro único	singleRecordName	string	O nome do registro único.
Nome do Registro Plural	pluralRecordName	string	O nome do registro plural.
Limite de tamanho	sizeLimit	string	O limite de tamanho.
Espaço Usado	spaceUsed	string	O espaço usado.
Espaço Restante	spaceRemaining	string	O espaço restante.

Obter todos os relacionamentos

ID da operação:: GetRelationships

Obtenha uma lista de todas as relações e suas definições para uma tabela específica. Detalhes são fornecidos para os lados pai e filho de relações dentro de um determinado aplicativo. Detalhes limitados são retornados para relações entre aplicativos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ignorar	skip		integer	O número de relações a serem ignoradas.
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.

Retornos

Obter resposta de relações: getRelationshipsResponse

Obter todos os relatórios de tabela

ID da operação:: GetTableReports

Obtenha o esquema (propriedades) de todos os relatórios de uma tabela. Se o usuário que executa a API for um administrador de aplicativos, a API também retornará todos os relatórios pessoais com a ID do usuário do proprietário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.

Retornos

Nome	Caminho	Tipo	Description
		array of object
ID	id	string	O identificador.
Nome	name	string	O nome.
Tipo	type	string	O tipo.
Description	description	string	A descrição.
ID do Proprietário	ownerId	string	O identificador do proprietário.
Usado Por Último	usedLast	string	Quando usado pela última vez.
Contagem usada	usedCount	integer	A contagem usada.

Obter um app

ID da operação:: GetApp

Retorna as principais propriedades de um aplicativo, incluindo variáveis de aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo.

Retornos

Obter resposta do aplicativo: getAppResponse

Obter um relatório

ID da operação:: GetReport

Obtenha o esquema (propriedades) de um relatório individual.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
ID do Relatório	reportId	True	string	O identificador do relatório, exclusivo da tabela.

Retornos

Obter resposta do relatório: getReportResponse

Obter um token temporário para um DBID

ID da operação:: GetTempTokenDBID

Use esse ponto de extremidade para obter um token de autorização temporário, com escopo para um aplicativo ou uma tabela. Em seguida, você pode usar esse token para fazer outras chamadas à API (consulte autorização). Esse token expira em 5 minutos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Token de Aplicativo	QB-App-Token		string	Seu token de aplicativo quickbase
DBID	dbid	True	string	O identificador exclusivo de um aplicativo ou tabela.

Retornos

getTempTokenDBIDResponse: getTempTokenDBIDResponse

Obter um uso de campo

ID da operação:: GetFieldUsage

Obtenha estatísticas de uso de campos únicos. Este é um resumo das informações que podem ser encontradas na tabela de uso das propriedades do campo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.
ID do campo	fieldId	True	integer	O FID (identificador exclusivo) do campo.

Retornos

Nome	Caminho	Tipo	Description
		array of object
ID	field.id	integer	O identificador.
Nome	field.name	string	O nome.
Tipo	field.type	string	O tipo.
Contagem	usage.actions.count	integer	A contagem.
Contagem	usage.appHomePages.count	integer	A contagem.
Contagem	usage.defaultReports.count	integer	A contagem.
Contagem	usage.exactForms.count	integer	A contagem.
Contagem	usage.fields.count	integer	A contagem.
Contagem	usage.forms.count	integer	A contagem.
Contagem	usage.notifications.count	integer	A contagem.
Contagem	usage.personalReports.count	integer	A contagem.
Contagem	usage.relationships.count	integer	A contagem.
Contagem	usage.reminders.count	integer	A contagem.
Contagem	usage.reports.count	integer	A contagem.
Contagem	usage.roles.count	integer	A contagem.
Contagem	usage.webhooks.count	integer	A contagem.

Obter uma tabela

ID da operação:: GetTable

Obtém as propriedades de uma tabela individual que faz parte de um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Aplicativo	appId	True	string	O identificador exclusivo de um aplicativo
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.

Retornos

Obter resposta de tabela: getTableResponse

Obter uso para todos os campos

ID da operação:: GetFieldsUsage

Obtenha todas as estatísticas de uso de campo para uma tabela. Este é um resumo das informações que podem ser encontradas na tabela de uso das propriedades do campo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tabela	tableId	True	string	O DBID (identificador exclusivo) da tabela.
Ignorar	skip		integer	O número de campos a serem pulados da lista.
TOP	top		integer	O número máximo de campos a serem retornados.

Retornos

Nome	Caminho	Tipo	Description
		array of object
ID	field.id	integer	O identificador.
Nome	field.name	string	O nome.
Tipo	field.type	string	O tipo.
Contagem	usage.actions.count	integer	A contagem.
Contagem	usage.appHomePages.count	integer	A contagem.
Contagem	usage.defaultReports.count	integer	A contagem.
Contagem	usage.exactForms.count	integer	A contagem.
Contagem	usage.fields.count	integer	A contagem.
Contagem	usage.forms.count	integer	A contagem.
Contagem	usage.notifications.count	integer	A contagem.
Contagem	usage.personalReports.count	integer	A contagem.
Contagem	usage.relationships.count	integer	A contagem.
Contagem	usage.reminders.count	integer	A contagem.
Contagem	usage.reports.count	integer	A contagem.
Contagem	usage.roles.count	integer	A contagem.
Contagem	usage.webhooks.count	integer	A contagem.

Definições

createAppResponse

Nome	Caminho	Tipo	Description
nome	name	string	O nome do aplicativo. Você tem permissão para criar vários aplicativos com o mesmo nome, no mesmo realm, pois eles terão valores dbid diferentes. Pedimos que tenha cuidado em fazer isso.
descrição	description	string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.
criadas	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
atualizado	updated	string	A hora e a data em que o aplicativo foi atualizado pela última vez, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
dateFormat	dateFormat	string	Uma descrição do formato usado ao exibir valores de data neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página Detalhes do tipo Campo no Guia de API para saber como os valores de tempo são retornados em chamadas à API. Consulte Sobre a Localização de Datas para definir o formato de data do aplicativo.
Fuso horário	timeZone	string	Uma descrição do fuso horário usado ao exibir valores de tempo neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página detalhes do tipo Campo no portal para saber como os valores de tempo são retornados em chamadas à API. Consulte Definir o fuso horário para o aplicativo e a conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Compartilhamento de aplicativos com Todos na Internet (EOTI).
variables	variables	array of Variable1	As variáveis do aplicativo. Consulte sobre variáveis de aplicativo
dataClassification	dataClassification	string	O rótulo de Classificação de Dados atribuído ao aplicativo. Se a Classificação de Dados não estiver ativada, isso não será retornado. Se a Classificação de Dados estiver ativada, mas o aplicativo não for rotulado, retornaremos "Nenhum". Os rótulos de Classificação de Dados podem ser adicionados no Console de Administração por um Administrador de Realm para planos do Platform+.

Variável1

Nome	Caminho	Tipo	Description
nome	name	string	Nome da variável.
value	value	string	Valor da variável.

getAppResponse

Nome	Caminho	Tipo	Description
nome	name	string	O nome do aplicativo. Você tem permissão para criar vários aplicativos com o mesmo nome, no mesmo realm, pois eles terão valores dbid diferentes. Pedimos que tenha cuidado em fazer isso.
descrição	description	string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.
criadas	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
atualizado	updated	string	A hora e a data em que o aplicativo foi atualizado pela última vez, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
dateFormat	dateFormat	string	Uma descrição do formato usado ao exibir valores de data neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página Detalhes do tipo Campo no Guia de API para saber como os valores de tempo são retornados em chamadas à API. Consulte Sobre a Localização de Datas para definir o formato de data do aplicativo.
Fuso horário	timeZone	string	Uma descrição do fuso horário usado ao exibir valores de tempo neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página detalhes do tipo Campo no portal para saber como os valores de tempo são retornados em chamadas à API. Consulte Definir o fuso horário para o aplicativo e a conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Compartilhamento de aplicativos com Todos na Internet (EOTI).
variables	variables	array of Variable1	As variáveis do aplicativo. Consulte sobre variáveis de aplicativo
dataClassification	dataClassification	string	O rótulo de Classificação de Dados atribuído ao aplicativo. Se a Classificação de Dados não estiver ativada, isso não será retornado. Se a Classificação de Dados estiver ativada, mas o aplicativo não for rotulado, retornaremos "Nenhum". Os rótulos de Classificação de Dados podem ser adicionados no Console de Administração por um Administrador de Realm para planos do Platform+.

updateAppResponse

Nome	Caminho	Tipo	Description
nome	name	string	O nome do aplicativo. Você tem permissão para criar vários aplicativos com o mesmo nome, no mesmo realm, pois eles terão valores dbid diferentes. Pedimos que tenha cuidado em fazer isso.
descrição	description	string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.
criadas	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
atualizado	updated	string	A hora e a data em que o aplicativo foi atualizado pela última vez, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
dateFormat	dateFormat	string	Uma descrição do formato usado ao exibir valores de data neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página Detalhes do tipo Campo no Guia de API para saber como os valores de tempo são retornados em chamadas à API. Consulte Sobre a Localização de Datas para definir o formato de data do aplicativo.
Fuso horário	timeZone	string	Uma descrição do fuso horário usado ao exibir valores de tempo neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página detalhes do tipo Campo no portal para saber como os valores de tempo são retornados em chamadas à API. Consulte Definir o fuso horário para o aplicativo e a conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Compartilhamento de aplicativos com Todos na Internet (EOTI).
variables	variables	array of Variable1	As variáveis do aplicativo. Consulte sobre variáveis de aplicativo
dataClassification	dataClassification	string	O rótulo de Classificação de Dados atribuído ao aplicativo. Se a Classificação de Dados não estiver ativada, isso não será retornado. Se a Classificação de Dados estiver ativada, mas o aplicativo não for rotulado, retornaremos "Nenhum". Os rótulos de Classificação de Dados podem ser adicionados no Console de Administração por um Administrador de Realm para planos do Platform+.

deleteAppResponse

Nome	Caminho	Tipo	Description
deletedAppId	deletedAppId	string	Uma ID do aplicativo excluído.

copyAppResponse

Nome	Caminho	Tipo	Description
nome	name	string	O nome do aplicativo. Você tem permissão para criar vários aplicativos com o mesmo nome, no mesmo realm, pois eles terão valores dbid diferentes. Pedimos que tenha cuidado em fazer isso.
descrição	description	string	A descrição do aplicativo
criadas	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
atualizado	updated	string	A hora e a data em que o aplicativo foi atualizado pela última vez, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
dateFormat	dateFormat	string	Uma descrição do formato usado ao exibir valores de data neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página Detalhes do tipo Campo no Guia de API para saber como os valores de tempo são retornados em chamadas à API. Consulte Sobre a Localização de Datas para definir o formato de data do aplicativo.
Fuso horário	timeZone	string	Uma descrição do fuso horário usado ao exibir valores de tempo neste aplicativo. Observe que este é um parâmetro somente do navegador – consulte a página detalhes do tipo Campo no portal para saber como os valores de tempo são retornados em chamadas à API. Consulte Definir o fuso horário para o aplicativo e a conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Compartilhamento de aplicativos com Todos na Internet (EOTI).
variables	variables	array of Variable1	As variáveis do aplicativo. Consulte sobre variáveis de aplicativo
ancestorId	ancestorId	string	A ID do aplicativo do qual este aplicativo foi copiado
dataClassification	dataClassification	string	O rótulo de Classificação de Dados atribuído ao aplicativo. Se a Classificação de Dados não estiver ativada, isso não será retornado. Se a Classificação de Dados estiver ativada, mas o aplicativo não for rotulado, retornaremos "Nenhum". Os rótulos de Classificação de Dados podem ser adicionados no Console de Administração por um Administrador de Realm para planos do Platform+.

createTableResponse

Nome	Caminho	Tipo	Description
nome	name	string	O nome da tabela.
id	id	string	O identificador exclusivo (dbid) da tabela.
alias	alias	string	O alias de tabela criado automaticamente para a tabela.
descrição	description	string	A descrição da tabela, conforme configurada por um administrador de aplicativos.
criadas	created	string	A hora e a data em que a tabela foi criada, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
atualizado	updated	string	A hora e a data em que o esquema ou os dados da tabela foram atualizados pela última vez, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
nextRecordId	nextRecordId	integer	A ID de Registro incremental que será usada quando o próximo registro for criado, conforme determinado quando a chamada à API foi executada.
nextFieldId	nextFieldId	integer	A ID de Campo incremental que será usada quando o próximo campo for criado, conforme determinado quando a chamada à API foi executada.
defaultSortFieldId	defaultSortFieldId	integer	A ID do campo configurado para classificação padrão.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	A configuração da ordem de classificação padrão na tabela.
keyFieldId	keyFieldId	integer	A ID do campo configurado para ser a chave nesta tabela, que geralmente é a ID do Registro da Base Rápida.
singleRecordName	singleRecordName	string	O substantivo singular configurado pelo construtor da tabela.
pluralRecordName	pluralRecordName	string	O substantivo plural configurado pelo construtor da tabela.
sizeLimit	sizeLimit	string	O limite de tamanho da tabela.
spaceUsed	spaceUsed	string	A quantidade de espaço atualmente sendo usada pela tabela.
spaceRemaining	spaceRemaining	string	A quantidade de espaço restante para uso pela tabela.

DefaultSortOrder

A configuração da ordem de classificação padrão na tabela.

DefaultSortOrder: string

getTableResponse

Nome	Caminho	Tipo	Description
nome	name	string	O nome da tabela.
id	id	string	O identificador exclusivo (dbid) da tabela.
alias	alias	string	O alias de tabela criado automaticamente para a tabela.
descrição	description	string	A descrição da tabela, conforme configurada por um administrador de aplicativos.
criadas	created	string	A hora e a data em que a tabela foi criada, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
atualizado	updated	string	A hora e a data em que o esquema ou os dados da tabela foram atualizados pela última vez, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
nextRecordId	nextRecordId	integer	A ID de Registro incremental que será usada quando o próximo registro for criado, conforme determinado quando a chamada à API foi executada.
nextFieldId	nextFieldId	integer	A ID de Campo incremental que será usada quando o próximo campo for criado, conforme determinado quando a chamada à API foi executada.
defaultSortFieldId	defaultSortFieldId	integer	A ID do campo configurado para classificação padrão.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	A configuração da ordem de classificação padrão na tabela.
keyFieldId	keyFieldId	integer	A ID do campo configurado para ser a chave nesta tabela, que geralmente é a ID do Registro da Base Rápida.
singleRecordName	singleRecordName	string	O substantivo singular configurado pelo construtor da tabela.
pluralRecordName	pluralRecordName	string	O substantivo plural configurado pelo construtor da tabela.
sizeLimit	sizeLimit	string	O limite de tamanho da tabela.
spaceUsed	spaceUsed	string	A quantidade de espaço atualmente sendo usada pela tabela.
spaceRemaining	spaceRemaining	string	A quantidade de espaço restante para uso pela tabela.

updateTableResponse

Nome	Caminho	Tipo	Description
nome	name	string	O nome da tabela.
id	id	string	O identificador exclusivo (dbid) da tabela.
alias	alias	string	O alias de tabela criado automaticamente para a tabela.
descrição	description	string	A descrição da tabela, conforme configurada por um administrador de aplicativos.
criadas	created	string	A hora e a data em que a tabela foi criada, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
atualizado	updated	string	A hora e a data em que o esquema ou os dados da tabela foram atualizados pela última vez, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
nextRecordId	nextRecordId	integer	A ID de Registro incremental que será usada quando o próximo registro for criado, conforme determinado quando a chamada à API foi executada.
nextFieldId	nextFieldId	integer	A ID de Campo incremental que será usada quando o próximo campo for criado, conforme determinado quando a chamada à API foi executada.
defaultSortFieldId	defaultSortFieldId	integer	A ID do campo configurado para classificação padrão.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	A configuração da ordem de classificação padrão na tabela.
keyFieldId	keyFieldId	integer	A ID do campo configurado para ser a chave nesta tabela, que geralmente é a ID do Registro da Base Rápida.
singleRecordName	singleRecordName	string	O substantivo singular configurado pelo construtor da tabela.
pluralRecordName	pluralRecordName	string	O substantivo plural configurado pelo construtor da tabela.
sizeLimit	sizeLimit	string	O limite de tamanho da tabela.
spaceUsed	spaceUsed	string	A quantidade de espaço atualmente sendo usada pela tabela.
spaceRemaining	spaceRemaining	string	A quantidade de espaço restante para uso pela tabela.

deleteTableResponse

Nome	Caminho	Tipo	Description
deletedTableId	deletedTableId	string	A ID da tabela excluída.

getRelationshipsResponse

Nome	Caminho	Tipo	Description
Relações	relationships	array of Relationship	As relações em uma tabela.
Metadados	metadata	Metadata	Informações adicionais sobre os resultados que podem ser úteis.

Relationship

Nome	Caminho	Tipo	Description
id	id	integer	A ID da relação (ID do campo de chave estrangeira).
parentTableId	parentTableId	string	A ID da tabela pai da relação.
childTableId	childTableId	string	A ID da tabela filho da relação.
ForeignKeyField	foreignKeyField	ForeignKeyField	As informações do campo de chave estrangeira.
isCrossApp	isCrossApp	boolean	Se essa é uma relação entre aplicativos.
lookupFields	lookupFields	array of LookupField	A matriz de campos de pesquisa.
summaryFields	summaryFields	array of SummaryField	A matriz de campos de resumo.

ForeignKeyField

As informações do campo de chave estrangeira.

Nome	Caminho	Tipo	Description
id	id	integer	ID do campo.
etiqueta	label	string	Rótulo de campo.
tipo	type	string	Tipo de campo.

LookupField

Nome	Caminho	Tipo	Description
id	id	integer	ID do campo.
etiqueta	label	string	Rótulo de campo.
tipo	type	string	Tipo de campo.

SummaryField

Nome	Caminho	Tipo	Description
id	id	integer	ID do campo.
etiqueta	label	string	Rótulo de campo.
tipo	type	string	Tipo de campo.

Metadados

Informações adicionais sobre os resultados que podem ser úteis.

Nome	Caminho	Tipo	Description
ignorar	skip	integer	O número de relações a serem ignoradas.
totalRelationships	totalRelationships	integer	O número total de relações.
numRelationships	numRelationships	integer	O número de relações no objeto de resposta atual.

createRelationshipResponse

Nome	Caminho	Tipo	Description
id	id	integer	A ID da relação (ID do campo de chave estrangeira).
parentTableId	parentTableId	string	A ID da tabela pai da relação.
childTableId	childTableId	string	A ID da tabela filho da relação.
ForeignKeyField	foreignKeyField	ForeignKeyField	As informações do campo de chave estrangeira.
isCrossApp	isCrossApp	boolean	Se essa é uma relação entre aplicativos.
lookupFields	lookupFields	array of LookupField	A matriz de campos de pesquisa.
summaryFields	summaryFields	array of SummaryField	A matriz de campos de resumo.

updateRelationshipResponse

Nome	Caminho	Tipo	Description
id	id	integer	A ID da relação (ID do campo de chave estrangeira).
parentTableId	parentTableId	string	A ID da tabela pai da relação.
childTableId	childTableId	string	A ID da tabela filho da relação.
ForeignKeyField	foreignKeyField	ForeignKeyField	As informações do campo de chave estrangeira.
isCrossApp	isCrossApp	boolean	Se essa é uma relação entre aplicativos.
lookupFields	lookupFields	array of LookupField	A matriz de campos de pesquisa.
summaryFields	summaryFields	array of SummaryField	A matriz de campos de resumo.

deleteRelationshipResponse

Nome	Caminho	Tipo	Description
relationshipId	relationshipId	integer	A ID da relação.

Query

A definição de consulta configurada no Quickbase que é executada quando o relatório é executado.

Nome	Caminho	Tipo	Description
tableId	tableId	string	O identificador de tabela do relatório.
filtro	filter	string	Filtro usado para consultar dados.
formulaFields	formulaFields	array of FormulaField	Campos de fórmula calculados.

FormulaField

Nome	Caminho	Tipo	Description
id	id	integer	Identificador de campo de fórmula.
etiqueta	label	string	Rótulo de campo de fórmula.
FieldType	fieldType	FieldType	Tipo de valor de fórmula resultante.
fórmula	formula	string	Texto da fórmula.
decimalPrecision	decimalPrecision	integer	Para a fórmula numérica, a precisão do número.

FieldType

Tipo de valor de fórmula resultante.

FieldType: string

getReportResponse

Nome	Caminho	Tipo	Description
id	id	string	O identificador do relatório, exclusivo da tabela.
nome	name	string	O nome configurado do relatório.
tipo	type	string	O tipo de relatório no Quickbase (por exemplo, gráfico).
descrição	description	string	A descrição configurada de um relatório.
ID do proprietário	ownerId	integer	Opcional, mostrado somente para relatórios pessoais. A ID do usuário do proprietário do relatório.
Query	query	Query	A definição de consulta configurada no Quickbase que é executada quando o relatório é executado.
propriedades	properties	object	Uma lista de propriedades específicas para o tipo de relatório. Para ver uma descrição detalhada das propriedades de cada tipo de relatório, consulte tipos de relatório.
usedLast	usedLast	string	O instante em que um relatório foi usado pela última vez.
usedCount	usedCount	integer	O número de vezes que um relatório foi usado.

runReportResponse

Nome	Caminho	Tipo	Description
fields	fields	array of Field	Uma matriz de objetos que contém metadados limitados de cada campo exibido no relatório. Isso ajuda na criação de lógica que depende de tipos de campo e IDs.
dados	data	array of object	Uma matriz de objetos que representa os dados de registro ou valores resumidos, dependendo do tipo de relatório.
items	data	object
Metadados1	metadata	Metadata1	Informações adicionais sobre os resultados que podem ser úteis. A paginação poderá ser necessária se você especificar um número menor de resultados para ignorar do que está disponível ou se a API retornar automaticamente menos resultados. numRecords pode ser comparado com totalRecords para determinar se uma paginação adicional é necessária.

Campo

Nome	Caminho	Tipo	Description
id	id	integer	ID do campo.
etiqueta	label	string	Rótulo de campo.
tipo	type	string	Tipo de campo.
labelOverride	labelOverride	string	Substituição do rótulo de título de coluna para o campo no relatório.

Metadados1

Informações adicionais sobre os resultados que podem ser úteis. A paginação poderá ser necessária se você especificar um número menor de resultados para ignorar do que está disponível ou se a API retornar automaticamente menos resultados. numRecords pode ser comparado com totalRecords para determinar se uma paginação adicional é necessária.

Nome	Caminho	Tipo	Description
ignorar	skip	integer	O número de registros a serem ignoradas
numFields	numFields	integer	O número de campos em cada registro no objeto de resposta atual
top	top	integer	Se presente, o número máximo de registros solicitados pelo chamador
totalRecords	totalRecords	integer	O número total de registros no conjunto de resultados
numRecords	numRecords	integer	O número de registros no objeto de resposta atual

Properties1

Propriedades adicionais para o campo. Consulte a página Detalhes do tipo de campo para obter mais detalhes sobre as propriedades de cada tipo de campo.

Nome	Caminho	Tipo	Description
comments	comments	string	Os comentários inseridos nas propriedades do campo por um administrador.
doesTotal	doesTotal	boolean	Se esse campo totaliza em relatórios dentro do produto.
salvamento automático	autoSave	boolean	Se o campo de link salvará automaticamente.
defaultValueLuid	defaultValueLuid	integer	Valor de ID do usuário padrão.
maxVersions	maxVersions	integer	O número máximo de versões configuradas para um anexo de arquivo.
carryChoices	carryChoices	boolean	Se o campo deve carregar seus campos de múltipla escolha quando copiado.
format	format	integer	O formato a ser exibido.
comprimento máximo	maxLength	integer	O número máximo de caracteres permitido para entrada no Quickbase para este campo.
linkText	linkText	string	O valor de texto configurado que substitui a URL que os usuários veem no produto.
parentFieldId	parentFieldId	integer	A ID do campo de composição pai, quando aplicável.
displayTimezone	displayTimezone	boolean	Indica se o fuso horário deve ser exibido dentro do produto.
summaryTargetFieldId	summaryTargetFieldId	integer	A ID do campo que é usado para agregar valores do filho, quando aplicável. Isso exibirá 0 se a função de resumo não exigir uma seleção de campo (como contagem).
allowNewChoices	allowNewChoices	boolean	Indica se os usuários podem adicionar novas opções a uma lista de seleção.
masterChoiceFieldId	masterChoiceFieldId	integer	A ID do campo que é a referência na relação.
defaultToday	defaultToday	boolean	Indica se o valor do campo é padrão hoje para novos registros.
Unidades	units	string	O rótulo de unidades.
lookupTargetFieldId	lookupTargetFieldId	integer	A ID do campo que é o destino na tabela mestra para esta pesquisa.
SummaryFunction	summaryFunction	SummaryFunction	O tipo de função de acúmulo de resumo.
sourceFieldId	sourceFieldId	integer	A ID do campo de origem.
masterTableTag	masterTableTag	string	O alias de tabela para a tabela mestra na relação da qual esse campo faz parte.
doesAverage	doesAverage	boolean	Se esse campo tem uma média em relatórios dentro do produto.
fórmula	formula	string	A fórmula do campo, conforme configurado no Quickbase.
decimalPlaces	decimalPlaces	integer	O número de casas decimais exibidas no produto para este campo.
seeVersions	seeVersions	boolean	Indica se o usuário pode ver outras versões, além das mais recentes, de um anexo de arquivo dentro do produto.
displayMonth	displayMonth	string	Como exibir meses.
numLines	numLines	integer	O número de linhas mostradas na Base Rápida para este campo de texto.
displayEmail	displayEmail	string	Como o email é exibido.
defaultKind	defaultKind	string	O tipo padrão do usuário.
coverText	coverText	string	Um texto amigável alternativo que pode ser usado para exibir um link no navegador.
currencySymbol	currencySymbol	string	O símbolo atual usado ao exibir valores de campo dentro do produto.
masterChoiceTableId	masterChoiceTableId	integer	A ID da tabela que é o mestre nessa relação.
targetFieldId	targetFieldId	integer	A ID do campo de destino.
displayUser	displayUser	string	A opção configurada para como os usuários são exibidos dentro do produto.
blankIsZero	blankIsZero	boolean	Se um valor em branco é tratado como 0 em cálculos dentro do produto.
exacto	exact	boolean	Se uma correspondência exata é necessária para um link de relatório.
startField	startField	integer	A ID do campo inicial.
defaultDomain	defaultDomain	string	Domínio de email padrão.
defaultValue	defaultValue	string	O valor padrão configurado para um campo quando um novo registro é adicionado.
choicesLuid	choicesLuid	array of object	Lista de opções de usuário.
items	choicesLuid	object
abreviar	abbreviate	boolean	Não mostre o protocolo de URL ao mostrar a URL.
xmlTag	xmlTag	string	A marca xml do campo.
targetTableName	targetTableName	string	O nome da tabela de destino do campo.
formatoNúmero	numberFormat	integer	O formato usado para exibir valores numéricos no produto (decimal, separadores, grupo de dígitos).
appearsAs	appearsAs	string	O texto do link, se vazio, a URL será usada como texto de link.
largura	width	integer	A largura de entrada html do campo no produto.
CurrencyFormat	currencyFormat	CurrencyFormat	O formato de moeda usado ao exibir valores de campo dentro do produto.
displayImages	displayImages	boolean	Indica se as imagens serão exibidas para anexos de arquivo em formulários e relatórios dentro do produto.
foreignKey	foreignKey	boolean	Indica se o campo é uma chave estrangeira (ou campo de referência) em uma relação.
displayDayOfWeek	displayDayOfWeek	boolean	Indica se o dia da semana deve ser exibido dentro do produto.
summaryReferenceFieldId	summaryReferenceFieldId	integer	A ID do campo que é a referência na relação deste resumo.
commaStart	commaStart	integer	O número de dígitos antes da exibição de vírgulas no produto, quando aplicável.
choices	choices	array of string	Uma matriz de entradas que existe para um campo que oferece opções para o usuário.
targetTableId	targetTableId	string	A ID da tabela de destino.
displayRelative	displayRelative	boolean	Se o tempo de exibição deve ser exibido como relativo.
compositeFields	compositeFields	array of object	Uma matriz dos campos que compõem um campo composto (por exemplo, endereço).
items	compositeFields	object
VersionMode	versionMode	VersionMode	Modos de versão para arquivos. Mantenha todas as versões versus mantenha a última versão.
displayTime	displayTime	boolean	Indica se a hora deve ser exibida, além da data.
durationField	durationField	integer	A ID do campo de duração.
snapFieldId	snapFieldId	integer	A ID do campo que é usado para os valores de instantâneo, quando aplicável.
hours24	hours24	boolean	Indica se o tempo de exibição deve ou não ser exibido no formato de 24 horas dentro do produto.
sortAlpha	sortAlpha	boolean	Se for para classificar em ordem alfabética, a classificação padrão é por ID de registro.
sortAsGiven	sortAsGiven	boolean	Indica se as entradas listadas são classificadas como inseridas em ordem alfabética.
hasExtension	hasExtension	boolean	Se esse campo tem uma extensão de telefone.
Workweek	workWeek	integer	O tipo de semana de trabalho.
useNewWindow	useNewWindow	boolean	Indica se a URL deve abrir uma nova janela quando um usuário clica nela dentro do produto.
appendOnly	appendOnly	boolean	Se esse campo é somente acréscimo.
displayAsLink	displayAsLink	boolean	Indica se um campo que faz parte da relação deve ser mostrado como um hiperlink para o registro pai dentro do produto.
allowHTML	allowHTML	boolean	Se esse campo permite html.
lookupReferenceFieldId	lookupReferenceFieldId	integer	A ID do campo que é a referência na relação para essa pesquisa.

SummaryFunction

O tipo de função de acúmulo de resumo.

SummaryFunction: string

CurrencyFormat

O formato de moeda usado ao exibir valores de campo dentro do produto.

CurrencyFormat: string

VersionMode

Modos de versão para arquivos. Mantenha todas as versões versus mantenha a última versão.

VersionMode: string

Permissão

Nome	Caminho	Tipo	Description
função	role	string	A função associada a uma determinada permissão para o campo
permissionType	permissionType	string	A permissão dada à função para este campo
roleId	roleId	integer	A ID da função determinada

createFieldResponse

Nome	Caminho	Tipo	Description
id	id	integer	A ID do campo, exclusiva para esta tabela.
tipo de campo	fieldType	string	O tipo de campo, conforme descrito aqui.
mode	mode	string	Para campos derivados, isso será "pesquisa", "resumo" ou "fórmula", para indicar o tipo de campo derivado. Para campos não derivados, isso ficará em branco.
etiqueta	label	string	O rótulo (nome) do campo.
noWrap	noWrap	boolean	Indica se o campo está configurado para não encapsular quando exibido no produto.
negrito	bold	boolean	Indica se o campo está configurado para exibição em negrito no produto.
required	required	boolean	Indica se o campo está marcado como necessário.
appearsByDefault	appearsByDefault	boolean	Indica se o campo está marcado como padrão em relatórios.
findEnabled	findEnabled	boolean	Indica se o campo está marcado como pesquisável.
único	unique	boolean	Indica se o campo está marcado como exclusivo.
doesDataCopy	doesDataCopy	boolean	Indica se os dados de campo serão copiados quando um usuário copiar o registro.
fieldHelp	fieldHelp	string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
Auditadas	audited	boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase.
Properties1	properties	Properties1	Propriedades adicionais para o campo. Consulte a página Detalhes do tipo de campo para obter mais detalhes sobre as propriedades de cada tipo de campo.
permissões	permissions	array of Permission	Permissões de campo para funções diferentes.

deleteFieldsResponse

Nome	Caminho	Tipo	Description
deletedFieldIds	deletedFieldIds	array of integer	Lista de IDs de campo a serem excluídas.
Erros	errors	array of string	Lista de erros encontrados.

getFieldResponse

Nome	Caminho	Tipo	Description
id	id	integer	A ID do campo, exclusiva para esta tabela.
tipo de campo	fieldType	string	O tipo de campo, conforme descrito aqui.
mode	mode	string	Para campos derivados, isso será "pesquisa", "resumo" ou "fórmula", para indicar o tipo de campo derivado. Para campos não derivados, isso ficará em branco.
etiqueta	label	string	O rótulo (nome) do campo.
noWrap	noWrap	boolean	Indica se o campo está configurado para não encapsular quando exibido no produto.
negrito	bold	boolean	Indica se o campo está configurado para exibição em negrito no produto.
required	required	boolean	Indica se o campo está marcado como necessário.
appearsByDefault	appearsByDefault	boolean	Indica se o campo está marcado como padrão em relatórios.
findEnabled	findEnabled	boolean	Indica se o campo está marcado como pesquisável.
único	unique	boolean	Indica se o campo está marcado como exclusivo.
doesDataCopy	doesDataCopy	boolean	Indica se os dados de campo serão copiados quando um usuário copiar o registro.
fieldHelp	fieldHelp	string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
Auditadas	audited	boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase.
Properties1	properties	Properties1	Propriedades adicionais para o campo. Consulte a página Detalhes do tipo de campo para obter mais detalhes sobre as propriedades de cada tipo de campo.
permissões	permissions	array of Permission	Permissões de campo para funções diferentes.

updateFieldResponse

Nome	Caminho	Tipo	Description
id	id	integer	A ID do campo, exclusiva para esta tabela.
tipo de campo	fieldType	string	O tipo de campo, conforme descrito aqui.
mode	mode	string	Para campos derivados, isso será "pesquisa", "resumo" ou "fórmula", para indicar o tipo de campo derivado. Para campos não derivados, isso ficará em branco.
etiqueta	label	string	O rótulo (nome) do campo.
noWrap	noWrap	boolean	Indica se o campo está configurado para não encapsular quando exibido no produto.
negrito	bold	boolean	Indica se o campo está configurado para exibição em negrito no produto.
required	required	boolean	Indica se o campo está marcado como necessário.
appearsByDefault	appearsByDefault	boolean	Indica se o campo está marcado como padrão em relatórios.
findEnabled	findEnabled	boolean	Indica se o campo está marcado como pesquisável.
único	unique	boolean	Indica se o campo está marcado como exclusivo.
doesDataCopy	doesDataCopy	boolean	Indica se os dados de campo serão copiados quando um usuário copiar o registro.
fieldHelp	fieldHelp	string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
Auditadas	audited	boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase.
Properties1	properties	Properties1	Propriedades adicionais para o campo. Consulte a página Detalhes do tipo de campo para obter mais detalhes sobre as propriedades de cada tipo de campo.
permissões	permissions	array of Permission	Permissões de campo para funções diferentes.

runFormulaResponse

Nome	Caminho	Tipo	Description
resultado	result	string	O resultado da execução da fórmula.

upsertResponse

Nome	Caminho	Tipo	Description
Metadados2	metadata	Metadata2	Informações sobre registros criados, registros atualizados, registros referenciados, mas inalterados, e registros com erros durante o processamento.
dados	data	array of object	Os dados que devem ser retornados.
items	data	object

Metadados2

Informações sobre registros criados, registros atualizados, registros referenciados, mas inalterados, e registros com erros durante o processamento.

Nome	Caminho	Tipo	Description
createdRecordIds	createdRecordIds	array of integer	Matriz que contém as IDs de registro criadas.
lineErrors	lineErrors	object	Isso só será retornado no caso de registros com falha. É uma coleção de erros que ocorreram ao processar os dados de entrada que resultaram em registros não sendo processados. Cada objeto tem uma chave que representa o número de sequência do registro no conteúdo original (a partir de 1). O valor é uma lista de erros ocorridos.
unchangedRecordIds	unchangedRecordIds	array of integer	Matriz que contém as IDs de registro inalteradas.
updatedRecordIds	updatedRecordIds	array of integer	Matriz que contém as IDs de registro atualizadas.
totalNumberOfRecordsProcessed	totalNumberOfRecordsProcessed	integer	Número de registros processados. Inclui atualizações de registro bem-sucedidas e com falha.

deleteRecordsResponse

Nome	Caminho	Tipo	Description
numberDeleted	numberDeleted	integer	O número de registros excluídos.

runQueryResponse

Nome	Caminho	Tipo	Description
fields	fields	array of Fields2	Uma matriz de objetos que contém metadados limitados de cada campo exibido no relatório. Isso ajuda na criação de lógica que depende de tipos de campo e IDs.
dados	data	array of object	Uma matriz de objetos que representa os dados de registro ou valores resumidos, dependendo do tipo de relatório.
items	data	object
Metadados1	metadata	Metadata1	Informações adicionais sobre os resultados que podem ser úteis. A paginação poderá ser necessária se você especificar um número menor de resultados para ignorar do que está disponível ou se a API retornar automaticamente menos resultados. numRecords pode ser comparado com totalRecords para determinar se uma paginação adicional é necessária.

Fields2

Nome	Caminho	Tipo	Description
id	id	integer	ID do campo.
etiqueta	label	string	Rótulo de campo.
tipo	type	string	Tipo de campo.

getTempTokenDBIDResponse

Nome	Caminho	Tipo	Description
temporaryAuthorization	temporaryAuthorization	string	Token de autorização temporária.

cloneUserTokenResponse

Nome	Caminho	Tipo	Description
ativo	active	boolean	Se o token de usuário está ativo.
apps	apps	array of App	A lista de aplicativos aos quais esse token de usuário é atribuído.
lastUsed	lastUsed	string	A última data em que esse token de usuário foi usado, no formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
descrição	description	string	Descrição do Token de Usuário.
id	id	integer	ID do Token de Usuário.
nome	name	string	Nome do Token de Usuário.
símbolo	token	string	Valor do Token de Usuário.

Aplicativo

Nome	Caminho	Tipo	Description
id	id	string	O identificador exclusivo para este aplicativo.
nome	name	string	O nome do aplicativo.

deleteUserTokenResponse

Nome	Caminho	Tipo	Description
id	id	integer	A ID do token de usuário.

deleteFileResponse

Nome	Caminho	Tipo	Description
versionNumber	versionNumber	integer	O número de versões excluídas.
fileName	fileName	string	O nome do arquivo associado à versão excluída.
Carregado	uploaded	string	O carimbo de data/hora em que a versão foi carregada originalmente.
Criador	creator	Creator	O usuário que carregou a versão.

Criador

O usuário que carregou a versão.

Nome	Caminho	Tipo	Description
nome	name	string	Nome completo do usuário.
id	id	string	Identificação de usuário.
email	email	string	Email do usuário.
userName	userName	string	Nome de Usuário conforme atualizado nas propriedades do usuário. Opcional, será exibido se não for o mesmo que o email do usuário.

cadeia

Esse é o tipo de dados básico 'string'.

Compartilhar via

Base Rápida (Editor Independente)

Criando uma conexão

Padrão

Limitações

Ações

Atualizar um aplicativo

Parâmetros

Retornos

Atualizar um campo

Parâmetros

Retornos

Atualizar uma relação

Parâmetros

Retornos

Atualizar uma tabela

Parâmetros

Retornos

Baixar um anexo

Parâmetros

Retornos

Clonar um token de usuário

Parâmetros

Retornos

Consultar dados

Parâmetros

Retornos

Copiar um aplicativo

Parâmetros

Retornos

Criar um aplicativo

Parâmetros

Retornos

Criar um campo

Parâmetros

Retornos

Criar um relacionamento

Parâmetros

Retornos

Criar uma tabela

Parâmetros

Retornos

Desativar um token de usuário

Retornos

Excluir campos

Parâmetros

Retornos

Excluir registros

Parâmetros

Retornos

Excluir um anexo

Parâmetros

Retornos

Excluir um aplicativo

Parâmetros

Retornos

Excluir um relacionamento

Parâmetros

Retornos

Excluir um token de usuário

Retornos

Excluir uma tabela

Parâmetros

Retornos

Executar um relatório

Parâmetros

Retornos

Executar uma fórmula

Parâmetros

Retornos

Inserir registros de atualização do andor

Parâmetros

Retornos

Obter campo

Parâmetros

Retornos

Obter campos para uma tabela

Parâmetros

Retornos

Obter eventos de aplicativo