Compartir a través de


Quickbase (publicador independiente)

Quickbase es una plataforma de desarrollo de aplicaciones que une a los equipos de TI y de negocio al permitir que los solucionadores de problemas de cualquier fondo técnico trabajen juntos para crear de forma segura y sostenible un ecosistema de aplicaciones. Quickbase ayuda a las empresas a acelerar la innovación continua de procesos únicos al permitir el desarrollo ciudadano a escala en una plataforma común.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Troy Taylor
URL https://www.hitachisolutions.com
Correo Electrónico ttaylor@hitachisolutions.com
Metadatos del conector
Publicador Troy Taylor, Hitachi Solutions
Sitio web https://www.quickbase.com/
Directiva de privacidad https://www.quickbase.com/privacy
Categorías Productividad;Operaciones de TI

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Nombre de host del dominio kerberos cuerda / cadena Especifique el nombre de host del dominio kerberos. Cierto
Authorization securestring Token de usuario para con el formato "QB-USER-TOKEN yourToken". Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualización de una aplicación

Actualiza las principales propiedades o variables de aplicación para una aplicación específica. Las propiedades de la aplicación que no especifique en el cuerpo de la solicitud permanecerán sin cambios.

Actualización de una tabla

Actualiza las propiedades principales de una tabla específica. Las propiedades de la tabla que no especifique en el cuerpo de la solicitud permanecerán sin cambios.

Actualizar un campo

Actualiza las propiedades y los permisos personalizados de un campo. El intento de actualizar determinadas propiedades puede hacer que los datos existentes ya no obedezcan las nuevas propiedades del campo y se pueden rechazar. Consulte las descripciones de las opciones necesarias, únicas y, a continuación, para ver situaciones específicas. Las propiedades del campo que no especifique en el cuerpo de la solicitud permanecerán sin cambios.

Actualizar una relación

Use este punto de conexión para agregar campos de búsqueda y campos de resumen a una relación existente. La actualización de una relación no eliminará los campos de búsqueda y resumen existentes.

Clonación de un token de usuario

Clona el token de usuario autenticado. Todas las aplicaciones asociadas a ese token se asocian automáticamente con el nuevo token.

Consulta de datos

Pase una consulta en el lenguaje de consulta Quickbase. Devuelve datos de registro con paginación inteligente en función del tamaño aproximado de cada registro. El objeto de metadatos incluirá la información necesaria para iterar la respuesta y recopilar más datos.

Copia de una aplicación

Copia la aplicación especificada. La nueva aplicación tendrá el mismo esquema que el original. Consulte a continuación para obtener más opciones de copia.

Creación de un campo

Crea un campo dentro de una tabla, incluidos los permisos personalizados de ese campo.

Creación de una tabla

Crea una tabla en una aplicación.

Crear una aplicación

Crea una aplicación en una cuenta. Debe tener derechos de creación de aplicaciones en la cuenta correspondiente. Las propiedades principales y las variables de aplicación se pueden establecer con esta API.

Crear una relación

Crea una relación en una tabla, así como campos de búsqueda y resumen. Las relaciones solo se pueden crear para tablas dentro de la misma aplicación.

Desactivación de un token de usuario

Desactiva el token de usuario autenticado. Una vez hecho esto, el token de usuario debe reactivarse en la interfaz de usuario.

Descargar datos adjuntos

Descarga los datos adjuntos del archivo, con el contenido de los datos adjuntos codificado en formato base64. La respuesta de LA API devuelve el nombre de archivo en el Content-Disposition encabezado. Los metadatos sobre los archivos se pueden recuperar de los puntos de conexión /records y /reports, si procede. Use esos puntos de conexión para obtener la información necesaria para capturar archivos.

Ejecución de un informe

Ejecuta un informe, basado en un identificador y devuelve los datos subyacentes asociados a él. El formato de los datos variará en función del tipo de informe. Los informes que se centran en los datos de nivel de registro (tabla, calendario, etc.) devuelven los registros individuales. Los informes agregados (resumen, gráfico) devolverán la información resumida configurada en el informe. No se devuelven elementos específicos de la interfaz de usuario, como totales, promedios y visualizaciones. Devuelve datos con paginación inteligente en función del tamaño aproximado de cada registro. El objeto de metadatos incluirá la información necesaria para iterar la respuesta y recopilar más datos.

Ejecución de una fórmula

Permite ejecutar una fórmula a través de una llamada API. Use este método en código personalizado para obtener el valor de una fórmula sin un campo discreto en un registro.

Eliminación de un token de usuario

Elimina el token de usuario autenticado. Esto no es reversible.

Eliminar campos

Elimina uno o varios campos de una tabla, en función del identificador de campo. Esto también eliminará permanentemente los datos o cálculos de ese campo.

Eliminar datos adjuntos

Elimina una versión de datos adjuntos de archivo. Los metadatos sobre los archivos se pueden recuperar de los puntos de conexión /records y /reports, si procede. Use esos puntos de conexión para obtener la información necesaria para eliminar versiones de archivo.

Eliminar registros

Elimina los registros de una tabla en función de una consulta. Como alternativa, se pueden eliminar todos los registros de la tabla.

Eliminar una aplicación

Elimina toda una aplicación, incluidas todas las tablas y los datos.

Eliminar una relación

Use este punto de conexión para eliminar una relación completa, incluidos todos los campos de búsqueda y resumen. El campo de referencia de la relación no se eliminará.

Eliminar una tabla

Elimina una tabla específica de una aplicación, incluidos todos los datos que contiene.

Insertar y actualizar registros

Insertar o actualizar registros en una tabla. En esta única llamada API, se pueden enviar inserciones y actualizaciones. La actualización puede usar el campo de clave de la tabla o cualquier otro campo único admitido. Consulte la página Tipos de campo para obtener más información sobre cómo se debe dar formato a cada tipo de campo. Esta operación permite el procesamiento incremental de registros correctos, incluso cuando se produce un error en algunos de los registros.
Nota: Este punto de conexión admite un tamaño máximo de carga de 10 MB.

Obtención de tablas para una aplicación

Obtiene una lista de todas las tablas que existen en una aplicación específica. Las propiedades de cada tabla son las mismas que las que se devuelven en Obtener tabla.

Obtención de un token temporal para un DBID

Use este punto de conexión para obtener un token de autorización temporal, con ámbito para una aplicación o una tabla. A continuación, puede usar este token para realizar otras llamadas API (consulte autorización). Este token expira en 5 minutos.

Obtención del uso de todos los campos

Obtenga todas las estadísticas de uso de campo de una tabla. Este es un resumen de la información que se puede encontrar en la tabla de uso de propiedades de campo.

Obtener campo

Obtiene las propiedades de un campo individual, basado en el identificador de campo.
Las propiedades presentes en todos los tipos de campo se devuelven en el nivel superior. Las propiedades únicas de un tipo específico de campo se devuelven en el atributo 'properties'. Consulte la página Tipos de campo para obtener más detalles sobre las propiedades de cada tipo de campo.

Obtener campos de una tabla

Obtiene las propiedades de todos los campos de una tabla específica. Las propiedades de cada campo son las mismas que en Obtener campo.

Obtener eventos de aplicación

Obtenga una lista de eventos que se pueden desencadenar en función de datos o acciones de usuario en esta aplicación, incluidos: Notificación por correo electrónico, Recordatorios, Suscripciones, Acciones de QB, Webhooks, Automatizaciones desencadenadas por cambios de registro (no incluye programada).

Obtener todas las relaciones

Obtenga una lista de todas las relaciones y sus definiciones para una tabla específica. Se proporcionan detalles para los lados primarios y secundarios de las relaciones dentro de una aplicación determinada. Se devuelven detalles limitados para las relaciones entre aplicaciones.

Obtener todos los informes de tabla

Obtiene el esquema (propiedades) de todos los informes de una tabla. Si el usuario que ejecuta la API es un administrador de aplicaciones, la API también devolverá todos los informes personales con el identificador de usuario del propietario.

Obtener un informe

Obtiene el esquema (propiedades) de un informe individual.

Obtener un uso de campo

Obtiene una sola estadística de uso de campos. Este es un resumen de la información que se puede encontrar en la tabla de uso de propiedades de campo.

Obtener una aplicación

Devuelve las propiedades principales de una aplicación, incluidas las variables de aplicación.

Obtener una tabla

Obtiene las propiedades de una tabla individual que forma parte de una aplicación.

Actualización de una aplicación

Actualiza las principales propiedades o variables de aplicación para una aplicación específica. Las propiedades de la aplicación que no especifique en el cuerpo de la solicitud permanecerán sin cambios.

Parámetros

Nombre Clave Requerido Tipo Description
nombre
name True string

Nombre de la variable.

value
value True string

Valor de la variable.

nombre
name string

Nombre de la aplicación.

descripción
description string

Descripción de la aplicación.

Identificador de aplicación
appId True string

Identificador único de una aplicación.

Devoluciones

Actualizar respuesta de la aplicación
updateAppResponse

Actualización de una tabla

Actualiza las propiedades principales de una tabla específica. Las propiedades de la tabla que no especifique en el cuerpo de la solicitud permanecerán sin cambios.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de aplicación
appId True string

Identificador único de una aplicación

nombre
name string

Nombre de la tabla.

pluralRecordName
pluralRecordName string

Nombre plural para los registros de la tabla. Si este valor no se pasa, el valor predeterminado es "Registros".

singleRecordName
singleRecordName string

Nombre singular para los registros de la tabla. Si este valor no se pasa, el valor predeterminado es "Record".

descripción
description string

Descripción de la tabla. Si este valor no se pasa, el valor predeterminado está en blanco.

ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Devoluciones

Actualizar respuesta de tabla
updateTableResponse

Actualizar un campo

Actualiza las propiedades y los permisos personalizados de un campo. El intento de actualizar determinadas propiedades puede hacer que los datos existentes ya no obedezcan las nuevas propiedades del campo y se pueden rechazar. Consulte las descripciones de las opciones necesarias, únicas y, a continuación, para ver situaciones específicas. Las propiedades del campo que no especifique en el cuerpo de la solicitud permanecerán sin cambios.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único de la tabla.

Auditado
audited boolean

Indica si se realiza el seguimiento del campo como parte de los registros de auditoría de Quickbase. Solo puede establecer esta propiedad en "true" si la aplicación tiene habilitados los registros de auditoría. Consulte Habilitación de los registros de cambios de datos en Registros de auditoría de quickbase.

fieldHelp
fieldHelp string

Texto de ayuda configurado que se muestra a los usuarios del producto.

negrita
bold boolean

Indica si el campo está configurado para mostrarse en negrita en el producto.

required
required boolean

Indica si el campo es necesario (es decir, si cada registro debe tener un valor distinto de NULL en este campo). Si intenta cambiar un campo de no obligatorio a obligatorio y la tabla contiene actualmente registros que tienen valores NULL en ese campo, obtendrá un error que indica que hay valores NULL del campo. En este caso, debe buscar y actualizar esos registros con valores NULL del campo antes de cambiar el campo a obligatorio.

comments
comments string

Comentarios especificados en las propiedades del campo por parte de un administrador.

doesTotal
doesTotal boolean

Indica si este campo se suma a los informes del producto.

autoguardado
autoSave boolean

Indica si el campo de vínculo se guardará automáticamente.

defaultValueLuid
defaultValueLuid integer

Valor de identificador de usuario predeterminado.

maxVersions
maxVersions integer

Número máximo de versiones configuradas para los datos adjuntos de un archivo.

format
format integer

Formato que se va a mostrar.

carryChoices
carryChoices boolean

Si el campo debe llevar sus campos de opción múltiple al copiarse.

longitud máxima
maxLength integer

Número máximo de caracteres permitidos para la entrada en Quickbase para este campo.

linkText
linkText string

Valor de texto configurado que reemplaza la dirección URL que ven los usuarios dentro del producto.

parentFieldId
parentFieldId integer

Identificador del campo compuesto primario, cuando procede.

displayTimezone
displayTimezone boolean

Indica si se va a mostrar la zona horaria dentro del producto.

summaryTargetFieldId
summaryTargetFieldId integer

Identificador del campo que se usa para agregar valores del elemento secundario, cuando corresponda. Esto muestra 0 si la función de resumen no requiere una selección de campo (como recuento).

allowNewChoices
allowNewChoices boolean

Indica si los usuarios pueden agregar nuevas opciones a una lista de selección.

defaultToday
defaultToday boolean

Indica si el valor del campo está predeterminado hoy en día para los nuevos registros.

unidades
units string

Etiqueta de unidades.

lookupTargetFieldId
lookupTargetFieldId integer

Identificador del campo que es el destino de la tabla primaria para esta búsqueda.

SummaryFunction3
summaryFunction string

Tipo de acumulación para el campo de resumen.

sourceFieldId
sourceFieldId integer

Identificador del campo de origen.

doesAverage
doesAverage boolean

Indica si este campo media en los informes del producto.

fórmula
formula string

Fórmula del campo tal como está configurada en Quickbase.

decimalPlaces
decimalPlaces integer

Número de posiciones decimales mostradas en el producto para este campo.

displayMonth
displayMonth string

Cómo mostrar meses.

seeVersions
seeVersions boolean

Indica si el usuario puede ver otras versiones, aparte de la más reciente, de un archivo adjunto dentro del producto.

numLines
numLines integer

Número de líneas que se muestran en Quickbase para este campo de texto.

defaultKind
defaultKind string

Tipo predeterminado de usuario.

displayEmail
displayEmail string

Cómo se muestra el correo electrónico.

coverText
coverText string

Texto descriptivo alternativo que se puede usar para mostrar un vínculo en el explorador.

currencySymbol
currencySymbol string

Símbolo actual utilizado al mostrar valores de campo dentro del producto.

summaryQuery
summaryQuery string

Consulta de resumen.

targetFieldId
targetFieldId integer

Identificador del campo de destino.

displayUser
displayUser string

La opción configurada para cómo se muestran los usuarios dentro del producto.

blankIsZero
blankIsZero boolean

Si un valor en blanco se trata igual que 0 en cálculos dentro del producto.

exacto
exact boolean

Si se requiere una coincidencia exacta para un vínculo de informe.

defaultDomain
defaultDomain string

Dominio de correo electrónico predeterminado.

defaultValue
defaultValue string

Valor predeterminado configurado para un campo cuando se agrega un nuevo registro.

abreviar
abbreviate boolean

No muestre el protocolo de dirección URL al mostrar la dirección URL.

numberFormat
numberFormat integer

Formato utilizado para mostrar valores numéricos en el producto (decimal, separadores, grupo de dígitos).

targetTableName
targetTableName string

Nombre de la tabla de destino del campo.

appearsAs
appearsAs string

El texto del vínculo, si está vacío, la dirección URL se usará como texto del vínculo.

Ancho
width integer

Ancho de entrada html del campo en el producto.

CurrencyFormat
currencyFormat string

Formato de moneda utilizado al mostrar valores de campo dentro del producto.

displayImages
displayImages boolean

Indica si las imágenes se mostrarán para los datos adjuntos de archivos en formularios e informes del producto.

displayDayOfWeek
displayDayOfWeek boolean

Indica si se va a mostrar el día de la semana dentro del producto.

summaryReferenceFieldId
summaryReferenceFieldId integer

Identificador del campo que es la referencia en la relación de este resumen.

commaStart
commaStart integer

Número de dígitos antes de que se muestren comas en el producto, cuando proceda.

choices
choices array of string

Matriz de entradas que existen para un campo que ofrece opciones al usuario. Tenga en cuenta que estas opciones hacen referencia a los valores válidos de los registros agregados en el futuro. Puede quitar valores de la lista de opciones incluso si hay registros existentes con esos valores en este campo. Se mostrarán en rojo cuando los usuarios vean los datos en el explorador, pero no hay ningún otro efecto. Al actualizar un campo con esta propiedad, las opciones antiguas se quitan y reemplazan por las nuevas opciones.

targetTableId
targetTableId string

Identificador de la tabla de destino.

displayRelative
displayRelative boolean

Indica si se va a mostrar la hora como relativa.

compositeFields
compositeFields object
summaryTableId
summaryTableId string

Tabla desde la que hace referencia el campo de resumen.

displayTime
displayTime boolean

Indica si se va a mostrar la hora, además de la fecha.

VersionMode
versionMode string

Modos de versión para archivos. Mantenga todas las versiones frente a mantener la última versión.

snapFieldId
snapFieldId integer

Identificador del campo que se usa para instantánear valores de , cuando corresponda.

horas24
hours24 boolean

Indica si se va a mostrar o no la hora en el formato de 24 horas dentro del producto.

sortAlpha
sortAlpha boolean

Si se va a ordenar alfabéticamente, la ordenación predeterminada es por identificador de registro.

sortAsGiven
sortAsGiven boolean

Indica si las entradas enumeradas se ordenan como especificadas alfabéticamente.

hasExtension
hasExtension boolean

Si este campo tiene una extensión de teléfono.

useNewWindow
useNewWindow boolean

Indica si la dirección URL debe abrir una nueva ventana cuando un usuario hace clic en ella dentro del producto.

appendOnly
appendOnly boolean

Indica si este campo solo está anexado.

displayAsLink
displayAsLink boolean

Indica si un campo que forma parte de la relación debe mostrarse como un hipervínculo al registro primario dentro del producto.

lookupReferenceFieldId
lookupReferenceFieldId integer

Identificador del campo que es la referencia en la relación de esta búsqueda.

appearsByDefault
appearsByDefault boolean

Indica si el campo está marcado como predeterminado en los informes.

único
unique boolean

Indica si cada registro de la tabla debe contener un valor único de este campo. Si intenta cambiar un campo de no único a único y la tabla contiene actualmente registros con el mismo valor de este campo, obtendrá un error. En este caso, debe buscar y actualizar esos registros con valores duplicados del campo antes de cambiar el campo a único.

role
role string

Rol asociado a un permiso determinado para el campo

permissionType
permissionType string

Permiso concedido al rol para este campo

roleId
roleId integer

Identificador del rol especificado

addToForms
addToForms boolean

Si el campo que va a agregar debe aparecer en los formularios.

label
label string

Etiqueta (nombre) del campo.

findEnabled
findEnabled boolean

Indica si el campo está marcado como buscable.

noWrap
noWrap boolean

Indica si el campo está configurado para no encapsularse cuando se muestra en el producto.

Id. de campo
fieldId True integer

Identificador único (FID) del campo.

Devoluciones

Actualizar respuesta de campo
updateFieldResponse

Actualizar una relación

Use este punto de conexión para agregar campos de búsqueda y campos de resumen a una relación existente. La actualización de una relación no eliminará los campos de búsqueda y resumen existentes.

Parámetros

Nombre Clave Requerido Tipo Description
summaryFid
summaryFid double

Identificador de campo que se va a resumir.

label
label string

Etiqueta del campo de resumen.

AccumulationType
accumulationType True string

Tipo de acumulación para el campo de resumen.

where
where string

El filtro, mediante el lenguaje de consulta Quickbase, que determina los registros que se van a devolver.

lookupFieldIds
lookupFieldIds array of integer

Matriz de identificadores de campo en la tabla primaria que se convertirá en campos de búsqueda en la tabla secundaria.

ID de tabla
tableId True string

Identificador único (DBID) de la tabla. Esta será la tabla secundaria.

Id. de relación
relationshipId True double

Identificador de relación. Este es el identificador de campo del campo de referencia de la tabla secundaria.

Devoluciones

Actualizar respuesta de relación
updateRelationshipResponse

Clonación de un token de usuario

Clona el token de usuario autenticado. Todas las aplicaciones asociadas a ese token se asocian automáticamente con el nuevo token.

Parámetros

Nombre Clave Requerido Tipo Description
nombre
name string

Nuevo nombre para el token de usuario clonado.

descripción
description string

Descripción del token de usuario clonado.

Devoluciones

Clonar respuesta de token de usuario
cloneUserTokenResponse

Consulta de datos

Pase una consulta en el lenguaje de consulta Quickbase. Devuelve datos de registro con paginación inteligente en función del tamaño aproximado de cada registro. El objeto de metadatos incluirá la información necesaria para iterar la respuesta y recopilar más datos.

Parámetros

Nombre Clave Requerido Tipo Description
skip
skip integer

Número de registros que se van a omitir.

compareWithAppLocalTime
compareWithAppLocalTime boolean

Si se va a ejecutar la consulta en un campo de fecha y hora con respecto a la hora local de la aplicación. La consulta se ejecuta con hora UTC de forma predeterminada.

top
top integer

Número máximo de registros que se van a mostrar.

where
where string

El filtro, mediante el lenguaje de consulta Quickbase, que determina los registros que se van a devolver. Si se omite este parámetro, la consulta devolverá todos los registros.

fieldId
fieldId integer

Identificador único de un campo de una tabla.

Grouping
grouping string

Agrupar según el orden ascendente (ASC), el orden descendente (DESC) o los valores iguales (iguales)

sortBy
sortBy object

De forma predeterminada, las consultas se ordenarán por los campos de ordenación especificados o la ordenación predeterminada si la consulta no proporciona ninguna. Establézcalo en false para evitar la ordenación cuando el orden de los datos devueltos no es importante. Devolver datos sin ordenar puede mejorar el rendimiento.

select
select object
desde
from True string

Identificador de tabla.

Devoluciones

Ejecutar respuesta de consulta
runQueryResponse

Copia de una aplicación

Copia la aplicación especificada. La nueva aplicación tendrá el mismo esquema que el original. Consulte a continuación para obtener más opciones de copia.

Parámetros

Nombre Clave Requerido Tipo Description
nombre
name True string

Nombre de la aplicación recién copiada

descripción
description string

Descripción de la aplicación recién copiada

assignUserToken
assignUserToken boolean

Si se va a agregar el token de usuario usado para realizar esta solicitud a la nueva aplicación

excludeFiles
excludeFiles boolean

Si keepData es true, si también se van a copiar los datos adjuntos del archivo. Si keepData es false, esta propiedad se omite.

keepData
keepData boolean

Si se van a copiar los datos de la aplicación junto con el esquema

usersAndRoles
usersAndRoles boolean

Si es true, los usuarios se copiarán junto con sus roles asignados. Si es false, los usuarios y los roles se copiarán, pero no se asignarán roles.

Identificador de aplicación
appId True string

Identificador único de una aplicación.

Devoluciones

Copia de la respuesta de la aplicación
copyAppResponse

Creación de un campo

Crea un campo dentro de una tabla, incluidos los permisos personalizados de ese campo.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único de la tabla.

Auditado
audited boolean

Indica si se realiza el seguimiento del campo como parte de los registros de auditoría de Quickbase. Solo puede establecer esta propiedad en "true" si la aplicación tiene habilitados los registros de auditoría. Consulte Habilitación de los registros de cambios de datos en Registros de auditoría de quickbase.

fieldHelp
fieldHelp string

Texto de ayuda configurado que se muestra a los usuarios del producto.

negrita
bold boolean

Indica si el campo está configurado para mostrarse en negrita en el producto.

comments
comments string

Comentarios especificados en las propiedades del campo por parte de un administrador.

doesTotal
doesTotal boolean

Indica si este campo se suma a los informes del producto.

autoguardado
autoSave boolean

Indica si el campo de vínculo se guardará automáticamente.

defaultValueLuid
defaultValueLuid integer

Valor de identificador de usuario predeterminado.

maxVersions
maxVersions integer

Número máximo de versiones configuradas para los datos adjuntos de un archivo.

format
format integer

Formato que se va a mostrar.

carryChoices
carryChoices boolean

Si el campo debe llevar sus campos de opción múltiple al copiarse.

longitud máxima
maxLength integer

Número máximo de caracteres permitidos para la entrada en Quickbase para este campo.

linkText
linkText string

Valor de texto configurado que reemplaza la dirección URL que ven los usuarios dentro del producto.

parentFieldId
parentFieldId integer

Identificador del campo compuesto primario, cuando procede.

displayTimezone
displayTimezone boolean

Indica si se va a mostrar la zona horaria dentro del producto.

allowNewChoices
allowNewChoices boolean

Indica si los usuarios pueden agregar nuevas opciones a una lista de selección.

defaultToday
defaultToday boolean

Indica si el valor del campo está predeterminado hoy en día para los nuevos registros.

unidades
units string

Etiqueta de unidades.

sourceFieldId
sourceFieldId integer

Identificador del campo de origen.

doesAverage
doesAverage boolean

Indica si este campo media en los informes del producto.

fórmula
formula string

Fórmula del campo tal como está configurada en Quickbase.

decimalPlaces
decimalPlaces integer

Número de posiciones decimales mostradas en el producto para este campo.

displayMonth
displayMonth string

Cómo mostrar meses.

seeVersions
seeVersions boolean

Indica si el usuario puede ver otras versiones, aparte de la más reciente, de un archivo adjunto dentro del producto.

numLines
numLines integer

Número de líneas que se muestran en Quickbase para este campo de texto.

defaultKind
defaultKind string

Tipo predeterminado de usuario.

displayEmail
displayEmail string

Cómo se muestra el correo electrónico.

coverText
coverText string

Texto descriptivo alternativo que se puede usar para mostrar un vínculo en el explorador.

currencySymbol
currencySymbol string

Símbolo actual utilizado al mostrar valores de campo dentro del producto.

targetFieldId
targetFieldId integer

Identificador del campo de destino.

displayUser
displayUser string

La opción configurada para cómo se muestran los usuarios dentro del producto.

blankIsZero
blankIsZero boolean

Si un valor en blanco se trata igual que 0 en cálculos dentro del producto.

exacto
exact boolean

Si se requiere una coincidencia exacta para un vínculo de informe.

defaultDomain
defaultDomain string

Dominio de correo electrónico predeterminado.

defaultValue
defaultValue string

Valor predeterminado configurado para un campo cuando se agrega un nuevo registro.

abreviar
abbreviate boolean

No muestre el protocolo de dirección URL al mostrar la dirección URL.

numberFormat
numberFormat integer

Formato utilizado para mostrar valores numéricos en el producto (decimal, separadores, grupo de dígitos).

targetTableName
targetTableName string

Nombre de la tabla de destino del campo.

appearsAs
appearsAs string

El texto del vínculo, si está vacío, la dirección URL se usará como texto del vínculo.

Ancho
width integer

Ancho de entrada html del campo en el producto.

CurrencyFormat
currencyFormat string

Formato de moneda utilizado al mostrar valores de campo dentro del producto.

displayImages
displayImages boolean

Indica si las imágenes se mostrarán para los datos adjuntos de archivos en formularios e informes del producto.

displayDayOfWeek
displayDayOfWeek boolean

Indica si se va a mostrar el día de la semana dentro del producto.

commaStart
commaStart integer

Número de dígitos antes de que se muestren comas en el producto, cuando proceda.

choices
choices array of string

Matriz de entradas que existen para un campo que ofrece opciones al usuario. Tenga en cuenta que estas opciones hacen referencia a los valores válidos de los registros agregados en el futuro. Puede quitar valores de la lista de opciones incluso si hay registros existentes con esos valores en este campo. Se mostrarán en rojo cuando los usuarios vean los datos en el explorador, pero no hay ningún otro efecto. Al actualizar un campo con esta propiedad, las opciones antiguas se quitan y reemplazan por las nuevas opciones.

targetTableId
targetTableId string

Identificador de la tabla de destino.

displayRelative
displayRelative boolean

Indica si se va a mostrar la hora como relativa.

compositeFields
compositeFields object
displayTime
displayTime boolean

Indica si se va a mostrar la hora, además de la fecha.

VersionMode
versionMode string

Modos de versión para archivos. Mantenga todas las versiones frente a mantener la última versión.

snapFieldId
snapFieldId integer

Identificador del campo que se usa para instantánear valores de , cuando corresponda.

horas24
hours24 boolean

Indica si se va a mostrar o no la hora en el formato de 24 horas dentro del producto.

sortAlpha
sortAlpha boolean

Si se va a ordenar alfabéticamente, la ordenación predeterminada es por identificador de registro.

sortAsGiven
sortAsGiven boolean

Indica si las entradas enumeradas se ordenan como especificadas alfabéticamente.

hasExtension
hasExtension boolean

Si este campo tiene una extensión de teléfono.

useNewWindow
useNewWindow boolean

Indica si la dirección URL debe abrir una nueva ventana cuando un usuario hace clic en ella dentro del producto.

appendOnly
appendOnly boolean

Indica si este campo solo está anexado.

displayAsLink
displayAsLink boolean

Indica si un campo que forma parte de la relación debe mostrarse como un hipervínculo al registro primario dentro del producto.

appearsByDefault
appearsByDefault boolean

Indica si el campo está marcado como predeterminado en los informes.

FieldType2
fieldType True string

Los tipos de campo, haga clic en cualquiera de los vínculos de tipo de campo para obtener más información.

role
role string

Rol asociado a un permiso determinado para el campo

permissionType
permissionType string

Permiso concedido al rol para este campo

roleId
roleId integer

Identificador del rol especificado

addToForms
addToForms boolean

Si el campo que va a agregar debe aparecer en los formularios.

label
label True string

Etiqueta (nombre) del campo.

findEnabled
findEnabled boolean

Indica si el campo está marcado como buscable.

noWrap
noWrap boolean

Indica si el campo está configurado para no encapsularse cuando se muestra en el producto.

Devoluciones

Crear respuesta de campo
createFieldResponse

Creación de una tabla

Crea una tabla en una aplicación.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de aplicación
appId True string

Identificador único de una aplicación

nombre
name True string

Nombre de la tabla.

pluralRecordName
pluralRecordName string

Nombre plural para los registros de la tabla. Si este valor no se pasa, el valor predeterminado es "Registros".

singleRecordName
singleRecordName string

Nombre singular para los registros de la tabla. Si este valor no se pasa, el valor predeterminado es "Record".

descripción
description string

Descripción de la tabla. Si este valor no se pasa, el valor predeterminado está en blanco.

Devoluciones

Crear respuesta de tabla
createTableResponse

Crear una aplicación

Crea una aplicación en una cuenta. Debe tener derechos de creación de aplicaciones en la cuenta correspondiente. Las propiedades principales y las variables de aplicación se pueden establecer con esta API.

Parámetros

Nombre Clave Requerido Tipo Description
assignToken
assignToken boolean

Establézcalo en true si desea asignar la aplicación al token de usuario que usó para crear la aplicación. El valor predeterminado es false.

nombre
name True string

Nombre de la variable.

value
value True string

Valor de la variable.

nombre
name True string

Nombre de la aplicación. Puede crear varias aplicaciones con el mismo nombre, en el mismo dominio, ya que tendrán valores dbid diferentes. Le instamos a tener cuidado al hacer esto.

descripción
description string

Descripción de la aplicación. Si esta propiedad se deja fuera, la descripción de la aplicación estará en blanco.

Devoluciones

Crear respuesta de la aplicación
createAppResponse

Crear una relación

Crea una relación en una tabla, así como campos de búsqueda y resumen. Las relaciones solo se pueden crear para tablas dentro de la misma aplicación.

Parámetros

Nombre Clave Requerido Tipo Description
summaryFid
summaryFid double

Identificador de campo que se va a resumir.

label
label string

Etiqueta del campo de resumen.

AccumulationType
accumulationType True string

Tipo de acumulación para el campo de resumen.

where
where string

El filtro, mediante el lenguaje de consulta Quickbase, que determina los registros que se van a devolver.

lookupFieldIds
lookupFieldIds array of integer

Matriz de identificadores de campo en la tabla primaria que se convertirá en campos de búsqueda en la tabla secundaria.

parentTableId
parentTableId True string

Identificador de tabla principal de la relación.

label
label string

Etiqueta del campo de clave externa.

ID de tabla
tableId True string

Identificador único (DBID) de la tabla. Esta será la tabla secundaria.

Devoluciones

Crear respuesta de relación
createRelationshipResponse

Desactivación de un token de usuario

Desactiva el token de usuario autenticado. Una vez hecho esto, el token de usuario debe reactivarse en la interfaz de usuario.

Devoluciones

Nombre Ruta de acceso Tipo Description
id
id integer

id

Descargar datos adjuntos

Descarga los datos adjuntos del archivo, con el contenido de los datos adjuntos codificado en formato base64. La respuesta de LA API devuelve el nombre de archivo en el Content-Disposition encabezado. Los metadatos sobre los archivos se pueden recuperar de los puntos de conexión /records y /reports, si procede. Use esos puntos de conexión para obtener la información necesaria para capturar archivos.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único de la tabla.

Identificador de registro
recordId True integer

El identificador único del registro.

Id. de campo
fieldId True integer

Identificador único del campo.

Número de versión
versionNumber True integer

Número de versión de datos adjuntos del archivo.

Devoluciones

response
string

Ejecución de un informe

Ejecuta un informe, basado en un identificador y devuelve los datos subyacentes asociados a él. El formato de los datos variará en función del tipo de informe. Los informes que se centran en los datos de nivel de registro (tabla, calendario, etc.) devuelven los registros individuales. Los informes agregados (resumen, gráfico) devolverán la información resumida configurada en el informe. No se devuelven elementos específicos de la interfaz de usuario, como totales, promedios y visualizaciones. Devuelve datos con paginación inteligente en función del tamaño aproximado de cada registro. El objeto de metadatos incluirá la información necesaria para iterar la respuesta y recopilar más datos.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador de la tabla del informe.

Omitir
skip integer

Número de registros que se van a omitir. Puede establecer este valor al paginar a través de un conjunto de resultados.

Arriba
top integer

Número máximo de registros que se van a devolver. Puede invalidar la paginación de Quickbase predeterminada para obtener más o menos resultados. Si el valor solicitado aquí supera los máximos dinámicos, se devolverá un subconjunto de resultados y el resto se puede recopilar en llamadas API posteriores.

object
Id. de informe
reportId True string

Identificador del informe, único para la tabla.

Devoluciones

Ejecutar respuesta de informe
runReportResponse

Ejecución de una fórmula

Permite ejecutar una fórmula a través de una llamada API. Use este método en código personalizado para obtener el valor de una fórmula sin un campo discreto en un registro.

Parámetros

Nombre Clave Requerido Tipo Description
fórmula
formula True string

Fórmula que se va a ejecutar. Debe ser una fórmula quickbase válida.

librar
rid integer

Identificador de registro en el que se va a ejecutar la fórmula. Solo es necesario para las fórmulas que se ejecutan en el contexto de un registro. Por ejemplo, la fórmula User() no necesita un identificador de registro.

desde
from True string

Identificador único (dbid) de la tabla.

Devoluciones

Ejecutar respuesta de fórmula
runFormulaResponse

Eliminación de un token de usuario

Elimina el token de usuario autenticado. Esto no es reversible.

Devoluciones

Eliminar respuesta de token de usuario
deleteUserTokenResponse

Eliminar campos

Elimina uno o varios campos de una tabla, en función del identificador de campo. Esto también eliminará permanentemente los datos o cálculos de ese campo.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único de la tabla.

fieldIds
fieldIds True array of integer

Lista de identificadores de campo que se van a eliminar.

Devoluciones

Eliminar respuesta de campos
deleteFieldsResponse

Eliminar datos adjuntos

Elimina una versión de datos adjuntos de archivo. Los metadatos sobre los archivos se pueden recuperar de los puntos de conexión /records y /reports, si procede. Use esos puntos de conexión para obtener la información necesaria para eliminar versiones de archivo.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único de la tabla.

Identificador de registro
recordId True integer

El identificador único del registro.

Id. de campo
fieldId True integer

Identificador único del campo.

Número de versión
versionNumber True integer

Número de versión de datos adjuntos del archivo.

Devoluciones

Eliminar respuesta de archivo
deleteFileResponse

Eliminar registros

Elimina los registros de una tabla en función de una consulta. Como alternativa, se pueden eliminar todos los registros de la tabla.

Parámetros

Nombre Clave Requerido Tipo Description
desde
from True string

Identificador único de la tabla.

where
where True string

Filtro para eliminar registros. Para eliminar todos los registros, especifique un filtro que incluirá todos los registros, por ejemplo {3.GT.0} donde 3 es el identificador del campo Id. de registro.

Devoluciones

Eliminar respuesta de registros
deleteRecordsResponse

Eliminar una aplicación

Elimina toda una aplicación, incluidas todas las tablas y los datos.

Parámetros

Nombre Clave Requerido Tipo Description
nombre
name True string

Para confirmar la eliminación de la aplicación, se solicita el nombre de la aplicación.

Identificador de aplicación
appId True string

Identificador único de una aplicación.

Devoluciones

Eliminar respuesta de la aplicación
deleteAppResponse

Eliminar una relación

Use este punto de conexión para eliminar una relación completa, incluidos todos los campos de búsqueda y resumen. El campo de referencia de la relación no se eliminará.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único (DBID) de la tabla. Esta será la tabla secundaria.

Id. de relación
relationshipId True double

Identificador de relación. Este es el identificador de campo del campo de referencia de la tabla secundaria.

Devoluciones

Eliminar respuesta de relación
deleteRelationshipResponse

Eliminar una tabla

Elimina una tabla específica de una aplicación, incluidos todos los datos que contiene.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de aplicación
appId True string

Identificador único de una aplicación

ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Devoluciones

Eliminar respuesta de tabla
deleteTableResponse

Insertar y actualizar registros

Insertar o actualizar registros en una tabla. En esta única llamada API, se pueden enviar inserciones y actualizaciones. La actualización puede usar el campo de clave de la tabla o cualquier otro campo único admitido. Consulte la página Tipos de campo para obtener más información sobre cómo se debe dar formato a cada tipo de campo. Esta operación permite el procesamiento incremental de registros correctos, incluso cuando se produce un error en algunos de los registros.
Nota: Este punto de conexión admite un tamaño máximo de carga de 10 MB.

Parámetros

Nombre Clave Requerido Tipo Description
to
to True string

Identificador de tabla.

datos
data object
mergeFieldId
mergeFieldId integer

Identificador del campo de combinación.

fieldsToReturn
fieldsToReturn array of integer

Especifique una matriz de identificadores de campo que devolverá datos para cualquier actualización o registro agregado. El identificador de registro (FID 3) siempre se devuelve si se solicita algún identificador de campo.

Devoluciones

Respuesta correcta que incluye detalles sobre los registros agregados, actualizados o sin cambios. En el ejemplo siguiente, la tabla tenía anteriormente diez registros con identificadores de 1 a 10. El usuario publica un upsert que actualiza el valor del registro 1 y agrega dos registros nuevos, todos correctamente.

Respuesta upsert
upsertResponse

Obtención de tablas para una aplicación

Obtiene una lista de todas las tablas que existen en una aplicación específica. Las propiedades de cada tabla son las mismas que las que se devuelven en Obtener tabla.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de aplicación
appId True string

Identificador único de una aplicación

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
Nombre
name string

Nombre.

Creado
created string

Cuando se crea.

Actualizado
updated string

Cuando se actualiza.

Alias
alias string

Alias.

Description
description string

Descripción.

identificación
id string

Identificador.

Id. de registro siguiente
nextRecordId integer

Identificador del siguiente registro.

Id. de campo siguiente
nextFieldId integer

Identificador del campo siguiente.

Identificador de campo de ordenación predeterminado
defaultSortFieldId integer

Identificador del campo de ordenación predeterminado.

Criterio de ordenación predeterminado
defaultSortOrder string

Criterio de ordenación predeterminado.

Id. de campo de clave
keyFieldId integer

Identificador del campo de clave.

Nombre de registro único
singleRecordName string

Nombre de registro único.

Nombre del registro plural
pluralRecordName string

Nombre del registro plural.

Límite de tamaño
sizeLimit string

Límite de tamaño.

Espacio usado
spaceUsed string

Espacio usado.

Espacio restante
spaceRemaining string

Espacio restante.

Obtención de un token temporal para un DBID

Use este punto de conexión para obtener un token de autorización temporal, con ámbito para una aplicación o una tabla. A continuación, puede usar este token para realizar otras llamadas API (consulte autorización). Este token expira en 5 minutos.

Parámetros

Nombre Clave Requerido Tipo Description
Token de aplicación
QB-App-Token string

El token de aplicación de Quickbase

DBID
dbid True string

Identificador único de una aplicación o tabla.

Devoluciones

getTempTokenDBIDResponse
getTempTokenDBIDResponse

Obtención del uso de todos los campos

Obtenga todas las estadísticas de uso de campo de una tabla. Este es un resumen de la información que se puede encontrar en la tabla de uso de propiedades de campo.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Omitir
skip integer

Número de campos que se van a omitir de la lista.

Arriba
top integer

Número máximo de campos que se van a devolver.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
identificación
field.id integer

Identificador.

Nombre
field.name string

Nombre.

Tipo
field.type string

Tipo.

Contar
usage.actions.count integer

Recuento.

Contar
usage.appHomePages.count integer

Recuento.

Contar
usage.defaultReports.count integer

Recuento.

Contar
usage.exactForms.count integer

Recuento.

Contar
usage.fields.count integer

Recuento.

Contar
usage.forms.count integer

Recuento.

Contar
usage.notifications.count integer

Recuento.

Contar
usage.personalReports.count integer

Recuento.

Contar
usage.relationships.count integer

Recuento.

Contar
usage.reminders.count integer

Recuento.

Contar
usage.reports.count integer

Recuento.

Contar
usage.roles.count integer

Recuento.

Contar
usage.webhooks.count integer

Recuento.

Obtener campo

Obtiene las propiedades de un campo individual, basado en el identificador de campo.
Las propiedades presentes en todos los tipos de campo se devuelven en el nivel superior. Las propiedades únicas de un tipo específico de campo se devuelven en el atributo 'properties'. Consulte la página Tipos de campo para obtener más detalles sobre las propiedades de cada tipo de campo.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Incluir permisos de campo
includeFieldPerms boolean

Establézcalo en "true" si desea obtener los permisos personalizados para los campos.

Id. de campo
fieldId True integer

Identificador único (FID) del campo.

Devoluciones

Obtener respuesta de campo
getFieldResponse

Obtener campos de una tabla

Obtiene las propiedades de todos los campos de una tabla específica. Las propiedades de cada campo son las mismas que en Obtener campo.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Incluir permisos de campo
includeFieldPerms boolean

Establézcalo en "true" si desea obtener los permisos personalizados para los campos.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
identificación
id integer

Identificador.

Etiqueta
label string

Etiqueta.

Tipo de campo
fieldType string

Tipo de campo.

Sin ajuste
noWrap boolean

Si no hay ningún ajuste.

Bold
bold boolean

Si es negrita.

Obligatorio
required boolean

Indica si es necesario.

Aparece de forma predeterminada
appearsByDefault boolean

Indica si aparece de forma predeterminada.

Buscar habilitado
findEnabled boolean

Indica si la búsqueda está habilitada.

Unique
unique boolean

Si es único.

¿Copia de datos?
doesDataCopy boolean

Si realiza la copia de datos.

Ayuda de campo
fieldHelp string

Ayuda de campo.

Auditado
audited boolean

Si se audita.

Clave principal
properties.primaryKey boolean

Indica si la clave principal.

Clave externa
properties.foreignKey boolean

Indica si la clave externa.

Líneas de número
properties.numLines integer

Número de líneas.

Longitud máxima
properties.maxLength integer

Longitud máxima.

Solo anexar
properties.appendOnly boolean

Si solo se anexa.

allowHTML
properties.allowHTML boolean

Indica si se va a permitir HTML.

Ordenar como dado
properties.sortAsGiven boolean

Si se ordena como se indica.

Opciones de transporte
properties.carryChoices boolean

Si se deben llevar a cabo opciones.

Permitir nuevas opciones
properties.allowNewChoices boolean

Si se permiten nuevas opciones.

Formula
properties.formula string

La fórmula.

Valor predeterminado
properties.defaultValue string

Valor predeterminado.

Formato de número
properties.numberFormat integer

Formato de número.

Número de decimales
properties.decimalPlaces integer

Posiciones decimales.

Hace promedio
properties.doesAverage boolean

Si lo hace el promedio.

Hace total
properties.doesTotal boolean

Si es total.

El valor en blanco es cero
properties.blankIsZero boolean

Si el valor en blanco es cero.

Permissions
permissions array of object
Tipo de permiso
permissions.permissionType string

Tipo de permiso.

Rol
permissions.role string

Rol.

Id. de rol
permissions.roleId integer

Identificador del rol.

Agregar a formularios
addToForms boolean

Si se va a agregar a formularios.

Obtener eventos de aplicación

Obtenga una lista de eventos que se pueden desencadenar en función de datos o acciones de usuario en esta aplicación, incluidos: Notificación por correo electrónico, Recordatorios, Suscripciones, Acciones de QB, Webhooks, Automatizaciones desencadenadas por cambios de registro (no incluye programada).

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de aplicación
appId True string

Identificador único de una aplicación.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
Tipo
type string

Tipo.

Correo Electrónico
owner.email string

Dirección de correo electrónico del propietario.

identificación
owner.id string

Identificador del propietario.

Nombre
owner.name string

Nombre del propietario.

Nombre de usuario
owner.userName string

Nombre de usuario del propietario.

Está activo
isActive boolean

Si está activo.

ID de tabla
tableId string

Identificador de la tabla.

Nombre
name string

Nombre.

URL
url string

Dirección URL.

Obtener todas las relaciones

Obtenga una lista de todas las relaciones y sus definiciones para una tabla específica. Se proporcionan detalles para los lados primarios y secundarios de las relaciones dentro de una aplicación determinada. Se devuelven detalles limitados para las relaciones entre aplicaciones.

Parámetros

Nombre Clave Requerido Tipo Description
Omitir
skip integer

Número de relaciones que se van a omitir.

ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Devoluciones

Obtener respuesta de relaciones
getRelationshipsResponse

Obtener todos los informes de tabla

Obtiene el esquema (propiedades) de todos los informes de una tabla. Si el usuario que ejecuta la API es un administrador de aplicaciones, la API también devolverá todos los informes personales con el identificador de usuario del propietario.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único de la tabla.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
identificación
id string

Identificador.

Nombre
name string

Nombre.

Tipo
type string

Tipo.

Description
description string

Descripción.

Id. del propietario
ownerId string

Identificador del propietario.

Última vez que se usa
usedLast string

Cuando se usa por última vez.

Recuento usado
usedCount integer

Recuento usado.

Obtener un informe

Obtiene el esquema (propiedades) de un informe individual.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único de la tabla.

Id. de informe
reportId True string

Identificador del informe, único para la tabla.

Devoluciones

Obtener respuesta de informe
getReportResponse

Obtener un uso de campo

Obtiene una sola estadística de uso de campos. Este es un resumen de la información que se puede encontrar en la tabla de uso de propiedades de campo.

Parámetros

Nombre Clave Requerido Tipo Description
ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Id. de campo
fieldId True integer

Identificador único (FID) del campo.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
identificación
field.id integer

Identificador.

Nombre
field.name string

Nombre.

Tipo
field.type string

Tipo.

Contar
usage.actions.count integer

Recuento.

Contar
usage.appHomePages.count integer

Recuento.

Contar
usage.defaultReports.count integer

Recuento.

Contar
usage.exactForms.count integer

Recuento.

Contar
usage.fields.count integer

Recuento.

Contar
usage.forms.count integer

Recuento.

Contar
usage.notifications.count integer

Recuento.

Contar
usage.personalReports.count integer

Recuento.

Contar
usage.relationships.count integer

Recuento.

Contar
usage.reminders.count integer

Recuento.

Contar
usage.reports.count integer

Recuento.

Contar
usage.roles.count integer

Recuento.

Contar
usage.webhooks.count integer

Recuento.

Obtener una aplicación

Devuelve las propiedades principales de una aplicación, incluidas las variables de aplicación.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de aplicación
appId True string

Identificador único de una aplicación.

Devoluciones

Obtener respuesta de la aplicación
getAppResponse

Obtener una tabla

Obtiene las propiedades de una tabla individual que forma parte de una aplicación.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de aplicación
appId True string

Identificador único de una aplicación

ID de tabla
tableId True string

Identificador único (DBID) de la tabla.

Devoluciones

Obtener respuesta de tabla
getTableResponse

Definiciones

createAppResponse

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de la aplicación. Puede crear varias aplicaciones con el mismo nombre, en el mismo dominio, ya que tendrán valores dbid diferentes. Le instamos a tener cuidado al hacer esto.

descripción
description string

Descripción de la aplicación. Si esta propiedad se deja fuera, la descripción de la aplicación estará en blanco.

creado
created string

La hora y la fecha en que se creó la aplicación, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

Actualizado
updated string

La hora y la fecha en que se actualizó la aplicación por última vez, en el formato de hora ISO 8601 AAAA-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

dateFormat
dateFormat string

Descripción del formato usado al mostrar valores de fecha en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo de la Guía de API para ver cómo se devuelven los valores de hora en las llamadas API. Consulta Acerca de la localización de fechas para establecer el formato de fecha de la aplicación.

timeZone
timeZone string

Descripción de la zona horaria que se usa al mostrar valores de hora en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo en el portal para ver cómo se devuelven los valores de hora en las llamadas API. Consulte Establecer la zona horaria para la aplicación y la cuenta para establecer la zona horaria de la aplicación.

id
id string

Identificador único de esta aplicación.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica si la aplicación incluye el acceso a Todos en Internet. Consulta Uso compartido de aplicaciones con todos en Internet (EOTI).

variables
variables array of Variable1

Variables de la aplicación. Consulte Acerca de las variables de aplicación.

dataClassification
dataClassification string

Etiqueta clasificación de datos asignada a la aplicación. Si la clasificación de datos no está activada, no se devolverá. Si la clasificación de datos está activada, pero la aplicación no está etiquetada, se devuelve "None". Las etiquetas de clasificación de datos se pueden agregar en la Consola de administración mediante un administrador de dominio para planes de Plataforma+.

Variable1

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de variable.

value
value string

Valor de variable.

getAppResponse

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de la aplicación. Puede crear varias aplicaciones con el mismo nombre, en el mismo dominio, ya que tendrán valores dbid diferentes. Le instamos a tener cuidado al hacer esto.

descripción
description string

Descripción de la aplicación. Si esta propiedad se deja fuera, la descripción de la aplicación estará en blanco.

creado
created string

La hora y la fecha en que se creó la aplicación, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

Actualizado
updated string

La hora y la fecha en que se actualizó la aplicación por última vez, en el formato de hora ISO 8601 AAAA-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

dateFormat
dateFormat string

Descripción del formato usado al mostrar valores de fecha en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo de la Guía de API para ver cómo se devuelven los valores de hora en las llamadas API. Consulta Acerca de la localización de fechas para establecer el formato de fecha de la aplicación.

timeZone
timeZone string

Descripción de la zona horaria que se usa al mostrar valores de hora en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo en el portal para ver cómo se devuelven los valores de hora en las llamadas API. Consulte Establecer la zona horaria para la aplicación y la cuenta para establecer la zona horaria de la aplicación.

id
id string

Identificador único de esta aplicación.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica si la aplicación incluye el acceso a Todos en Internet. Consulta Uso compartido de aplicaciones con todos en Internet (EOTI).

variables
variables array of Variable1

Variables de la aplicación. Consulte Acerca de las variables de aplicación.

dataClassification
dataClassification string

Etiqueta clasificación de datos asignada a la aplicación. Si la clasificación de datos no está activada, no se devolverá. Si la clasificación de datos está activada, pero la aplicación no está etiquetada, se devuelve "None". Las etiquetas de clasificación de datos se pueden agregar en la Consola de administración mediante un administrador de dominio para planes de Plataforma+.

updateAppResponse

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de la aplicación. Puede crear varias aplicaciones con el mismo nombre, en el mismo dominio, ya que tendrán valores dbid diferentes. Le instamos a tener cuidado al hacer esto.

descripción
description string

Descripción de la aplicación. Si esta propiedad se deja fuera, la descripción de la aplicación estará en blanco.

creado
created string

La hora y la fecha en que se creó la aplicación, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

Actualizado
updated string

La hora y la fecha en que se actualizó la aplicación por última vez, en el formato de hora ISO 8601 AAAA-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

dateFormat
dateFormat string

Descripción del formato usado al mostrar valores de fecha en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo de la Guía de API para ver cómo se devuelven los valores de hora en las llamadas API. Consulta Acerca de la localización de fechas para establecer el formato de fecha de la aplicación.

timeZone
timeZone string

Descripción de la zona horaria que se usa al mostrar valores de hora en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo en el portal para ver cómo se devuelven los valores de hora en las llamadas API. Consulte Establecer la zona horaria para la aplicación y la cuenta para establecer la zona horaria de la aplicación.

id
id string

Identificador único de esta aplicación.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica si la aplicación incluye el acceso a Todos en Internet. Consulta Uso compartido de aplicaciones con todos en Internet (EOTI).

variables
variables array of Variable1

Variables de la aplicación. Consulte Acerca de las variables de aplicación.

dataClassification
dataClassification string

Etiqueta clasificación de datos asignada a la aplicación. Si la clasificación de datos no está activada, no se devolverá. Si la clasificación de datos está activada, pero la aplicación no está etiquetada, se devuelve "None". Las etiquetas de clasificación de datos se pueden agregar en la Consola de administración mediante un administrador de dominio para planes de Plataforma+.

deleteAppResponse

Nombre Ruta de acceso Tipo Description
deletedAppId
deletedAppId string

Identificador de la aplicación eliminada.

copyAppResponse

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de la aplicación. Puede crear varias aplicaciones con el mismo nombre, en el mismo dominio, ya que tendrán valores dbid diferentes. Le instamos a tener cuidado al hacer esto.

descripción
description string

Descripción de la aplicación

creado
created string

La hora y la fecha en que se creó la aplicación, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

Actualizado
updated string

La hora y la fecha en que se actualizó la aplicación por última vez, en el formato de hora ISO 8601 AAAA-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

dateFormat
dateFormat string

Descripción del formato usado al mostrar valores de fecha en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo de la Guía de API para ver cómo se devuelven los valores de hora en las llamadas API. Consulta Acerca de la localización de fechas para establecer el formato de fecha de la aplicación.

timeZone
timeZone string

Descripción de la zona horaria que se usa al mostrar valores de hora en esta aplicación. Tenga en cuenta que se trata de un parámetro de solo explorador: consulte la página Detalles del tipo de campo en el portal para ver cómo se devuelven los valores de hora en las llamadas API. Consulte Establecer la zona horaria para la aplicación y la cuenta para establecer la zona horaria de la aplicación.

id
id string

Identificador único de esta aplicación.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica si la aplicación incluye el acceso a Todos en Internet. Consulta Uso compartido de aplicaciones con todos en Internet (EOTI).

variables
variables array of Variable1

Variables de la aplicación. Consulte Acerca de las variables de aplicación.

antecesorId
ancestorId string

El identificador de la aplicación desde la que se copió esta aplicación.

dataClassification
dataClassification string

Etiqueta clasificación de datos asignada a la aplicación. Si la clasificación de datos no está activada, no se devolverá. Si la clasificación de datos está activada, pero la aplicación no está etiquetada, se devuelve "None". Las etiquetas de clasificación de datos se pueden agregar en la Consola de administración mediante un administrador de dominio para planes de Plataforma+.

createTableResponse

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de la tabla.

id
id string

Identificador único (dbid) de la tabla.

alias
alias string

Alias de tabla creado automáticamente para la tabla.

descripción
description string

Descripción de la tabla, tal como lo configura un administrador de aplicaciones.

creado
created string

Hora y fecha en que se creó la tabla, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

Actualizado
updated string

Hora y fecha en que se actualizó por última vez el esquema de tabla o los datos, en el formato de hora ISO 8601 AAAA-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

nextRecordId
nextRecordId integer

Identificador de registro incremental que se usará cuando se cree el siguiente registro, según se determine cuando se ejecutó la llamada API.

nextFieldId
nextFieldId integer

Identificador de campo incremental que se usará cuando se cree el siguiente campo, según se determine cuando se ejecutó la llamada API.

defaultSortFieldId
defaultSortFieldId integer

Identificador del campo que está configurado para la ordenación predeterminada.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Configuración del criterio de ordenación predeterminado en la tabla.

keyFieldId
keyFieldId integer

Identificador del campo configurado para que sea la clave de esta tabla, que suele ser el identificador de registro de quickbase.

singleRecordName
singleRecordName string

Nombre singular configurado por el generador de la tabla.

pluralRecordName
pluralRecordName string

Nombre plural configurado por el generador de la tabla.

sizeLimit
sizeLimit string

Límite de tamaño de la tabla.

spaceUsed
spaceUsed string

Cantidad de espacio que está usando actualmente la tabla.

spaceRemaining
spaceRemaining string

Cantidad de espacio restante para su uso por parte de la tabla.

DefaultSortOrder

Configuración del criterio de ordenación predeterminado en la tabla.

Configuración del criterio de ordenación predeterminado en la tabla.

DefaultSortOrder
string

getTableResponse

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de la tabla.

id
id string

Identificador único (dbid) de la tabla.

alias
alias string

Alias de tabla creado automáticamente para la tabla.

descripción
description string

Descripción de la tabla, tal como lo configura un administrador de aplicaciones.

creado
created string

Hora y fecha en que se creó la tabla, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

Actualizado
updated string

Hora y fecha en que se actualizó por última vez el esquema de tabla o los datos, en el formato de hora ISO 8601 AAAA-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

nextRecordId
nextRecordId integer

Identificador de registro incremental que se usará cuando se cree el siguiente registro, según se determine cuando se ejecutó la llamada API.

nextFieldId
nextFieldId integer

Identificador de campo incremental que se usará cuando se cree el siguiente campo, según se determine cuando se ejecutó la llamada API.

defaultSortFieldId
defaultSortFieldId integer

Identificador del campo que está configurado para la ordenación predeterminada.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Configuración del criterio de ordenación predeterminado en la tabla.

keyFieldId
keyFieldId integer

Identificador del campo configurado para que sea la clave de esta tabla, que suele ser el identificador de registro de quickbase.

singleRecordName
singleRecordName string

Nombre singular configurado por el generador de la tabla.

pluralRecordName
pluralRecordName string

Nombre plural configurado por el generador de la tabla.

sizeLimit
sizeLimit string

Límite de tamaño de la tabla.

spaceUsed
spaceUsed string

Cantidad de espacio que está usando actualmente la tabla.

spaceRemaining
spaceRemaining string

Cantidad de espacio restante para su uso por parte de la tabla.

updateTableResponse

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre de la tabla.

id
id string

Identificador único (dbid) de la tabla.

alias
alias string

Alias de tabla creado automáticamente para la tabla.

descripción
description string

Descripción de la tabla, tal como lo configura un administrador de aplicaciones.

creado
created string

Hora y fecha en que se creó la tabla, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

Actualizado
updated string

Hora y fecha en que se actualizó por última vez el esquema de tabla o los datos, en el formato de hora ISO 8601 AAAA-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

nextRecordId
nextRecordId integer

Identificador de registro incremental que se usará cuando se cree el siguiente registro, según se determine cuando se ejecutó la llamada API.

nextFieldId
nextFieldId integer

Identificador de campo incremental que se usará cuando se cree el siguiente campo, según se determine cuando se ejecutó la llamada API.

defaultSortFieldId
defaultSortFieldId integer

Identificador del campo que está configurado para la ordenación predeterminada.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Configuración del criterio de ordenación predeterminado en la tabla.

keyFieldId
keyFieldId integer

Identificador del campo configurado para que sea la clave de esta tabla, que suele ser el identificador de registro de quickbase.

singleRecordName
singleRecordName string

Nombre singular configurado por el generador de la tabla.

pluralRecordName
pluralRecordName string

Nombre plural configurado por el generador de la tabla.

sizeLimit
sizeLimit string

Límite de tamaño de la tabla.

spaceUsed
spaceUsed string

Cantidad de espacio que está usando actualmente la tabla.

spaceRemaining
spaceRemaining string

Cantidad de espacio restante para su uso por parte de la tabla.

deleteTableResponse

Nombre Ruta de acceso Tipo Description
deletedTableId
deletedTableId string

Identificador de tabla eliminado.

getRelationshipsResponse

Nombre Ruta de acceso Tipo Description
Relaciones
relationships array of Relationship

Relaciones de una tabla.

Metadatos
metadata Metadata

Información adicional sobre los resultados que pueden resultar útiles.

Relación

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador de relación (id. de campo de clave externa).

parentTableId
parentTableId string

Identificador de tabla principal de la relación.

childTableId
childTableId string

Identificador de tabla secundario de la relación.

ForeignKeyField
foreignKeyField ForeignKeyField

Información del campo de clave externa.

isCrossApp
isCrossApp boolean

Si se trata de una relación entre aplicaciones.

lookupFields
lookupFields array of LookupField

Matriz de campos de búsqueda.

summaryFields
summaryFields array of SummaryField

Matriz de campos de resumen.

ForeignKeyField

Información del campo de clave externa.

Nombre Ruta de acceso Tipo Description
id
id integer

Id. de campo.

label
label string

Etiqueta de campo.

type
type string

Tipo de campo.

LookupField

Nombre Ruta de acceso Tipo Description
id
id integer

Id. de campo.

label
label string

Etiqueta de campo.

type
type string

Tipo de campo.

SummaryField

Nombre Ruta de acceso Tipo Description
id
id integer

Id. de campo.

label
label string

Etiqueta de campo.

type
type string

Tipo de campo.

Metadatos

Información adicional sobre los resultados que pueden resultar útiles.

Nombre Ruta de acceso Tipo Description
skip
skip integer

Número de relaciones que se van a omitir.

totalRelationships
totalRelationships integer

Número total de relaciones.

numRelationships
numRelationships integer

Número de relaciones en el objeto de respuesta actual.

createRelationshipResponse

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador de relación (id. de campo de clave externa).

parentTableId
parentTableId string

Identificador de tabla principal de la relación.

childTableId
childTableId string

Identificador de tabla secundario de la relación.

ForeignKeyField
foreignKeyField ForeignKeyField

Información del campo de clave externa.

isCrossApp
isCrossApp boolean

Si se trata de una relación entre aplicaciones.

lookupFields
lookupFields array of LookupField

Matriz de campos de búsqueda.

summaryFields
summaryFields array of SummaryField

Matriz de campos de resumen.

updateRelationshipResponse

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador de relación (id. de campo de clave externa).

parentTableId
parentTableId string

Identificador de tabla principal de la relación.

childTableId
childTableId string

Identificador de tabla secundario de la relación.

ForeignKeyField
foreignKeyField ForeignKeyField

Información del campo de clave externa.

isCrossApp
isCrossApp boolean

Si se trata de una relación entre aplicaciones.

lookupFields
lookupFields array of LookupField

Matriz de campos de búsqueda.

summaryFields
summaryFields array of SummaryField

Matriz de campos de resumen.

deleteRelationshipResponse

Nombre Ruta de acceso Tipo Description
relationshipId
relationshipId integer

Identificador de relación.

Query

La definición de consulta como se configura en Quickbase que se ejecuta cuando se ejecuta el informe.

Nombre Ruta de acceso Tipo Description
tableId
tableId string

Identificador de tabla del informe.

filtro
filter string

Filtro usado para consultar datos.

formulaFields
formulaFields array of FormulaField

Campos de fórmula calculados.

FormulaField

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador de campo de fórmula.

label
label string

Etiqueta de campo de fórmula.

FieldType
fieldType FieldType

Tipo de valor de fórmula resultante.

fórmula
formula string

Texto de la fórmula.

decimalPrecision
decimalPrecision integer

Para la fórmula numérica, la precisión del número.

FieldType

Tipo de valor de fórmula resultante.

Tipo de valor de fórmula resultante.

FieldType
string

getReportResponse

Nombre Ruta de acceso Tipo Description
id
id string

Identificador del informe, único para la tabla.

nombre
name string

Nombre configurado del informe.

type
type string

Tipo de informe en Quickbase (por ejemplo, gráfico).

descripción
description string

Descripción configurada de un informe.

ownerId
ownerId integer

Opcional, se muestra solo para informes personales. Identificador de usuario del propietario del informe.

Query
query Query

La definición de consulta como se configura en Quickbase que se ejecuta cuando se ejecuta el informe.

Propiedades
properties object

Lista de propiedades específicas del tipo de informe. Para ver una descripción detallada de las propiedades de cada tipo de informe, consulte Tipos de informe .

usedLast
usedLast string

El instante en el que se usó por última vez un informe.

usedCount
usedCount integer

Número de veces que se ha usado un informe.

runReportResponse

Nombre Ruta de acceso Tipo Description
fields
fields array of Field

Matriz de objetos que contiene metadatos limitados de cada campo que se muestra en el informe. Esto ayuda a crear lógica que depende de los tipos de campo e identificadores.

datos
data array of object

Matriz de objetos que representa los datos de registro o valores resumidos, según el tipo de informe.

items
data object
Metadata1
metadata Metadata1

Información adicional sobre los resultados que pueden resultar útiles. La paginación puede ser necesaria si especifica un número menor de resultados que omitir que está disponible o si la API devuelve automáticamente menos resultados. numRecords se puede comparar con totalRecords para determinar si se necesita más paginación.

Campo

Nombre Ruta de acceso Tipo Description
id
id integer

Id. de campo.

label
label string

Etiqueta de campo.

type
type string

Tipo de campo.

labelOverride
labelOverride string

Invalidación de la etiqueta de encabezado de columna para el campo del informe.

Metadata1

Información adicional sobre los resultados que pueden resultar útiles. La paginación puede ser necesaria si especifica un número menor de resultados que omitir que está disponible o si la API devuelve automáticamente menos resultados. numRecords se puede comparar con totalRecords para determinar si se necesita más paginación.

Nombre Ruta de acceso Tipo Description
skip
skip integer

Número de registros que se van a omitir

numFields
numFields integer

Número de campos de cada registro del objeto de respuesta actual

top
top integer

Si está presente, el número máximo de registros solicitados por el autor de la llamada

totalRecords
totalRecords integer

Número total de registros del conjunto de resultados

numRecords
numRecords integer

Número de registros en el objeto de respuesta actual

Propiedades1

Propiedades adicionales para el campo. Consulte la página Detalles del tipo de campo para obtener más detalles sobre las propiedades de cada tipo de campo.

Nombre Ruta de acceso Tipo Description
comments
comments string

Comentarios especificados en las propiedades del campo por parte de un administrador.

doesTotal
doesTotal boolean

Indica si este campo se suma a los informes del producto.

autoguardado
autoSave boolean

Indica si el campo de vínculo se guardará automáticamente.

defaultValueLuid
defaultValueLuid integer

Valor de identificador de usuario predeterminado.

maxVersions
maxVersions integer

Número máximo de versiones configuradas para los datos adjuntos de un archivo.

carryChoices
carryChoices boolean

Si el campo debe llevar sus campos de opción múltiple al copiarse.

format
format integer

Formato que se va a mostrar.

longitud máxima
maxLength integer

Número máximo de caracteres permitidos para la entrada en Quickbase para este campo.

linkText
linkText string

Valor de texto configurado que reemplaza la dirección URL que ven los usuarios dentro del producto.

parentFieldId
parentFieldId integer

Identificador del campo compuesto primario, cuando procede.

displayTimezone
displayTimezone boolean

Indica si se va a mostrar la zona horaria dentro del producto.

summaryTargetFieldId
summaryTargetFieldId integer

Identificador del campo que se usa para agregar valores del elemento secundario, cuando corresponda. Esto muestra 0 si la función de resumen no requiere una selección de campo (como recuento).

allowNewChoices
allowNewChoices boolean

Indica si los usuarios pueden agregar nuevas opciones a una lista de selección.

masterChoiceFieldId
masterChoiceFieldId integer

Identificador del campo que es la referencia en la relación.

defaultToday
defaultToday boolean

Indica si el valor del campo está predeterminado hoy en día para los nuevos registros.

unidades
units string

Etiqueta de unidades.

lookupTargetFieldId
lookupTargetFieldId integer

Identificador del campo que es el destino de la tabla maestra para esta búsqueda.

SummaryFunction
summaryFunction SummaryFunction

Tipo de función de acumulación de resumen.

sourceFieldId
sourceFieldId integer

Identificador del campo de origen.

masterTableTag
masterTableTag string

Alias de tabla de la tabla maestra de la relación de la que forma parte este campo.

doesAverage
doesAverage boolean

Indica si este campo media en los informes del producto.

fórmula
formula string

Fórmula del campo tal como está configurada en Quickbase.

decimalPlaces
decimalPlaces integer

Número de posiciones decimales mostradas en el producto para este campo.

seeVersions
seeVersions boolean

Indica si el usuario puede ver otras versiones, aparte de la más reciente, de un archivo adjunto dentro del producto.

displayMonth
displayMonth string

Cómo mostrar meses.

numLines
numLines integer

Número de líneas que se muestran en Quickbase para este campo de texto.

displayEmail
displayEmail string

Cómo se muestra el correo electrónico.

defaultKind
defaultKind string

Tipo predeterminado de usuario.

coverText
coverText string

Texto descriptivo alternativo que se puede usar para mostrar un vínculo en el explorador.

currencySymbol
currencySymbol string

Símbolo actual utilizado al mostrar valores de campo dentro del producto.

masterChoiceTableId
masterChoiceTableId integer

Identificador de la tabla que es el patrón de esta relación.

targetFieldId
targetFieldId integer

Identificador del campo de destino.

displayUser
displayUser string

La opción configurada para cómo se muestran los usuarios dentro del producto.

blankIsZero
blankIsZero boolean

Si un valor en blanco se trata igual que 0 en cálculos dentro del producto.

exacto
exact boolean

Si se requiere una coincidencia exacta para un vínculo de informe.

startField
startField integer

Identificador del campo de inicio.

defaultDomain
defaultDomain string

Dominio de correo electrónico predeterminado.

defaultValue
defaultValue string

Valor predeterminado configurado para un campo cuando se agrega un nuevo registro.

choicesLuid
choicesLuid array of object

Lista de opciones de usuario.

items
choicesLuid object
abreviar
abbreviate boolean

No muestre el protocolo de dirección URL al mostrar la dirección URL.

xmlTag
xmlTag string

Etiqueta xml del campo.

targetTableName
targetTableName string

Nombre de la tabla de destino del campo.

numberFormat
numberFormat integer

Formato utilizado para mostrar valores numéricos en el producto (decimal, separadores, grupo de dígitos).

appearsAs
appearsAs string

El texto del vínculo, si está vacío, la dirección URL se usará como texto del vínculo.

Ancho
width integer

Ancho de entrada html del campo en el producto.

CurrencyFormat
currencyFormat CurrencyFormat

Formato de moneda utilizado al mostrar valores de campo dentro del producto.

displayImages
displayImages boolean

Indica si las imágenes se mostrarán para los datos adjuntos de archivos en formularios e informes del producto.

foreignKey
foreignKey boolean

Indica si el campo es una clave externa (o un campo de referencia) en una relación.

displayDayOfWeek
displayDayOfWeek boolean

Indica si se va a mostrar el día de la semana dentro del producto.

summaryReferenceFieldId
summaryReferenceFieldId integer

Identificador del campo que es la referencia en la relación de este resumen.

commaStart
commaStart integer

Número de dígitos antes de que se muestren comas en el producto, cuando proceda.

choices
choices array of string

Matriz de entradas que existen para un campo que ofrece opciones al usuario.

targetTableId
targetTableId string

Identificador de la tabla de destino.

displayRelative
displayRelative boolean

Indica si se va a mostrar la hora como relativa.

compositeFields
compositeFields array of object

Matriz de los campos que componen un campo compuesto (por ejemplo, dirección).

items
compositeFields object
VersionMode
versionMode VersionMode

Modos de versión para archivos. Mantenga todas las versiones frente a mantener la última versión.

displayTime
displayTime boolean

Indica si se va a mostrar la hora, además de la fecha.

durationField
durationField integer

Identificador del campo de duración.

snapFieldId
snapFieldId integer

Identificador del campo que se usa para instantánear valores de , cuando corresponda.

horas24
hours24 boolean

Indica si se va a mostrar o no la hora en el formato de 24 horas dentro del producto.

sortAlpha
sortAlpha boolean

Si se va a ordenar alfabéticamente, la ordenación predeterminada es por identificador de registro.

sortAsGiven
sortAsGiven boolean

Indica si las entradas enumeradas se ordenan como especificadas alfabéticamente.

hasExtension
hasExtension boolean

Si este campo tiene una extensión de teléfono.

Workweek
workWeek integer

Tipo de semana laboral.

useNewWindow
useNewWindow boolean

Indica si la dirección URL debe abrir una nueva ventana cuando un usuario hace clic en ella dentro del producto.

appendOnly
appendOnly boolean

Indica si este campo solo está anexado.

displayAsLink
displayAsLink boolean

Indica si un campo que forma parte de la relación debe mostrarse como un hipervínculo al registro primario dentro del producto.

allowHTML
allowHTML boolean

Indica si este campo permite html.

lookupReferenceFieldId
lookupReferenceFieldId integer

Identificador del campo que es la referencia en la relación de esta búsqueda.

SummaryFunction

Tipo de función de acumulación de resumen.

Tipo de función de acumulación de resumen.

SummaryFunction
string

CurrencyFormat

Formato de moneda utilizado al mostrar valores de campo dentro del producto.

Formato de moneda utilizado al mostrar valores de campo dentro del producto.

CurrencyFormat
string

VersionMode

Modos de versión para archivos. Mantenga todas las versiones frente a mantener la última versión.

Modos de versión para archivos. Mantenga todas las versiones frente a mantener la última versión.

VersionMode
string

Permiso

Nombre Ruta de acceso Tipo Description
role
role string

Rol asociado a un permiso determinado para el campo

permissionType
permissionType string

Permiso concedido al rol para este campo

roleId
roleId integer

Identificador del rol especificado

createFieldResponse

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador del campo, único para esta tabla.

fieldType
fieldType string

Tipo de campo, como se describe aquí.

mode
mode string

En el caso de los campos derivados, será "lookup", "summary" o "formula", para indicar el tipo de campo derivado. En el caso de los campos no derivados, estará en blanco.

label
label string

Etiqueta (nombre) del campo.

noWrap
noWrap boolean

Indica si el campo está configurado para no encapsularse cuando se muestra en el producto.

negrita
bold boolean

Indica si el campo está configurado para mostrarse en negrita en el producto.

required
required boolean

Indica si el campo está marcado como obligatorio.

appearsByDefault
appearsByDefault boolean

Indica si el campo está marcado como predeterminado en los informes.

findEnabled
findEnabled boolean

Indica si el campo está marcado como buscable.

único
unique boolean

Indica si el campo está marcado como único.

doesDataCopy
doesDataCopy boolean

Indica si los datos del campo se copiarán cuando un usuario copie el registro.

fieldHelp
fieldHelp string

Texto de ayuda configurado que se muestra a los usuarios del producto.

Auditado
audited boolean

Indica si se realiza el seguimiento del campo como parte de los registros de auditoría de Quickbase.

Propiedades1
properties Properties1

Propiedades adicionales para el campo. Consulte la página Detalles del tipo de campo para obtener más detalles sobre las propiedades de cada tipo de campo.

permissions
permissions array of Permission

Permisos de campo para distintos roles.

deleteFieldsResponse

Nombre Ruta de acceso Tipo Description
deletedFieldIds
deletedFieldIds array of integer

Lista de identificadores de campo que se eliminaron.

Errores
errors array of string

Lista de errores encontrados.

getFieldResponse

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador del campo, único para esta tabla.

fieldType
fieldType string

Tipo de campo, como se describe aquí.

mode
mode string

En el caso de los campos derivados, será "lookup", "summary" o "formula", para indicar el tipo de campo derivado. En el caso de los campos no derivados, estará en blanco.

label
label string

Etiqueta (nombre) del campo.

noWrap
noWrap boolean

Indica si el campo está configurado para no encapsularse cuando se muestra en el producto.

negrita
bold boolean

Indica si el campo está configurado para mostrarse en negrita en el producto.

required
required boolean

Indica si el campo está marcado como obligatorio.

appearsByDefault
appearsByDefault boolean

Indica si el campo está marcado como predeterminado en los informes.

findEnabled
findEnabled boolean

Indica si el campo está marcado como buscable.

único
unique boolean

Indica si el campo está marcado como único.

doesDataCopy
doesDataCopy boolean

Indica si los datos del campo se copiarán cuando un usuario copie el registro.

fieldHelp
fieldHelp string

Texto de ayuda configurado que se muestra a los usuarios del producto.

Auditado
audited boolean

Indica si se realiza el seguimiento del campo como parte de los registros de auditoría de Quickbase.

Propiedades1
properties Properties1

Propiedades adicionales para el campo. Consulte la página Detalles del tipo de campo para obtener más detalles sobre las propiedades de cada tipo de campo.

permissions
permissions array of Permission

Permisos de campo para distintos roles.

updateFieldResponse

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador del campo, único para esta tabla.

fieldType
fieldType string

Tipo de campo, como se describe aquí.

mode
mode string

En el caso de los campos derivados, será "lookup", "summary" o "formula", para indicar el tipo de campo derivado. En el caso de los campos no derivados, estará en blanco.

label
label string

Etiqueta (nombre) del campo.

noWrap
noWrap boolean

Indica si el campo está configurado para no encapsularse cuando se muestra en el producto.

negrita
bold boolean

Indica si el campo está configurado para mostrarse en negrita en el producto.

required
required boolean

Indica si el campo está marcado como obligatorio.

appearsByDefault
appearsByDefault boolean

Indica si el campo está marcado como predeterminado en los informes.

findEnabled
findEnabled boolean

Indica si el campo está marcado como buscable.

único
unique boolean

Indica si el campo está marcado como único.

doesDataCopy
doesDataCopy boolean

Indica si los datos del campo se copiarán cuando un usuario copie el registro.

fieldHelp
fieldHelp string

Texto de ayuda configurado que se muestra a los usuarios del producto.

Auditado
audited boolean

Indica si se realiza el seguimiento del campo como parte de los registros de auditoría de Quickbase.

Propiedades1
properties Properties1

Propiedades adicionales para el campo. Consulte la página Detalles del tipo de campo para obtener más detalles sobre las propiedades de cada tipo de campo.

permissions
permissions array of Permission

Permisos de campo para distintos roles.

runFormulaResponse

Nombre Ruta de acceso Tipo Description
resultado
result string

Resultado de la ejecución de la fórmula.

upsertResponse

Respuesta correcta que incluye detalles sobre los registros agregados, actualizados o sin cambios. En el ejemplo siguiente, la tabla tenía anteriormente diez registros con identificadores de 1 a 10. El usuario publica un upsert que actualiza el valor del registro 1 y agrega dos registros nuevos, todos correctamente.

Nombre Ruta de acceso Tipo Description
Metadatos2
metadata Metadata2

Información sobre los registros creados, los registros actualizados, los registros a los que se hace referencia pero no se modifican, y los registros tienen errores mientras se procesan.

datos
data array of object

Los datos que se espera que se devuelvan.

items
data object

Metadatos2

Información sobre los registros creados, los registros actualizados, los registros a los que se hace referencia pero no se modifican, y los registros tienen errores mientras se procesan.

Nombre Ruta de acceso Tipo Description
createdRecordIds
createdRecordIds array of integer

Matriz que contiene los identificadores de registro creados.

lineErrors
lineErrors object

Esto solo se devolverá en el caso de registros con errores. Se trata de una colección de errores que se produjeron al procesar los datos entrantes que provocaron que los registros no se procesaran. Cada objeto tiene una clave que representa el número de secuencia del registro en la carga original (a partir de 1). El valor es una lista de errores.

unchangedRecordIds
unchangedRecordIds array of integer

Matriz que contiene los identificadores de registro sin cambios.

updatedRecordIds
updatedRecordIds array of integer

Matriz que contiene los identificadores de registro actualizados.

totalNumberOfRecordsProcessed
totalNumberOfRecordsProcessed integer

Número de registros procesados. Incluye actualizaciones de registros correctas y con errores.

deleteRecordsResponse

Nombre Ruta de acceso Tipo Description
numberDeleted
numberDeleted integer

Número de registros eliminados.

runQueryResponse

Nombre Ruta de acceso Tipo Description
fields
fields array of Fields2

Matriz de objetos que contiene metadatos limitados de cada campo que se muestra en el informe. Esto ayuda a crear lógica que depende de los tipos de campo e identificadores.

datos
data array of object

Matriz de objetos que representa los datos de registro o valores resumidos, según el tipo de informe.

items
data object
Metadata1
metadata Metadata1

Información adicional sobre los resultados que pueden resultar útiles. La paginación puede ser necesaria si especifica un número menor de resultados que omitir que está disponible o si la API devuelve automáticamente menos resultados. numRecords se puede comparar con totalRecords para determinar si se necesita más paginación.

Campos2

Nombre Ruta de acceso Tipo Description
id
id integer

Id. de campo.

label
label string

Etiqueta de campo.

type
type string

Tipo de campo.

getTempTokenDBIDResponse

Nombre Ruta de acceso Tipo Description
temporaryAuthorization
temporaryAuthorization string

Token de autorización temporal.

cloneUserTokenResponse

Nombre Ruta de acceso Tipo Description
activo
active boolean

Indica si el token de usuario está activo.

apps
apps array of App

La lista de aplicaciones a las que se asigna este token de usuario.

lastUsed
lastUsed string

La última fecha en que se usó este token de usuario, en el formato de hora ISO 8601 YYYY-MM-DDThh:mm:ss.sssZ (en zona horaria UTC).

descripción
description string

Descripción del token de usuario.

id
id integer

Identificador de token de usuario.

nombre
name string

Nombre del token de usuario.

token
token string

Valor del token de usuario.

Aplicación

Nombre Ruta de acceso Tipo Description
id
id string

Identificador único de esta aplicación.

nombre
name string

Nombre de la aplicación.

deleteUserTokenResponse

Nombre Ruta de acceso Tipo Description
id
id integer

Identificador del token de usuario.

deleteFileResponse

Nombre Ruta de acceso Tipo Description
versionNumber
versionNumber integer

Número de versión eliminada.

fileName
fileName string

Nombre del archivo asociado a la versión eliminada.

Subido
uploaded string

Marca de tiempo cuando se cargó originalmente la versión.

Creador
creator Creator

Usuario que cargó la versión.

Creador

Usuario que cargó la versión.

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre completo del usuario.

id
id string

ID de usuario.

Correo electrónico
email string

Correo electrónico del usuario.

nombre de usuario
userName string

Nombre de usuario tal y como se actualiza en las propiedades del usuario. Opcional, aparece si no es el mismo que el correo electrónico del usuario.

cuerda / cadena

Este es el tipo de datos básico "string".