Quickbase (Editora Independente)

O Quickbase é uma plataforma de desenvolvimento de aplicativos que une equipes de negócios e de TI, permitindo que solucionadores de problemas de qualquer formação técnica trabalhem juntos para criar um ecossistema de aplicativos de forma segura e sustentável. O Quickbase ajuda as empresas a acelerar a inovação contínua de processos únicos, permitindo o desenvolvimento do cidadão em escala através de uma plataforma comum.

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes:      - Regiões do Azure Government      - Regiões do Azure China      - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Editora	Troy Taylor, Soluções Hitachi
Sítio Web	https://www.quickbase.com/
Política de privacidade	https://www.quickbase.com/privacy
Categorias	Produtividade;Operações de TI

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 do reino	cadeia (de caracteres)	Especifique o nome do host do seu realm.	Verdade
Authorization	securestring	O token de usuário para na forma "QB-USER-TOKEN yourToken".	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Atualizar um campo	Atualiza as propriedades e 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 podem ser rejeitados. Veja as descrições de obrigatórios, exclusivos e opções, 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 aplicação	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 uma relação	Use este 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.
Clone um token de usuário	Clones o token de usuário autenticado. Todos os aplicativos associados a esse token são automaticamente associados ao novo token.
Consulta de 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 a resposta e coletar mais dados.
Copiar uma aplicação	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 campo	Cria um campo dentro de uma tabela, incluindo as permissões personalizadas desse campo.
Criar uma aplicação	Cria um aplicativo em uma conta. Você deve ter direitos de criação de aplicativos na respetiva conta. As principais propriedades e variáveis de aplicação podem ser definidas com esta API.
Criar uma relação	Cria uma relação em uma tabela, bem como campos de pesquisa/resumo. As relações só podem ser criadas para tabelas dentro do mesmo aplicativo.
Criar uma tabela	Cria uma tabela em um aplicativo.
Desativar um token de usuário	Desativa o token de usuário autenticado. Feito isso, o token de usuário deve ser reativado na interface do usuário.
Descarregar um anexo	Baixa o anexo do arquivo, com o conteúdo do anexo do arquivo codificado no formato base64. A resposta da API retorna o nome do Content-Disposition arquivo no cabeçalho. Os 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.
Eliminar uma aplicação	Exclui um aplicativo inteiro, incluindo todas as tabelas e dados.
Eliminar uma tabela	Exclui uma tabela específica em um aplicativo, incluindo todos os dados dentro dela.
Excluir campos	Exclui um ou vários campos em uma tabela, com base na id do campo. Isso também excluirá permanentemente quaisquer dados ou cálculos nesse campo.
Excluir registros	Exclui registro(s) 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. Os 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 arquivos.
Excluir um relacionamento	Use este ponto de extremidade para excluir um relacionamento inteiro, incluindo todos os campos de pesquisa e resumo. O campo de referência na relação não será eliminado.
Excluir um token de usuário	Exclui o token de usuário autenticado. Isto não é reversível.
Executar um relatório	Executa um relatório, com base em um ID e retorna os dados subjacentes associados a ele. O formato dos dados varia de acordo com o tipo de relatório. Os relatórios que se concentram em dados de nível de registro (tabela, calendário, etc.) retornam os registros individuais. Os relatórios agregados (resumo, gráfico) retornarão as informações resumidas conforme configurado no relatório. Os 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 a resposta e coletar mais dados.
Executar uma fórmula	Permite executar uma fórmula através de uma chamada de API. Use esse método em código personalizado para obter o valor de volta de uma fórmula sem um campo discreto em um registro.
Inserir eou atualizar registos	Inserir e/ou atualizar registo(s) numa tabela. Nesta única chamada de API, inserções e atualizações podem ser enviadas. A atualização pode usar o campo chave na tabela ou qualquer outro campo exclusivo suportado. 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. Observação: Este endpoint suporta um tamanho máximo de carga útil de 10MB.
Obtenha todos os relacionamentos	Obtenha uma lista de todos os relacionamentos e suas definições para uma tabela específica. Os detalhes são fornecidos para os lados pai e filho das relações dentro de um determinado aplicativo. Detalhes limitados são retornados para relações entre aplicativos.
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 'propriedades'. 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 da aplicação	Obter uma lista de eventos que podem ser acionados com base em dados ou ações do usuário neste aplicativo, inclui: Notificação por e-mail, Lembretes, Assinaturas, Ações QB, Webhooks, Automações acionadas de alteração de registro (não inclui agendado).
Obter tabelas para uma aplicação	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 em Obter tabela.
Obter todos os relatórios de tabela	Obtenha o esquema (propriedades) de todos os relatórios para uma tabela. Se o usuário que executa a API for um administrador de aplicativo, a API também retornará todos os relatórios pessoais com a ID de usuário do proprietário.
Obter um relatório	Obtenha o esquema (propriedades) de um relatório individual.
Obter um token temporário para um DBID	Use este 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 de API (consulte autorização). Este token expira em 5 minutos.
Obter um uso de campo	Obtenha estatísticas de utilização de um único campo. Este é um resumo das informações que podem ser encontradas na tabela de uso das propriedades do campo.
Obter uma aplicação	Retorna as propriedades principais de um aplicativo, incluindo variáveis de aplicativo.
Obter uma mesa	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 campo

ID da Operação:

UpdateField

Atualiza as propriedades e 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 podem ser rejeitados. Veja as descrições de obrigatórios, exclusivos e opções, 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

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
auditado	audited		boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase. Você só pode definir essa propriedade como "true" se o aplicativo tiver logs de auditoria habilitados. Consulte Habilitar logs de alteração de dados em Quickbase Audit Logs.
campoAjuda	fieldHelp		string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
bold	bold		boolean	Indica se o campo está configurado para ser exibido em negrito no produto.
required	required		boolean	Indica se o campo é obrigatório (ou seja, se cada registo deve ter um valor não nulo neste campo). Se você tentar alterar um campo de não-obrigatório para obrigatório e a tabela atualmente contiver 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 obrigatório.
comments	comments		string	Os comentários inseridos nas propriedades do campo por um administrador.
fazTotal	doesTotal		boolean	Se este campo é total em relatórios dentro do produto.
Gravação automática	autoSave		boolean	Se o campo de link será salvo automaticamente.
defaultValueLuid	defaultValueLuid		integer	Valor de ID de usuário padrão.
maxVersões	maxVersions		integer	O número máximo de versões configuradas para um anexo de arquivo.
format	format		integer	O formato para exibir o tempo.
carryChoices	carryChoices		boolean	Se o campo deve ter seus campos de múltipla escolha quando copiado.
maxComprimento	maxLength		integer	O número máximo de caracteres permitido para entrada no Quickbase para este campo.
linkTexto	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 composto pai, quando aplicável.
displayFuso horário	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 da criança, quando aplicável. Isso exibirá 0 se a função de resumo não exigir uma seleção de campo (como contagem).
permitirNovaEscolhas	allowNewChoices		boolean	Indica se os usuários podem adicionar novas opções a uma lista de seleção.
padrãoHoje	defaultToday		boolean	Indica se o valor do campo é padrão hoje para novos registros.
unidades	units		string	O rótulo das unidades.
lookupTargetFieldId	lookupTargetFieldId		integer	A id do campo que é o destino na tabela pai para esta pesquisa.
SummaryFunction3	summaryFunction		string	O tipo de acumulação para o campo de resumo.
sourceFieldId	sourceFieldId		integer	A id do campo de origem.
fazMédia	doesAverage		boolean	Se este campo é a média em relatórios dentro do produto.
fórmula	formula		string	A fórmula do campo conforme configurada no Quickbase.
casas decimais	decimalPlaces		integer	O número de casas decimais exibidas no produto para este campo.
displayMês	displayMonth		string	Como exibir meses.
seeVersões	seeVersions		boolean	Indica se o usuário pode ver outras versões, além da mais recente, de um anexo de arquivo dentro do produto.
numLines	numLines		integer	O número de linhas mostradas no Quickbase para este campo de texto.
defaultKind	defaultKind		string	O tipo padrão do usuário.
displayE-mail	displayEmail		string	Como o e-mail é exibido.
capaTexto	coverText		string	Um texto alternativo amigável 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 da mesma forma que 0 nos cálculos dentro do produto.
exato	exact		boolean	Se uma correspondência exata é necessária para um link de relatório.
defaultDomain	defaultDomain		string	Domínio de e-mail 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 o URL.
númeroFormato	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.
apareceAs	appearsAs		string	O texto do link, se vazio, o url será usado como texto do link.
Largura	width		integer	A largura de entrada html do campo no produto.
Formato da moeda	currencyFormat		string	O formato de moeda usado ao exibir valores de campo dentro do produto.
displayImagens	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 para este resumo.
vírgulaStart	commaStart		integer	O número de dígitos antes das vírgulas é exibido no produto, quando aplicável.
choices	choices		array of string	Uma matriz de entradas que existem para um campo que oferece opções ao usuário. Observe que essas opções se referem aos valores válidos de quaisquer registros adicionados no futuro. Você tem permissão para remover valores da lista de opções, mesmo que existam registros existentes com esses valores neste campo. Eles serão exibidos em vermelho quando os usuários olharem para os dados no navegador, mas não há 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	O id da tabela de destino.
displayRelativo	displayRelative		boolean	Se o tempo deve ser exibido como relativo.
compositeFields	compositeFields		object
summaryTableId	summaryTableId		string	A tabela a partir 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.
Modo de versão	versionMode		string	Modos de versão para ficheiros. Manter todas as versões vs manter a última versão.
snapFieldId	snapFieldId		integer	A id do campo que é usado para capturar valores de instantâneo, quando aplicável.
horas24	hours24		boolean	Indica se o tempo deve ou não ser exibido no formato de 24 horas dentro do produto.
sortAlpha	sortAlpha		boolean	Se a classificação alfabética deve ser ordenada, a classificação padrão é por ID de registro.
sortAsGiven	sortAsGiven		boolean	Indica se as entradas listadas classificam como inseridas vs alfabeticamente.
hasExtension	hasExtension		boolean	Se este campo tem uma extensão telefónica.
useNewWindow	useNewWindow		boolean	Indica se a URL deve abrir uma nova janela quando um usuário clica nela dentro do produto.
acrescentarApenas	appendOnly		boolean	Se este campo é apenas 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 esta pesquisa.
apareceByDefault	appearsByDefault		boolean	Indica se o campo está marcado como padrão nos 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	O Id da função dada
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 ser encapsulado quando exibido no produto.
ID do campo	fieldId	True	integer	O identificador único (FID) do campo.

Devoluções

Atualizar resposta de campo

updateFieldResponse

Atualizar uma aplicação

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

Name	Chave	Necessário	Tipo	Description
nome	name	True	string	O nome da variável.
valor	value	True	string	O valor para a variável.
nome	name		string	O nome do aplicativo.
descrição	description		string	A descrição do aplicativo.
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo.

Devoluções

Atualizar resposta do aplicativo

updateAppResponse

Atualizar uma relação

ID da Operação:

UpdateRelationship

Use este 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

Name	Chave	Necessário	Tipo	Description
sumárioFid	summaryFid		double	O id do campo a ser resumido.
etiqueta	label		string	O rótulo do campo de resumo.
Tipo de acumulação	accumulationType	True	string	O tipo de acumulação para o campo de 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 identificador exclusivo (DBID) da tabela. Esta será a mesa infantil.
ID de relacionamento	relationshipId	True	double	O ID da relação. Este é o ID do campo de referência na tabela filho.

Devoluções

Atualizar resposta de relacionamento

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

Name	Chave	Necessário	Tipo	Description
ID de Aplicação	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á 'Registros'.
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 identificador exclusivo (DBID) da tabela.

Devoluções

Atualizar resposta da tabela

updateTableResponse

Clone um token de usuário

ID da Operação:

CloneUserToken

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
nome	name		string	O novo nome para o token de usuário clonado.
descrição	description		string	A descrição do token de usuário clonado.

Devoluções

Clonar resposta de token de usuário

cloneUserTokenResponse

Consulta de 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 a resposta e coletar mais dados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ignorar	skip		integer	O número de registros a serem ignorados.
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 hora 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 ordem crescente (ASC), ordem decrescente (DESC) ou valores iguais (valores iguais)
ordenarPor	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 classificar pode melhorar o desempenho.
select	select		object
de	from	True	string	O identificador da tabela.

Devoluções

Executar resposta de consulta

runQueryResponse

Copiar uma aplicação

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

Name	Chave	Necessá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 o token de usuário usado para fazer essa solicitação deve ser adicionado ao novo aplicativo
excludeFiles	excludeFiles		boolean	Se keepData for true, copie os anexos do arquivo também. Se keepData for false, essa propriedade será ignorada
manterDados	keepData		boolean	Se os dados do aplicativo devem ser copiados junto com o esquema
usuáriosAndRoles	usersAndRoles		boolean	Se verdadeiro, os usuários serão copiados junto com suas funções atribuídas. Se false, os usuários e funções serão copiados, mas as funções não serão atribuídas
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo.

Devoluções

Copiar resposta do aplicativo

copyAppResponse

Criar um campo

ID da Operação:

CreateField

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
auditado	audited		boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase. Você só pode definir essa propriedade como "true" se o aplicativo tiver logs de auditoria habilitados. Consulte Habilitar logs de alteração de dados em Quickbase Audit Logs.
campoAjuda	fieldHelp		string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
bold	bold		boolean	Indica se o campo está configurado para ser exibido em negrito no produto.
comments	comments		string	Os comentários inseridos nas propriedades do campo por um administrador.
fazTotal	doesTotal		boolean	Se este campo é total em relatórios dentro do produto.
Gravação automática	autoSave		boolean	Se o campo de link será salvo automaticamente.
defaultValueLuid	defaultValueLuid		integer	Valor de ID de usuário padrão.
maxVersões	maxVersions		integer	O número máximo de versões configuradas para um anexo de arquivo.
format	format		integer	O formato para exibir o tempo.
carryChoices	carryChoices		boolean	Se o campo deve ter seus campos de múltipla escolha quando copiado.
maxComprimento	maxLength		integer	O número máximo de caracteres permitido para entrada no Quickbase para este campo.
linkTexto	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 composto pai, quando aplicável.
displayFuso horário	displayTimezone		boolean	Indica se o fuso horário deve ser exibido dentro do produto.
permitirNovaEscolhas	allowNewChoices		boolean	Indica se os usuários podem adicionar novas opções a uma lista de seleção.
padrãoHoje	defaultToday		boolean	Indica se o valor do campo é padrão hoje para novos registros.
unidades	units		string	O rótulo das unidades.
sourceFieldId	sourceFieldId		integer	A id do campo de origem.
fazMédia	doesAverage		boolean	Se este campo é a média em relatórios dentro do produto.
fórmula	formula		string	A fórmula do campo conforme configurada no Quickbase.
casas decimais	decimalPlaces		integer	O número de casas decimais exibidas no produto para este campo.
displayMês	displayMonth		string	Como exibir meses.
seeVersões	seeVersions		boolean	Indica se o usuário pode ver outras versões, além da mais recente, de um anexo de arquivo dentro do produto.
numLines	numLines		integer	O número de linhas mostradas no Quickbase para este campo de texto.
defaultKind	defaultKind		string	O tipo padrão do usuário.
displayE-mail	displayEmail		string	Como o e-mail é exibido.
capaTexto	coverText		string	Um texto alternativo amigável 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 da mesma forma que 0 nos cálculos dentro do produto.
exato	exact		boolean	Se uma correspondência exata é necessária para um link de relatório.
defaultDomain	defaultDomain		string	Domínio de e-mail 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 o URL.
númeroFormato	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.
apareceAs	appearsAs		string	O texto do link, se vazio, o url será usado como texto do link.
Largura	width		integer	A largura de entrada html do campo no produto.
Formato da moeda	currencyFormat		string	O formato de moeda usado ao exibir valores de campo dentro do produto.
displayImagens	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.
vírgulaStart	commaStart		integer	O número de dígitos antes das vírgulas é exibido no produto, quando aplicável.
choices	choices		array of string	Uma matriz de entradas que existem para um campo que oferece opções ao usuário. Observe que essas opções se referem aos valores válidos de quaisquer registros adicionados no futuro. Você tem permissão para remover valores da lista de opções, mesmo que existam registros existentes com esses valores neste campo. Eles serão exibidos em vermelho quando os usuários olharem para os dados no navegador, mas não há 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	O id da tabela de destino.
displayRelativo	displayRelative		boolean	Se o tempo deve ser exibido como relativo.
compositeFields	compositeFields		object
displayTime	displayTime		boolean	Indica se a hora deve ser exibida, além da data.
Modo de versão	versionMode		string	Modos de versão para ficheiros. Manter todas as versões vs manter a última versão.
snapFieldId	snapFieldId		integer	A id do campo que é usado para capturar valores de instantâneo, quando aplicável.
horas24	hours24		boolean	Indica se o tempo deve ou não ser exibido no formato de 24 horas dentro do produto.
sortAlpha	sortAlpha		boolean	Se a classificação alfabética deve ser ordenada, a classificação padrão é por ID de registro.
sortAsGiven	sortAsGiven		boolean	Indica se as entradas listadas classificam como inseridas vs alfabeticamente.
hasExtension	hasExtension		boolean	Se este campo tem uma extensão telefónica.
useNewWindow	useNewWindow		boolean	Indica se a URL deve abrir uma nova janela quando um usuário clica nela dentro do produto.
acrescentarApenas	appendOnly		boolean	Se este campo é apenas 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.
apareceByDefault	appearsByDefault		boolean	Indica se o campo está marcado como padrão nos 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	O Id da função dada
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 ser encapsulado quando exibido no produto.

Devoluções

Criar resposta de campo

createFieldResponse

Criar uma aplicação

ID da Operação:

CreateApp

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
assignToken	assignToken		boolean	Defina como true se 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.
valor	value	True	string	O valor para a 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 reino, porque eles terão valores de lance diferentes. Exortamo-lo a ter cuidado ao fazê-lo.
descrição	description		string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.

Devoluções

Criar resposta do aplicativo

createAppResponse

Criar uma relação

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 dentro do mesmo aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
sumárioFid	summaryFid		double	O id do campo a ser resumido.
etiqueta	label		string	O rótulo do campo de resumo.
Tipo de acumulação	accumulationType	True	string	O tipo de acumulação para o campo de 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ão campos de pesquisa na tabela filho.
parentTableId	parentTableId	True	string	O ID da tabela pai para o relacionamento.
etiqueta	label		string	O rótulo para o campo de chave estrangeira.
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela. Esta será a mesa infantil.

Devoluções

Criar resposta de relacionamento

createRelationshipResponse

Criar uma tabela

ID da Operação:

CreateTable

Cria uma tabela em um aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de Aplicação	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á 'Registros'.
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.

Devoluções

Criar resposta de tabela

createTableResponse

Desativar um token de usuário

ID da Operação:

DeactivateUserToken

Desativa o token de usuário autenticado. Feito isso, o token de usuário deve ser reativado na interface do usuário.

Devoluções

Name	Caminho	Tipo	Description
id	id	integer	id

Descarregar um anexo

ID da Operação:

DownloadFile

Baixa o anexo do arquivo, com o conteúdo do anexo do arquivo codificado no formato base64. A resposta da API retorna o nome do Content-Disposition arquivo no cabeçalho. Os 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

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
ID do Registo	recordId	True	integer	O identificador exclusivo do registo.
ID do campo	fieldId	True	integer	O identificador exclusivo do campo.
Número da versão	versionNumber	True	integer	O número da versão do anexo do arquivo.

Devoluções

response

string

Eliminar uma aplicação

ID da Operação:

DeleteApp

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
nome	name	True	string	Para confirmar a exclusão do aplicativo, pedimos o nome do aplicativo.
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo.

Devoluções

Excluir resposta do aplicativo

deleteAppResponse

Eliminar uma tabela

ID da Operação:

DeleteTable

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela.

Devoluções

Excluir resposta da tabela

deleteTableResponse

Excluir campos

ID da Operação:

DeleteFields

Exclui um ou vários campos em uma tabela, com base na id do campo. Isso também excluirá permanentemente quaisquer dados ou cálculos nesse campo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
Ids de campo	fieldIds	True	array of integer	Lista de IDs de campo a serem excluídos.

Devoluções

Resposta Excluir Campos

deleteFieldsResponse

Excluir registros

ID da Operação:

DeleteRecords

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
de	from	True	string	O identificador exclusivo da tabela.
where	where	True	string	O filtro para excluir registros. Para eliminar todos os registos, especifique um filtro que inclua todos os registos, por exemplo {3.GT.0} em que 3 é o ID do campo ID do Registo.

Devoluções

Excluir resposta de registros

deleteRecordsResponse

Excluir um anexo

ID da Operação:

DeleteFile

Exclui uma versão de anexo de arquivo. Os 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 arquivos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.
ID do Registo	recordId	True	integer	O identificador exclusivo do registo.
ID do campo	fieldId	True	integer	O identificador exclusivo do campo.
Número da versão	versionNumber	True	integer	O número da versão do anexo do arquivo.

Devoluções

Excluir resposta de arquivo

deleteFileResponse

Excluir um relacionamento

ID da Operação:

DeleteRelationship

Use este ponto de extremidade para excluir um relacionamento inteiro, incluindo todos os campos de pesquisa e resumo. O campo de referência na relação não será eliminado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela. Esta será a mesa infantil.
ID de relacionamento	relationshipId	True	double	O ID da relação. Este é o ID do campo de referência na tabela filho.

Devoluções

Excluir resposta de relacionamento

deleteRelationshipResponse

Excluir um token de usuário

ID da Operação:

DeleteUserToken

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

Devoluções

Excluir resposta de token de usuário

deleteUserTokenResponse

Executar um relatório

ID da Operação:

RunReport

Executa um relatório, com base em um ID e retorna os dados subjacentes associados a ele. O formato dos dados varia de acordo com o tipo de relatório. Os relatórios que se concentram em dados de nível de registro (tabela, calendário, etc.) retornam os registros individuais. Os relatórios agregados (resumo, gráfico) retornarão as informações resumidas conforme configurado no relatório. Os 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 a resposta e coletar mais dados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador da tabela para o relatório.
Pular	skip		integer	O número de registros a serem ignorados. Você pode definir esse valor ao paginar através de um conjunto de resultados.
Início	top		integer	O número máximo de registros a serem retornados. Você pode substituir a paginação padrão do Quickbase 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 reunido em chamadas de API subsequentes.
			object
ID do relatório	reportId	True	string	O identificador do relatório, exclusivo da tabela.

Devoluções

Executar resposta de relatório

runReportResponse

Executar uma fórmula

ID da Operação:

RunFormula

Permite executar uma fórmula através de uma chamada de API. Use esse método em código personalizado para obter o valor de volta de uma fórmula sem um campo discreto em um registro.

Parâmetros

Name	Chave	Necessário	Tipo	Description
fórmula	formula	True	string	A fórmula a ser executada. Esta deve ser uma fórmula Quickbase válida.
livrar-se	rid		integer	A ID do registro contra a qual 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.
de	from	True	string	O identificador exclusivo (dbid) da tabela.

Devoluções

Executar resposta de fórmula

runFormulaResponse

Inserir eou atualizar registos

ID da Operação:

UpsertRecords

Inserir e/ou atualizar registo(s) numa tabela. Nesta única chamada de API, inserções e atualizações podem ser enviadas. A atualização pode usar o campo chave na tabela ou qualquer outro campo exclusivo suportado. 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.
Observação: Este endpoint suporta um tamanho máximo de carga útil de 10MB.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Para	to	True	string	O identificador da tabela.
dados	data		object
mergeFieldId	mergeFieldId		integer	O id do campo de mesclagem.
camposToReturn	fieldsToReturn		array of integer	Especifique uma matriz de IDs de campo que retornará dados para quaisquer atualizações ou registros adicionados. A ID do Registo (FID 3) é sempre devolvida se for solicitada qualquer ID de campo.

Devoluções

Uma resposta bem-sucedida que inclui detalhes sobre os registros adicionados, atualizados ou inalterados. No exemplo abaixo, a tabela tinha anteriormente 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 sucesso.

Resposta Upsert

upsertResponse

Obtenha todos os relacionamentos

ID da Operação:

GetRelationships

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Pular	skip		integer	O número de relações a serem ignoradas.
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela.

Devoluções

Obter resposta de relacionamentos

getRelationshipsResponse

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 'propriedades'. Consulte a página Tipos de campo para obter mais detalhes sobre as propriedades de cada tipo de campo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela.
Incluir permissões de campo	includeFieldPerms		boolean	Defina como 'true' se quiser recuperar as permissões personalizadas para o(s) campo(s).
ID do campo	fieldId	True	integer	O identificador único (FID) do campo.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela.
Incluir permissões de campo	includeFieldPerms		boolean	Defina como 'true' se quiser recuperar as permissões personalizadas para o(s) campo(s).

Devoluções

Name	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 embrulho	noWrap	boolean	Se não há invólucro.
Bold	bold	boolean	Seja ousado.
Obrigatório	required	boolean	Se necessário.
Aparece por padrão	appearsByDefault	boolean	Se aparece por padrão.
Localizar Ativado	findEnabled	boolean	Se a localização está ativada.
Unique	unique	boolean	Se único.
Copia dados	doesDataCopy	boolean	Se os dados são copiados.
Ajuda de campo	fieldHelp	string	A ajuda de campo.
Auditado	audited	boolean	Se auditado.
Chave primária	properties.primaryKey	boolean	Se a chave primária.
Chave Estrangeira	properties.foreignKey	boolean	Se a chave estrangeira.
Num Linhas	properties.numLines	integer	O número de linhas.
Comprimento máximo	properties.maxLength	integer	O comprimento máximo.
Acrescentar apenas	properties.appendOnly	boolean	Se anexar apenas.
allowHTML	properties.allowHTML	boolean	Se o HTML deve ser permitido.
Ordenar como dado	properties.sortAsGiven	boolean	Se ordenar como dado.
Opções de transporte	properties.carryChoices	boolean	Se deve levar escolhas.
Permitir novas escolhas	properties.allowNewChoices	boolean	Se deve permitir novas escolhas.
Formula	properties.formula	string	A fórmula.
Valor padrão	properties.defaultValue	string	O valor predefinido.
Formato de Número	properties.numberFormat	integer	O formato do número.
Casas decimais	properties.decimalPlaces	integer	As casas decimais.
Faz média	properties.doesAverage	boolean	Se faz média.
Faz Total	properties.doesTotal	boolean	Se totaliza.
Em branco é 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ções	permissions.role	string	O papel.
ID da função	permissions.roleId	integer	O identificador da função.
Adicionar a formulários	addToForms	boolean	Se deseja adicionar a formulários.

Obter eventos da aplicação

ID da Operação:

GetAppEvents

Obter uma lista de eventos que podem ser acionados com base em dados ou ações do usuário neste aplicativo, inclui: Notificação por e-mail, Lembretes, Assinaturas, Ações QB, Webhooks, Automações acionadas de alteração de registro (não inclui agendado).

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo.

Devoluções

Name	Caminho	Tipo	Description
		array of object
Tipo	type	string	O tipo.
Email	owner.email	string	O endereço de e-mail do proprietário.
ID	owner.id	string	O identificador do proprietário.
Nome	owner.name	string	O nome do proprietário.
Nome de Utilizador	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 URL.

Obter tabelas para uma aplicação

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 em Obter tabela.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo

Devoluções

Name	Caminho	Tipo	Description
		array of object
Nome	name	string	O nome.
Criado	created	string	Quando criado.
Updated	updated	string	Quando atualizado.
Alias	alias	string	O pseudônimo.
Description	description	string	A descrição.
ID	id	string	O identificador.
Próximo ID de Registro	nextRecordId	integer	O identificador do próximo registo.
Próximo ID de campo	nextFieldId	integer	O identificador do campo seguinte.
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 chave	keyFieldId	integer	O identificador do campo de chave.
Nome de registro único	singleRecordName	string	O nome do único registro.
Nome do Registro Plural	pluralRecordName	string	O nome do registro plural.
Limite de tamanho	sizeLimit	string	O limite de tamanho.
Espaço Utilizado	spaceUsed	string	O espaço utilizado.
Espaço Restante	spaceRemaining	string	O espaço restante.

Obter todos os relatórios de tabela

ID da Operação:

GetTableReports

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo da tabela.

Devoluções

Name	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 Último	usedLast	string	Quando usado por último.
Contagem de usados	usedCount	integer	A contagem usada.

Obter um relatório

ID da Operação:

GetReport

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

Parâmetros

Name	Chave	Necessá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.

Devoluções

Obter resposta de relatório

getReportResponse

Obter um token temporário para um DBID

ID da Operação:

GetTempTokenDBID

Use este 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 de API (consulte autorização). Este token expira em 5 minutos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Token do aplicativo	QB-App-Token		string	Seu token de aplicativo Quickbase
DBID	dbid	True	string	O identificador exclusivo de um aplicativo ou tabela.

Devoluções

getTempTokenDBIDResponse

getTempTokenDBIDResponse

Obter um uso de campo

ID da Operação:

GetFieldUsage

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela.
ID do campo	fieldId	True	integer	O identificador único (FID) do campo.

Devoluções

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

Obter uma aplicação

ID da Operação:

GetApp

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo.

Devoluções

Obter resposta do aplicativo

getAppResponse

Obter uma mesa

ID da Operação:

GetTable

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de Aplicação	appId	True	string	O identificador exclusivo de um aplicativo
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela.

Devoluções

Obter resposta da 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

Name	Chave	Necessário	Tipo	Description
ID da tabela	tableId	True	string	O identificador exclusivo (DBID) da tabela.
Pular	skip		integer	O número de campos a serem ignorados da lista.
Início	top		integer	O número máximo de campos a serem retornados.

Devoluções

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

Definições

createAppResponse

Name	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 reino, porque eles terão valores de lance diferentes. Exortamo-lo a ter cuidado ao fazê-lo.
descrição	description	string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.
criado	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 AAAA-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 AAAA-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 de campo no Guia da API para saber como os valores de tempo são retornados em chamadas de 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 para navegador - consulte a página Detalhes do tipo de campo no portal para saber como os valores de tempo são retornados em chamadas de API. Consulte Definir o fuso horário do aplicativo e da conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
temTodosOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Partilhar aplicações 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, ela não será retornada. Se a Classificação de Dados estiver ativada, mas o aplicativo não estiver rotulado, retornaremos "Nenhum". Os rótulos de Classificação de dados podem ser adicionados ao Admin Console por um administrador de realm para planos do Platform+.

Variável1

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

getAppResponse

Name	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 reino, porque eles terão valores de lance diferentes. Exortamo-lo a ter cuidado ao fazê-lo.
descrição	description	string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.
criado	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 AAAA-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 AAAA-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 de campo no Guia da API para saber como os valores de tempo são retornados em chamadas de 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 para navegador - consulte a página Detalhes do tipo de campo no portal para saber como os valores de tempo são retornados em chamadas de API. Consulte Definir o fuso horário do aplicativo e da conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
temTodosOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Partilhar aplicações 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, ela não será retornada. Se a Classificação de Dados estiver ativada, mas o aplicativo não estiver rotulado, retornaremos "Nenhum". Os rótulos de Classificação de dados podem ser adicionados ao Admin Console por um administrador de realm para planos do Platform+.

updateAppResponse

Name	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 reino, porque eles terão valores de lance diferentes. Exortamo-lo a ter cuidado ao fazê-lo.
descrição	description	string	A descrição do aplicativo. Se essa propriedade for deixada de fora, a descrição do aplicativo ficará em branco.
criado	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 AAAA-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 AAAA-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 de campo no Guia da API para saber como os valores de tempo são retornados em chamadas de 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 para navegador - consulte a página Detalhes do tipo de campo no portal para saber como os valores de tempo são retornados em chamadas de API. Consulte Definir o fuso horário do aplicativo e da conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
temTodosOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Partilhar aplicações 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, ela não será retornada. Se a Classificação de Dados estiver ativada, mas o aplicativo não estiver rotulado, retornaremos "Nenhum". Os rótulos de Classificação de dados podem ser adicionados ao Admin Console por um administrador de realm para planos do Platform+.

deleteAppResponse

Name	Caminho	Tipo	Description
excluídoAppId	deletedAppId	string	Um ID do aplicativo excluído.

copyAppResponse

Name	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 reino, porque eles terão valores de lance diferentes. Exortamo-lo a ter cuidado ao fazê-lo.
descrição	description	string	A descrição do aplicativo
criado	created	string	A hora e a data em que o aplicativo foi criado, no formato de hora ISO 8601 AAAA-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 AAAA-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 de campo no Guia da API para saber como os valores de tempo são retornados em chamadas de 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 para navegador - consulte a página Detalhes do tipo de campo no portal para saber como os valores de tempo são retornados em chamadas de API. Consulte Definir o fuso horário do aplicativo e da conta para definir o fuso horário do aplicativo.
id	id	string	O identificador exclusivo para este aplicativo.
temTodosOnTheInternet	hasEveryoneOnTheInternet	boolean	Indica se o aplicativo inclui o acesso a Todos na Internet. Consulte Partilhar aplicações com todos na Internet (EOTI).
variables	variables	array of Variable1	As variáveis do aplicativo. Consulte Sobre variáveis de aplicativo
ancestralId	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, ela não será retornada. Se a Classificação de Dados estiver ativada, mas o aplicativo não estiver rotulado, retornaremos "Nenhum". Os rótulos de Classificação de dados podem ser adicionados ao Admin Console por um administrador de realm para planos do Platform+.

createTableResponse

Name	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 configurado por um administrador de aplicativo.
criado	created	string	A hora e a data em que a tabela foi criada, no formato de hora ISO 8601 AAAA-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 AAAA-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
próximoRecordId	nextRecordId	integer	A ID de registro incremental que será usada quando o próximo registro for criado, conforme determinado quando a chamada de API foi executada.
próximoFieldId	nextFieldId	integer	O ID de campo incremental que será usado quando o próximo campo for criado, conforme determinado quando a chamada de 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 que está configurado para ser a chave nesta tabela, que geralmente é a ID de registro Quickbase.
singleRecordName	singleRecordName	string	O substantivo singular da tabela configurado pelo construtor.
pluralRecordName	pluralRecordName	string	O substantivo plural configurado pelo construtor da tabela.
tamanhoLimite	sizeLimit	string	O limite de tamanho para a tabela.
espaçoUsado	spaceUsed	string	A quantidade de espaço atualmente sendo usada pela tabela.
espaçoRestante	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.

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

DefaultSortOrder

string

getTableResponse

Name	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 configurado por um administrador de aplicativo.
criado	created	string	A hora e a data em que a tabela foi criada, no formato de hora ISO 8601 AAAA-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 AAAA-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
próximoRecordId	nextRecordId	integer	A ID de registro incremental que será usada quando o próximo registro for criado, conforme determinado quando a chamada de API foi executada.
próximoFieldId	nextFieldId	integer	O ID de campo incremental que será usado quando o próximo campo for criado, conforme determinado quando a chamada de 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 que está configurado para ser a chave nesta tabela, que geralmente é a ID de registro Quickbase.
singleRecordName	singleRecordName	string	O substantivo singular da tabela configurado pelo construtor.
pluralRecordName	pluralRecordName	string	O substantivo plural configurado pelo construtor da tabela.
tamanhoLimite	sizeLimit	string	O limite de tamanho para a tabela.
espaçoUsado	spaceUsed	string	A quantidade de espaço atualmente sendo usada pela tabela.
espaçoRestante	spaceRemaining	string	A quantidade de espaço restante para uso pela tabela.

updateTableResponse

Name	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 configurado por um administrador de aplicativo.
criado	created	string	A hora e a data em que a tabela foi criada, no formato de hora ISO 8601 AAAA-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 AAAA-MM-DDThh:mm:ss.sssZ (no fuso horário UTC).
próximoRecordId	nextRecordId	integer	A ID de registro incremental que será usada quando o próximo registro for criado, conforme determinado quando a chamada de API foi executada.
próximoFieldId	nextFieldId	integer	O ID de campo incremental que será usado quando o próximo campo for criado, conforme determinado quando a chamada de 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 que está configurado para ser a chave nesta tabela, que geralmente é a ID de registro Quickbase.
singleRecordName	singleRecordName	string	O substantivo singular da tabela configurado pelo construtor.
pluralRecordName	pluralRecordName	string	O substantivo plural configurado pelo construtor da tabela.
tamanhoLimite	sizeLimit	string	O limite de tamanho para a tabela.
espaçoUsado	spaceUsed	string	A quantidade de espaço atualmente sendo usada pela tabela.
espaçoRestante	spaceRemaining	string	A quantidade de espaço restante para uso pela tabela.

deleteTableResponse

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

getRelationshipsResponse

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

Relacionamento

Name	Caminho	Tipo	Description
id	id	integer	A id da relação (id do campo de chave estrangeira).
parentTableId	parentTableId	string	O ID da tabela pai da relação.
childTableId	childTableId	string	A ID da tabela filho da relação.
ForeignKeyField	foreignKeyField	ForeignKeyField	As informações de campo chave estrangeiras.
isCrossApp	isCrossApp	boolean	Se esta é 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 de campo chave estrangeiras.

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

LookupField

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

SummaryField

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

Metadados

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

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

createRelationshipResponse

Name	Caminho	Tipo	Description
id	id	integer	A id da relação (id do campo de chave estrangeira).
parentTableId	parentTableId	string	O ID da tabela pai da relação.
childTableId	childTableId	string	A ID da tabela filho da relação.
ForeignKeyField	foreignKeyField	ForeignKeyField	As informações de campo chave estrangeiras.
isCrossApp	isCrossApp	boolean	Se esta é 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

Name	Caminho	Tipo	Description
id	id	integer	A id da relação (id do campo de chave estrangeira).
parentTableId	parentTableId	string	O ID da tabela pai da relação.
childTableId	childTableId	string	A ID da tabela filho da relação.
ForeignKeyField	foreignKeyField	ForeignKeyField	As informações de campo chave estrangeiras.
isCrossApp	isCrossApp	boolean	Se esta é 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

Name	Caminho	Tipo	Description
relationshipId	relationshipId	integer	O id da relação.

Query

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

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

FormulaField

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

Tipo de campo

Tipo de valor de fórmula resultante.

Tipo de valor de fórmula resultante.

Tipo de campo

string

getReportResponse

Name	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.
ownerId	ownerId	integer	Opcional, mostrado apenas para relatórios pessoais. O ID de 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.
usadoÚltimo	usedLast	string	O instante em que um relatório foi usado pela última vez.
usadoContagem	usedCount	integer	O número de vezes que um relatório foi usado.

runReportResponse

Name	Caminho	Tipo	Description
campos	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 do 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 pode ser necessária se você especificar um número menor de resultados a serem ignorados do que o disponível ou se a API retornar automaticamente menos resultados. numRecords pode ser comparado com totalRecords para determinar se é necessária paginação adicional.

Campo

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

Metadados1

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

Name	Caminho	Tipo	Description
ignorar	skip	integer	O número de registros a serem ignorados
numFields	numFields	integer	O número de campos em cada registro no objeto de resposta atual
top	top	integer	Se existir, o número máximo de registos solicitados pelo autor da chamada
totalRegistos	totalRecords	integer	O número total de registos no conjunto de resultados
numRecords	numRecords	integer	O número de registros no objeto de resposta atual

Propriedades1

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.

Name	Caminho	Tipo	Description
comments	comments	string	Os comentários inseridos nas propriedades do campo por um administrador.
fazTotal	doesTotal	boolean	Se este campo é total em relatórios dentro do produto.
Gravação automática	autoSave	boolean	Se o campo de link será salvo automaticamente.
defaultValueLuid	defaultValueLuid	integer	Valor de ID de usuário padrão.
maxVersões	maxVersions	integer	O número máximo de versões configuradas para um anexo de arquivo.
carryChoices	carryChoices	boolean	Se o campo deve ter seus campos de múltipla escolha quando copiado.
format	format	integer	O formato para exibir o tempo.
maxComprimento	maxLength	integer	O número máximo de caracteres permitido para entrada no Quickbase para este campo.
linkTexto	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 composto pai, quando aplicável.
displayFuso horário	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 da criança, quando aplicável. Isso exibirá 0 se a função de resumo não exigir uma seleção de campo (como contagem).
permitirNovaEscolhas	allowNewChoices	boolean	Indica se os usuários podem adicionar novas opções a uma lista de seleção.
masterChoiceFieldId	masterChoiceFieldId	integer	O id do campo que é a referência na relação.
padrãoHoje	defaultToday	boolean	Indica se o valor do campo é padrão hoje para novos registros.
unidades	units	string	O rótulo das 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 acumulação 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 este campo faz parte.
fazMédia	doesAverage	boolean	Se este campo é a média em relatórios dentro do produto.
fórmula	formula	string	A fórmula do campo conforme configurada no Quickbase.
casas decimais	decimalPlaces	integer	O número de casas decimais exibidas no produto para este campo.
seeVersões	seeVersions	boolean	Indica se o usuário pode ver outras versões, além da mais recente, de um anexo de arquivo dentro do produto.
displayMês	displayMonth	string	Como exibir meses.
numLines	numLines	integer	O número de linhas mostradas no Quickbase para este campo de texto.
displayE-mail	displayEmail	string	Como o e-mail é exibido.
defaultKind	defaultKind	string	O tipo padrão do usuário.
capaTexto	coverText	string	Um texto alternativo amigável 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 da mesma forma que 0 nos cálculos dentro do produto.
exato	exact	boolean	Se uma correspondência exata é necessária para um link de relatório.
startField	startField	integer	O id do campo inicial.
defaultDomain	defaultDomain	string	Domínio de e-mail padrão.
defaultValue	defaultValue	string	O valor padrão configurado para um campo quando um novo registro é adicionado.
escolhasLuid	choicesLuid	array of object	Lista de opções do usuário.
items	choicesLuid	object
abreviar	abbreviate	boolean	Não mostre o protocolo de URL ao mostrar o URL.
xmlTag	xmlTag	string	A tag xml do campo.
targetTableName	targetTableName	string	O nome da tabela de destino do campo.
númeroFormato	numberFormat	integer	O formato usado para exibir valores numéricos no produto (decimal, separadores, grupo de dígitos).
apareceAs	appearsAs	string	O texto do link, se vazio, o url será usado como texto do link.
Largura	width	integer	A largura de entrada html do campo no produto.
Formato da moeda	currencyFormat	CurrencyFormat	O formato de moeda usado ao exibir valores de campo dentro do produto.
displayImagens	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 para este resumo.
vírgulaStart	commaStart	integer	O número de dígitos antes das vírgulas é exibido no produto, quando aplicável.
choices	choices	array of string	Uma matriz de entradas que existem para um campo que oferece opções ao usuário.
targetTableId	targetTableId	string	O id da tabela de destino.
displayRelativo	displayRelative	boolean	Se o tempo 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
Modo de versão	versionMode	VersionMode	Modos de versão para ficheiros. Manter todas as versões vs manter a última versão.
displayTime	displayTime	boolean	Indica se a hora deve ser exibida, além da data.
durationField	durationField	integer	O id do campo de duração.
snapFieldId	snapFieldId	integer	A id do campo que é usado para capturar valores de instantâneo, quando aplicável.
horas24	hours24	boolean	Indica se o tempo deve ou não ser exibido no formato de 24 horas dentro do produto.
sortAlpha	sortAlpha	boolean	Se a classificação alfabética deve ser ordenada, a classificação padrão é por ID de registro.
sortAsGiven	sortAsGiven	boolean	Indica se as entradas listadas classificam como inseridas vs alfabeticamente.
hasExtension	hasExtension	boolean	Se este campo tem uma extensão telefónica.
Semana de trabalho	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.
acrescentarApenas	appendOnly	boolean	Se este campo é apenas 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 este campo permite html.
lookupReferenceFieldId	lookupReferenceFieldId	integer	A id do campo que é a referência na relação para esta pesquisa.

SummaryFunction

O tipo de função de acumulação de resumo.

O tipo de função de acumulação de resumo.

SummaryFunction

string

Formato da moeda

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

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

Formato da moeda

string

Modo de versão

Modos de versão para ficheiros. Manter todas as versões vs manter a última versão.

Modos de versão para ficheiros. Manter todas as versões vs manter a última versão.

Modo de versão

string

Permissão

Name	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	O Id da função dada

createFieldResponse

Name	Caminho	Tipo	Description
id	id	integer	O id do campo, exclusivo para esta tabela.
Tipo de campo	fieldType	string	O tipo de campo, conforme descrito aqui.
mode	mode	string	Para campos derivados, 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 ser encapsulado quando exibido no produto.
bold	bold	boolean	Indica se o campo está configurado para ser exibido em negrito no produto.
required	required	boolean	Indica se o campo está marcado como obrigatório.
apareceByDefault	appearsByDefault	boolean	Indica se o campo está marcado como padrão nos 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.
campoAjuda	fieldHelp	string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
auditado	audited	boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase.
Propriedades1	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 diferentes funções.

deleteFieldsResponse

Name	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

Name	Caminho	Tipo	Description
id	id	integer	O id do campo, exclusivo para esta tabela.
Tipo de campo	fieldType	string	O tipo de campo, conforme descrito aqui.
mode	mode	string	Para campos derivados, 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 ser encapsulado quando exibido no produto.
bold	bold	boolean	Indica se o campo está configurado para ser exibido em negrito no produto.
required	required	boolean	Indica se o campo está marcado como obrigatório.
apareceByDefault	appearsByDefault	boolean	Indica se o campo está marcado como padrão nos 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.
campoAjuda	fieldHelp	string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
auditado	audited	boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase.
Propriedades1	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 diferentes funções.

updateFieldResponse

Name	Caminho	Tipo	Description
id	id	integer	O id do campo, exclusivo para esta tabela.
Tipo de campo	fieldType	string	O tipo de campo, conforme descrito aqui.
mode	mode	string	Para campos derivados, 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 ser encapsulado quando exibido no produto.
bold	bold	boolean	Indica se o campo está configurado para ser exibido em negrito no produto.
required	required	boolean	Indica se o campo está marcado como obrigatório.
apareceByDefault	appearsByDefault	boolean	Indica se o campo está marcado como padrão nos 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.
campoAjuda	fieldHelp	string	O texto de ajuda configurado mostrado aos usuários dentro do produto.
auditado	audited	boolean	Indica se o campo está sendo rastreado como parte dos Logs de Auditoria do Quickbase.
Propriedades1	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 diferentes funções.

runFormulaResponse

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

upsertResponse

Uma resposta bem-sucedida que inclui detalhes sobre os registros adicionados, atualizados ou inalterados. No exemplo abaixo, a tabela tinha anteriormente 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 sucesso.

Name	Caminho	Tipo	Description
Metadados2	metadata	Metadata2	Informações sobre registos criados, registos atualizados, registos referenciados, mas inalterados, e registos com quaisquer erros durante o processamento.
dados	data	array of object	Os dados que se espera que sejam devolvidos.
items	data	object

Metadados2

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

Name	Caminho	Tipo	Description
createdRecordIds	createdRecordIds	array of integer	Matriz que contém as ids de registro criadas.
lineErrors	lineErrors	object	Este só será devolvido em caso de registos falhados. É uma coleção de erros que ocorreram ao processar os dados recebidos que resultaram em registros não sendo processados. Cada objeto tem uma chave que representa o número de sequência do registro na carga útil original (a partir de 1). O valor é uma lista de erros ocorridos.
RecordIds inalterados	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.
totalNúmerodeRegistrosProcessados	totalNumberOfRecordsProcessed	integer	Número de registos processados. Inclui atualizações de registro bem-sucedidas e com falha.

deleteRecordsResponse

Name	Caminho	Tipo	Description
númeroSuprimido	numberDeleted	integer	O número de registos eliminados.

runQueryResponse

Name	Caminho	Tipo	Description
campos	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 do 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 pode ser necessária se você especificar um número menor de resultados a serem ignorados do que o disponível ou se a API retornar automaticamente menos resultados. numRecords pode ser comparado com totalRecords para determinar se é necessária paginação adicional.

Campos2

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

getTempTokenDBIDResponse

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

cloneUserTokenResponse

Name	Caminho	Tipo	Description
active	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 este token de usuário foi usado, no formato de hora ISO 8601 AAAA-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.
token	token	string	Valor do token de usuário.

App

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

deleteUserTokenResponse

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

deleteFileResponse

Name	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 quando a versão foi originalmente carregada.
Criador	creator	Creator	O usuário que carregou a versão.

Criador

O usuário que carregou a versão.

Name	Caminho	Tipo	Description
nome	name	string	Nome completo do usuário.
id	id	string	ID do usuário.
e-mail	email	string	E-mail do usuário.
nome de utilizador	userName	string	Nome de usuário conforme atualizado nas propriedades do usuário. Opcional, aparece se não for o mesmo que o e-mail do usuário.

cadeia (de caracteres)

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