Condividi tramite


Quickbase (server di pubblicazione indipendente)

Quickbase è una piattaforma di sviluppo di applicazioni che riunisce i team aziendali e IT consentendo ai risolutori di problemi di qualsiasi background tecnico di collaborare per creare in modo sicuro, sicuro e sostenibile un ecosistema di applicazioni. Quickbase aiuta le aziende ad accelerare l'innovazione continua di processi unici consentendo lo sviluppo dei cittadini su larga scala in un'unica piattaforma comune.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio Class Regions
Copilot Studio Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica Normale Tutte le aree di App per la logica , ad eccezione delle seguenti:
     - Aree di Azure per enti pubblici
     - Aree di Azure Cina
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps Di alta qualità Tutte le aree di Power Apps , ad eccezione dei seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Contatto
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadati del connettore
Editore Troy Taylor, Hitachi Solutions
Sito web https://www.quickbase.com/
Informativa sulla privacy https://www.quickbase.com/privacy
Categorie Produttività; operazioni IT

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita Parametri per la creazione della connessione. Tutte le aree geografiche Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome TIPO Description Obbligatorio
Nome host dell'area di autenticazione corda Specificare il nome host dell'area di autenticazione. Vero
Authorization securestring Token utente per nel formato "QB-USER-TOKEN yourToken". Vero

Limiti per la limitazione delle richieste

Nome Chiamate Periodo di rinnovo
Chiamate API per connessione 100 60 secondi

Azioni

Aggiornare un'app

Aggiorna le proprietà principali e/o le variabili dell'applicazione per un'applicazione specifica. Tutte le proprietà dell'app non specificate nel corpo della richiesta rimarranno invariate.

Aggiornare un campo

Aggiorna le proprietà e le autorizzazioni personalizzate di un campo. Il tentativo di aggiornare determinate proprietà potrebbe causare la mancata obbedienza dei dati esistenti alle nuove proprietà del campo e potrebbe essere rifiutato. Per situazioni specifiche, vedere le descrizioni delle scelte obbligatorie, univoce e seguenti. Tutte le proprietà del campo non specificate nel corpo della richiesta rimarranno invariate.

Aggiornare una relazione

Usare questo endpoint per aggiungere campi di ricerca e campi di riepilogo a una relazione esistente. L'aggiornamento di una relazione non eliminerà i campi di ricerca/riepilogo esistenti.

Aggiornare una tabella

Aggiorna le proprietà principali di una tabella specifica. Tutte le proprietà della tabella non specificate nel corpo della richiesta rimarranno invariate.

Clonare un token utente

Clona il token utente autenticato. Tutte le applicazioni associate a tale token vengono associate automaticamente al nuovo token.

Copiare un'app

Copia l'applicazione specificata. La nuova applicazione avrà lo stesso schema dell'originale. Vedere di seguito per altre opzioni di copia.

Crea una tabella

Crea una tabella in un'applicazione.

Creare un'app

Crea un'applicazione in un account. È necessario disporre dei diritti di creazione dell'applicazione nel rispettivo account. Le proprietà principali e le variabili dell'applicazione possono essere impostate con questa API.

Creare un campo

Crea un campo all'interno di una tabella, incluse le autorizzazioni personalizzate di tale campo.

Creare una relazione

Crea una relazione in una tabella e campi di ricerca/riepilogo. Le relazioni possono essere create solo per le tabelle all'interno della stessa app.

Disattivare un token utente

Disattiva il token utente autenticato. Al termine, il token utente deve essere riattivato nell'interfaccia utente.

Elimina campi

Elimina uno o più campi in una tabella, in base all'ID campo. In questo modo verranno eliminati definitivamente anche i dati o i calcoli in tale campo.

Elimina una tabella

Elimina una tabella specifica in un'applicazione, inclusi tutti i dati al suo interno.

Eliminare un'app

Elimina un'intera applicazione, incluse tutte le tabelle e i dati.

Eliminare un allegato

Elimina una versione dell'allegato di file. I metadati sui file possono essere recuperati dagli endpoint /records e /reports, se applicabile. Usare questi endpoint per ottenere le informazioni necessarie per eliminare le versioni dei file.

Eliminare un token utente

Elimina il token utente autenticato. Questo non è reversibile.

Eliminazione di record

Elimina i record in una tabella in base a una query. In alternativa, è possibile eliminare tutti i record nella tabella.

Eliminazione di una relazione

Usare questo endpoint per eliminare un'intera relazione, inclusi tutti i campi di ricerca e riepilogo. Il campo di riferimento nella relazione non verrà eliminato.

Eseguire query per i dati

Passare una query nel linguaggio di query Quickbase. Restituisce i dati dei record con paginazione intelligente in base alle dimensioni approssimative di ogni record. L'oggetto metadati includerà le informazioni necessarie per scorrere la risposta e raccogliere altri dati.

Eseguire un rapporto

Esegue un report, in base a un ID e restituisce i dati sottostanti associati. Il formato dei dati varia in base al tipo di report. I report incentrati sui dati a livello di record (tabella, calendario e così via) restituiscono i singoli record. I report aggregati (riepilogo, grafico) restituiranno le informazioni riepilogate configurate nel report. Gli elementi specifici dell'interfaccia utente non vengono restituiti, ad esempio totali, medie e visualizzazioni. Restituisce dati con paginazione intelligente in base alle dimensioni approssimative di ogni record. L'oggetto metadati includerà le informazioni necessarie per scorrere la risposta e raccogliere altri dati.

Eseguire una formula

Consente di eseguire una formula tramite una chiamata API. Utilizzare questo metodo nel codice personalizzato per ottenere il valore di una formula senza un campo discreto in un record.

Inserire record di aggiornamento del andor

Inserire e/o aggiornare i record in una tabella. In questa singola chiamata API è possibile inviare inserimenti e aggiornamenti. L'aggiornamento può usare il campo chiave nella tabella o qualsiasi altro campo univoco supportato. Per altre informazioni sulla formattazione di ogni tipo di campo, vedere la pagina Tipi di campo. Questa operazione consente l'elaborazione incrementale dei record riusciti, anche quando alcuni record hanno esito negativo.
Nota: Questo endpoint supporta una dimensione massima del payload di 10 MB.

Ottenere campi per una tabella

Ottiene le proprietà per tutti i campi di una tabella specifica. Le proprietà per ogni campo sono le stesse del campo Get.

Ottenere gli eventi dell'app

Ottenere un elenco di eventi che possono essere attivati in base ai dati o alle azioni dell'utente in questa applicazione, inclusi: notifica tramite posta elettronica, promemoria, sottoscrizioni, azioni QB, webhook, automazione attivate da record (non include pianificate).

Ottenere l'utilizzo per tutti i campi

Ottenere tutte le statistiche di utilizzo dei campi per una tabella. Si tratta di un riepilogo delle informazioni disponibili nella tabella di utilizzo delle proprietà dei campi.

Ottenere tabelle per un'app

Ottiene un elenco di tutte le tabelle presenti in un'applicazione specifica. Le proprietà per ogni tabella sono uguali a quanto restituito nella tabella Get.

Ottenere tutte le relazioni

Ottenere un elenco di tutte le relazioni e le relative definizioni per una tabella specifica. I dettagli vengono forniti sia per i lati padre che per i lati figlio delle relazioni all'interno di una determinata applicazione. Vengono restituiti dettagli limitati per le relazioni tra applicazioni.

Ottenere tutti i report di tabella

Ottenere lo schema (proprietà) di tutti i report per una tabella. Se l'utente che esegue l'API è un amministratore dell'applicazione, l'API restituirà anche tutti i report personali con l'ID utente del proprietario.

Ottenere un'app

Restituisce le proprietà principali di un'applicazione, incluse le variabili dell'applicazione.

Ottenere un report

Ottenere lo schema (proprietà) di un singolo report.

Ottenere un token temporaneo per un DBID

Usare questo endpoint per ottenere un token di autorizzazione temporaneo, con ambito un'app o una tabella. È quindi possibile usare questo token per effettuare altre chiamate API (vedere autorizzazione). Questo token scade in 5 minuti.

Ottenere un utilizzo del campo

Ottenere una singola statistica di utilizzo dei campi. Si tratta di un riepilogo delle informazioni disponibili nella tabella di utilizzo delle proprietà dei campi.

Ottenere una tabella

Ottiene le proprietà di una singola tabella che fa parte di un'applicazione.

Recupera campo

Ottiene le proprietà di un singolo campo, in base all'ID campo.
Le proprietà presenti in tutti i tipi di campo vengono restituite al livello superiore. Le proprietà univoche per un tipo specifico di campo vengono restituite sotto l'attributo 'properties'. Per altri dettagli sulle proprietà per ogni tipo di campo, vedere la pagina Tipi di campo.

Scaricare un allegato

Scarica l'allegato di file, con il contenuto dell'allegato di file codificato in formato Base64. La risposta API restituisce il nome del file nell'intestazione Content-Disposition . I metadati sui file possono essere recuperati dagli endpoint /records e /reports, se applicabile. Usare questi endpoint per ottenere le informazioni necessarie per recuperare i file.

Aggiornare un'app

Aggiorna le proprietà principali e/o le variabili dell'applicazione per un'applicazione specifica. Tutte le proprietà dell'app non specificate nel corpo della richiesta rimarranno invariate.

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name True string

Nome della variabile.

value
value True string

Valore per la variabile.

nome
name string

Nome dell'app.

descrizione
description string

Descrizione dell'app.

ID dell'app
appId True string

Identificatore univoco di un'app.

Restituisce

Aggiornare la risposta dell'app
updateAppResponse

Aggiornare un campo

Aggiorna le proprietà e le autorizzazioni personalizzate di un campo. Il tentativo di aggiornare determinate proprietà potrebbe causare la mancata obbedienza dei dati esistenti alle nuove proprietà del campo e potrebbe essere rifiutato. Per situazioni specifiche, vedere le descrizioni delle scelte obbligatorie, univoce e seguenti. Tutte le proprietà del campo non specificate nel corpo della richiesta rimarranno invariate.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco della tabella.

Controllati
audited boolean

Indica se il campo viene rilevato come parte dei log di controllo quickbase. È possibile impostare questa proprietà su "true" solo se l'app dispone di log di controllo abilitati. Vedere Abilitare i log delle modifiche dei dati in Log di controllo quickbase.

fieldHelp
fieldHelp string

Testo della Guida configurato visualizzato agli utenti all'interno del prodotto.

grassetto
bold boolean

Indica se il campo è configurato per la visualizzazione in grassetto nel prodotto.

required
required boolean

Indica se il campo è obbligatorio, ad esempio se ogni record deve avere un valore non Null in questo campo. Se si tenta di modificare un campo da non obbligatorio a obbligatorio e la tabella contiene attualmente record con valori Null in tale campo, verrà visualizzato un errore che indica che sono presenti valori Null del campo. In questo caso è necessario trovare e aggiornare i record con valori Null del campo prima di modificare il campo in modo che sia necessario.

comments
comments string

Commenti immessi nelle proprietà del campo da un amministratore.

doesTotal
doesTotal boolean

Indica se questo campo viene totale nei report all'interno del prodotto.

Salvataggio automatico
autoSave boolean

Indica se il campo del collegamento verrà salvato automaticamente.

defaultValueLuid
defaultValueLuid integer

Valore id utente predefinito.

maxVersions
maxVersions integer

Numero massimo di versioni configurate per un allegato di file.

format
format integer

Formato da visualizzare.

carryChoices
carryChoices boolean

Indica se il campo deve contenere i campi a scelta multipla durante la copia.

lunghezza massima
maxLength integer

Numero massimo di caratteri consentiti per la voce in Quickbase per questo campo.

linkText
linkText string

Valore di testo configurato che sostituisce l'URL visualizzato dagli utenti all'interno del prodotto.

parentFieldId
parentFieldId integer

ID del campo composito padre, se applicabile.

displayTimezone
displayTimezone boolean

Indica se visualizzare il fuso orario all'interno del prodotto.

summaryTargetFieldId
summaryTargetFieldId integer

ID del campo utilizzato per aggregare i valori dell'elemento figlio, se applicabile. Viene visualizzato 0 se la funzione di riepilogo non richiede una selezione di campi (ad esempio count).

allowNewChoices
allowNewChoices boolean

Indica se gli utenti possono aggiungere nuove opzioni a un elenco di selezione.

defaultToday
defaultToday boolean

Indica se il valore del campo è attualmente predefinito per i nuovi record.

Unità
units string

Etichetta unità.

lookupTargetFieldId
lookupTargetFieldId integer

ID del campo che rappresenta la destinazione nella tabella padre per questa ricerca.

SummaryFunction3
summaryFunction string

Tipo di accumulo per il campo di riepilogo.

sourceFieldId
sourceFieldId integer

ID del campo di origine.

doesAverage
doesAverage boolean

Indica se questo campo viene mediato nei report all'interno del prodotto.

formula
formula string

Formula del campo come configurato in Quickbase.

decimalPlaces
decimalPlaces integer

Numero di posizioni decimali visualizzate nel prodotto per questo campo.

displayMonth
displayMonth string

Come visualizzare i mesi.

seeVersions
seeVersions boolean

Indica se l'utente può visualizzare altre versioni, a parte la più recente, di un allegato di file all'interno del prodotto.

numLines
numLines integer

Numero di righe visualizzate in Quickbase per questo campo di testo.

defaultKind
defaultKind string

Tipo predefinito dell'utente.

displayEmail
displayEmail string

Modalità di visualizzazione del messaggio di posta elettronica.

coverText
coverText string

Testo descrittivo alternativo che può essere usato per visualizzare un collegamento nel browser.

currencySymbol
currencySymbol string

Simbolo corrente utilizzato durante la visualizzazione dei valori di campo all'interno del prodotto.

summaryQuery
summaryQuery string

Query di riepilogo.

targetFieldId
targetFieldId integer

ID del campo di destinazione.

displayUser
displayUser string

Opzione configurata per la modalità di visualizzazione degli utenti all'interno del prodotto.

blankIsZero
blankIsZero boolean

Indica se un valore vuoto viene considerato uguale a 0 nei calcoli all'interno del prodotto.

esatto
exact boolean

Indica se è necessaria una corrispondenza esatta per un collegamento al report.

defaultDomain
defaultDomain string

Dominio di posta elettronica predefinito.

defaultValue
defaultValue string

Valore predefinito configurato per un campo quando viene aggiunto un nuovo record.

abbreviare
abbreviate boolean

Non visualizzare il protocollo URL quando viene visualizzato l'URL.

formatoNumero
numberFormat integer

Formato utilizzato per la visualizzazione di valori numerici nel prodotto (decimale, separatori, gruppo di cifre).

targetTableName
targetTableName string

Nome della tabella di destinazione del campo.

appearsAs
appearsAs string

Il testo del collegamento, se vuoto, verrà usato come testo del collegamento.

Larghezza
width integer

Larghezza di input html del campo nel prodotto.

CurrencyFormat
currencyFormat string

Formato di valuta utilizzato per la visualizzazione dei valori di campo all'interno del prodotto.

displayImages
displayImages boolean

Indica se le immagini verranno visualizzate per gli allegati di file nei moduli e nei report all'interno del prodotto.

displayDayOfWeek
displayDayOfWeek boolean

Indica se visualizzare il giorno della settimana all'interno del prodotto.

summaryReferenceFieldId
summaryReferenceFieldId integer

ID del campo che rappresenta il riferimento nella relazione per questo riepilogo.

Avvio virgola
commaStart integer

Numero di cifre prima della visualizzazione delle virgole nel prodotto, se applicabile.

choices
choices array of string

Matrice di voci esistenti per un campo che offre opzioni all'utente. Si noti che queste scelte fanno riferimento ai valori validi di tutti i record aggiunti in futuro. È possibile rimuovere i valori dall'elenco di scelte anche se sono presenti record esistenti con tali valori in questo campo. Verranno visualizzati in rosso quando gli utenti esaminano i dati nel browser, ma non c'è altro effetto. Durante l'aggiornamento di un campo con questa proprietà, le scelte precedenti vengono rimosse e sostituite dalle nuove scelte.

targetTableId
targetTableId string

ID della tabella di destinazione.

displayRelative
displayRelative boolean

Indica se visualizzare l'ora come relativa.

compositeFields
compositeFields object
summaryTableId
summaryTableId string

Tabella da cui fa riferimento il campo di riepilogo.

displayTime
displayTime boolean

Indica se visualizzare l'ora, oltre alla data.

VersionMode
versionMode string

Modalità di versione per i file. Mantenere tutte le versioni e mantenere l'ultima versione.

snapFieldId
snapFieldId integer

ID del campo utilizzato per creare uno snapshot dei valori, se applicabile.

ore24
hours24 boolean

Indica se visualizzare o meno l'ora nel formato di 24 ore all'interno del prodotto.

sortAlpha
sortAlpha boolean

Se ordinare alfabeticamente, l'ordinamento predefinito è in base all'ID record.

sortAsGiven
sortAsGiven boolean

Indica se le voci elencate vengono ordinate come immesse in ordine alfabetico.

hasExtension
hasExtension boolean

Indica se il campo dispone di un'estensione telefono.

useNewWindow
useNewWindow boolean

Indica se l'URL deve aprire una nuova finestra quando un utente lo fa clic all'interno del prodotto.

appendOnly
appendOnly boolean

Indica se questo campo è solo accodato.

displayAsLink
displayAsLink boolean

Indica se un campo che fa parte della relazione deve essere visualizzato come collegamento ipertestuale al record padre all'interno del prodotto.

lookupReferenceFieldId
lookupReferenceFieldId integer

ID del campo che rappresenta il riferimento nella relazione per questa ricerca.

appearsByDefault
appearsByDefault boolean

Indica se il campo è contrassegnato come predefinito nei report.

unico
unique boolean

Indica se ogni record nella tabella deve contenere un valore univoco di questo campo. Se si tenta di modificare un campo da non univoco a univoco e la tabella contiene attualmente record con lo stesso valore di questo campo, verrà visualizzato un errore. In questo caso è necessario trovare e aggiornare i record con valori duplicati del campo prima di modificare il campo in univoco.

ruolo
role string

Ruolo associato a una determinata autorizzazione per il campo

permissionType
permissionType string

Autorizzazione assegnata al ruolo per questo campo

roleId
roleId integer

ID del ruolo specificato

addToForms
addToForms boolean

Indica se il campo che si aggiunge deve essere visualizzato nei moduli.

label
label string

Etichetta (nome) del campo.

findEnabled
findEnabled boolean

Indica se il campo è contrassegnato come ricercabile.

noWrap
noWrap boolean

Indica se il campo è configurato per non eseguire il wrapping quando viene visualizzato nel prodotto.

ID campo
fieldId True integer

Identificatore univoco (FID) del campo.

Restituisce

Aggiorna risposta campo
updateFieldResponse

Aggiornare una relazione

Usare questo endpoint per aggiungere campi di ricerca e campi di riepilogo a una relazione esistente. L'aggiornamento di una relazione non eliminerà i campi di ricerca/riepilogo esistenti.

Parametri

Nome Chiave Necessario Tipo Descrizione
summaryFid
summaryFid double

ID campo da riepilogare.

label
label string

Etichetta per il campo di riepilogo.

AccumulationType
accumulationType True string

Tipo di accumulo per il campo di riepilogo.

where
where string

Filtro, che usa il linguaggio di query Quickbase, che determina i record da restituire.

lookupFieldIds
lookupFieldIds array of integer

Matrice di ID campo nella tabella padre che diventerà campi di ricerca nella tabella figlio.

ID tabella
tableId True string

Identificatore univoco (DBID) della tabella. Si tratta della tabella figlio.

ID relazione
relationshipId True double

ID relazione. ID campo del campo di riferimento nella tabella figlio.

Restituisce

Aggiornare la risposta alla relazione
updateRelationshipResponse

Aggiornare una tabella

Aggiorna le proprietà principali di una tabella specifica. Tutte le proprietà della tabella non specificate nel corpo della richiesta rimarranno invariate.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'app
appId True string

Identificatore univoco di un'app

nome
name string

Nome della tabella.

pluralRecordName
pluralRecordName string

Sostantivo plurale per i record nella tabella. Se questo valore non viene passato, il valore predefinito è 'Records'.

singleRecordName
singleRecordName string

Sostantivo singolare per i record nella tabella. Se questo valore non viene passato, il valore predefinito è 'Record'.

descrizione
description string

Descrizione della tabella. Se questo valore non viene passato, il valore predefinito è vuoto.

ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

Restituisce

Aggiornare la risposta alla tabella
updateTableResponse

Clonare un token utente

Clona il token utente autenticato. Tutte le applicazioni associate a tale token vengono associate automaticamente al nuovo token.

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name string

Nuovo nome per il token utente clonato.

descrizione
description string

Descrizione del token utente clonato.

Restituisce

Clonare la risposta del token utente
cloneUserTokenResponse

Copiare un'app

Copia l'applicazione specificata. La nuova applicazione avrà lo stesso schema dell'originale. Vedere di seguito per altre opzioni di copia.

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name True string

Nome dell'app appena copiata

descrizione
description string

Descrizione dell'app appena copiata

assignUserToken
assignUserToken boolean

Indica se aggiungere il token utente usato per effettuare questa richiesta alla nuova app

excludeFiles
excludeFiles boolean

Se keepData è true, se copiare anche gli allegati di file. Se keepData è false, questa proprietà viene ignorata

keepData
keepData boolean

Se copiare i dati dell'app insieme allo schema

usersAndRoles
usersAndRoles boolean

Se true, gli utenti verranno copiati insieme ai ruoli assegnati. Se false, gli utenti e i ruoli verranno copiati, ma i ruoli non verranno assegnati

ID dell'app
appId True string

Identificatore univoco di un'app.

Restituisce

Copiare la risposta dell'app
copyAppResponse

Crea una tabella

Crea una tabella in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'app
appId True string

Identificatore univoco di un'app

nome
name True string

Nome della tabella.

pluralRecordName
pluralRecordName string

Sostantivo plurale per i record nella tabella. Se questo valore non viene passato, il valore predefinito è 'Records'.

singleRecordName
singleRecordName string

Sostantivo singolare per i record nella tabella. Se questo valore non viene passato, il valore predefinito è 'Record'.

descrizione
description string

Descrizione della tabella. Se questo valore non viene passato, il valore predefinito è vuoto.

Restituisce

Creare una risposta di tabella
createTableResponse

Creare un'app

Crea un'applicazione in un account. È necessario disporre dei diritti di creazione dell'applicazione nel rispettivo account. Le proprietà principali e le variabili dell'applicazione possono essere impostate con questa API.

Parametri

Nome Chiave Necessario Tipo Descrizione
assignToken
assignToken boolean

Impostare su true se si vuole assegnare l'app al token utente usato per creare l'applicazione. Il valore predefinito è false.

nome
name True string

Nome della variabile.

value
value True string

Valore per la variabile.

nome
name True string

Nome dell'app. È possibile creare più app con lo stesso nome, nella stessa area di autenticazione, perché avranno valori dbid diversi. Vi invitiamo ad essere attenti a farlo.

descrizione
description string

Descrizione dell'app. Se questa proprietà viene interrotta, la descrizione dell'app sarà vuota.

Restituisce

Creare una risposta all'app
createAppResponse

Creare un campo

Crea un campo all'interno di una tabella, incluse le autorizzazioni personalizzate di tale campo.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco della tabella.

Controllati
audited boolean

Indica se il campo viene rilevato come parte dei log di controllo quickbase. È possibile impostare questa proprietà su "true" solo se l'app dispone di log di controllo abilitati. Vedere Abilitare i log delle modifiche dei dati in Log di controllo quickbase.

fieldHelp
fieldHelp string

Testo della Guida configurato visualizzato agli utenti all'interno del prodotto.

grassetto
bold boolean

Indica se il campo è configurato per la visualizzazione in grassetto nel prodotto.

comments
comments string

Commenti immessi nelle proprietà del campo da un amministratore.

doesTotal
doesTotal boolean

Indica se questo campo viene totale nei report all'interno del prodotto.

Salvataggio automatico
autoSave boolean

Indica se il campo del collegamento verrà salvato automaticamente.

defaultValueLuid
defaultValueLuid integer

Valore id utente predefinito.

maxVersions
maxVersions integer

Numero massimo di versioni configurate per un allegato di file.

format
format integer

Formato da visualizzare.

carryChoices
carryChoices boolean

Indica se il campo deve contenere i campi a scelta multipla durante la copia.

lunghezza massima
maxLength integer

Numero massimo di caratteri consentiti per la voce in Quickbase per questo campo.

linkText
linkText string

Valore di testo configurato che sostituisce l'URL visualizzato dagli utenti all'interno del prodotto.

parentFieldId
parentFieldId integer

ID del campo composito padre, se applicabile.

displayTimezone
displayTimezone boolean

Indica se visualizzare il fuso orario all'interno del prodotto.

allowNewChoices
allowNewChoices boolean

Indica se gli utenti possono aggiungere nuove opzioni a un elenco di selezione.

defaultToday
defaultToday boolean

Indica se il valore del campo è attualmente predefinito per i nuovi record.

Unità
units string

Etichetta unità.

sourceFieldId
sourceFieldId integer

ID del campo di origine.

doesAverage
doesAverage boolean

Indica se questo campo viene mediato nei report all'interno del prodotto.

formula
formula string

Formula del campo come configurato in Quickbase.

decimalPlaces
decimalPlaces integer

Numero di posizioni decimali visualizzate nel prodotto per questo campo.

displayMonth
displayMonth string

Come visualizzare i mesi.

seeVersions
seeVersions boolean

Indica se l'utente può visualizzare altre versioni, a parte la più recente, di un allegato di file all'interno del prodotto.

numLines
numLines integer

Numero di righe visualizzate in Quickbase per questo campo di testo.

defaultKind
defaultKind string

Tipo predefinito dell'utente.

displayEmail
displayEmail string

Modalità di visualizzazione del messaggio di posta elettronica.

coverText
coverText string

Testo descrittivo alternativo che può essere usato per visualizzare un collegamento nel browser.

currencySymbol
currencySymbol string

Simbolo corrente utilizzato durante la visualizzazione dei valori di campo all'interno del prodotto.

targetFieldId
targetFieldId integer

ID del campo di destinazione.

displayUser
displayUser string

Opzione configurata per la modalità di visualizzazione degli utenti all'interno del prodotto.

blankIsZero
blankIsZero boolean

Indica se un valore vuoto viene considerato uguale a 0 nei calcoli all'interno del prodotto.

esatto
exact boolean

Indica se è necessaria una corrispondenza esatta per un collegamento al report.

defaultDomain
defaultDomain string

Dominio di posta elettronica predefinito.

defaultValue
defaultValue string

Valore predefinito configurato per un campo quando viene aggiunto un nuovo record.

abbreviare
abbreviate boolean

Non visualizzare il protocollo URL quando viene visualizzato l'URL.

formatoNumero
numberFormat integer

Formato utilizzato per la visualizzazione di valori numerici nel prodotto (decimale, separatori, gruppo di cifre).

targetTableName
targetTableName string

Nome della tabella di destinazione del campo.

appearsAs
appearsAs string

Il testo del collegamento, se vuoto, verrà usato come testo del collegamento.

Larghezza
width integer

Larghezza di input html del campo nel prodotto.

CurrencyFormat
currencyFormat string

Formato di valuta utilizzato per la visualizzazione dei valori di campo all'interno del prodotto.

displayImages
displayImages boolean

Indica se le immagini verranno visualizzate per gli allegati di file nei moduli e nei report all'interno del prodotto.

displayDayOfWeek
displayDayOfWeek boolean

Indica se visualizzare il giorno della settimana all'interno del prodotto.

Avvio virgola
commaStart integer

Numero di cifre prima della visualizzazione delle virgole nel prodotto, se applicabile.

choices
choices array of string

Matrice di voci esistenti per un campo che offre opzioni all'utente. Si noti che queste scelte fanno riferimento ai valori validi di tutti i record aggiunti in futuro. È possibile rimuovere i valori dall'elenco di scelte anche se sono presenti record esistenti con tali valori in questo campo. Verranno visualizzati in rosso quando gli utenti esaminano i dati nel browser, ma non c'è altro effetto. Durante l'aggiornamento di un campo con questa proprietà, le scelte precedenti vengono rimosse e sostituite dalle nuove scelte.

targetTableId
targetTableId string

ID della tabella di destinazione.

displayRelative
displayRelative boolean

Indica se visualizzare l'ora come relativa.

compositeFields
compositeFields object
displayTime
displayTime boolean

Indica se visualizzare l'ora, oltre alla data.

VersionMode
versionMode string

Modalità di versione per i file. Mantenere tutte le versioni e mantenere l'ultima versione.

snapFieldId
snapFieldId integer

ID del campo utilizzato per creare uno snapshot dei valori, se applicabile.

ore24
hours24 boolean

Indica se visualizzare o meno l'ora nel formato di 24 ore all'interno del prodotto.

sortAlpha
sortAlpha boolean

Se ordinare alfabeticamente, l'ordinamento predefinito è in base all'ID record.

sortAsGiven
sortAsGiven boolean

Indica se le voci elencate vengono ordinate come immesse in ordine alfabetico.

hasExtension
hasExtension boolean

Indica se il campo dispone di un'estensione telefono.

useNewWindow
useNewWindow boolean

Indica se l'URL deve aprire una nuova finestra quando un utente lo fa clic all'interno del prodotto.

appendOnly
appendOnly boolean

Indica se questo campo è solo accodato.

displayAsLink
displayAsLink boolean

Indica se un campo che fa parte della relazione deve essere visualizzato come collegamento ipertestuale al record padre all'interno del prodotto.

appearsByDefault
appearsByDefault boolean

Indica se il campo è contrassegnato come predefinito nei report.

FieldType2
fieldType True string

I tipi di campo, fare clic su uno dei collegamenti del tipo di campo per altre informazioni.

ruolo
role string

Ruolo associato a una determinata autorizzazione per il campo

permissionType
permissionType string

Autorizzazione assegnata al ruolo per questo campo

roleId
roleId integer

ID del ruolo specificato

addToForms
addToForms boolean

Indica se il campo che si aggiunge deve essere visualizzato nei moduli.

label
label True string

Etichetta (nome) del campo.

findEnabled
findEnabled boolean

Indica se il campo è contrassegnato come ricercabile.

noWrap
noWrap boolean

Indica se il campo è configurato per non eseguire il wrapping quando viene visualizzato nel prodotto.

Restituisce

Crea risposta campo
createFieldResponse

Creare una relazione

Crea una relazione in una tabella e campi di ricerca/riepilogo. Le relazioni possono essere create solo per le tabelle all'interno della stessa app.

Parametri

Nome Chiave Necessario Tipo Descrizione
summaryFid
summaryFid double

ID campo da riepilogare.

label
label string

Etichetta per il campo di riepilogo.

AccumulationType
accumulationType True string

Tipo di accumulo per il campo di riepilogo.

where
where string

Filtro, che usa il linguaggio di query Quickbase, che determina i record da restituire.

lookupFieldIds
lookupFieldIds array of integer

Matrice di ID campo nella tabella padre che diventerà campi di ricerca nella tabella figlio.

parentTableId
parentTableId True string

ID tabella padre per la relazione.

label
label string

Etichetta per il campo chiave esterna.

ID tabella
tableId True string

Identificatore univoco (DBID) della tabella. Si tratta della tabella figlio.

Restituisce

Creare una risposta alle relazioni
createRelationshipResponse

Disattivare un token utente

Disattiva il token utente autenticato. Al termine, il token utente deve essere riattivato nell'interfaccia utente.

Restituisce

Nome Percorso Tipo Descrizione
id
id integer

id

Elimina campi

Elimina uno o più campi in una tabella, in base all'ID campo. In questo modo verranno eliminati definitivamente anche i dati o i calcoli in tale campo.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco della tabella.

fieldIds
fieldIds True array of integer

Elenco di ID campo da eliminare.

Restituisce

Elimina risposta campi
deleteFieldsResponse

Elimina una tabella

Elimina una tabella specifica in un'applicazione, inclusi tutti i dati al suo interno.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'app
appId True string

Identificatore univoco di un'app

ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

Restituisce

Elimina risposta tabella
deleteTableResponse

Eliminare un'app

Elimina un'intera applicazione, incluse tutte le tabelle e i dati.

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name True string

Per confermare l'eliminazione dell'applicazione, viene richiesto il nome dell'applicazione.

ID dell'app
appId True string

Identificatore univoco di un'app.

Restituisce

Eliminare la risposta dell'app
deleteAppResponse

Eliminare un allegato

Elimina una versione dell'allegato di file. I metadati sui file possono essere recuperati dagli endpoint /records e /reports, se applicabile. Usare questi endpoint per ottenere le informazioni necessarie per eliminare le versioni dei file.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco della tabella.

ID record
recordId True integer

Identificatore univoco del record.

ID campo
fieldId True integer

Identificatore univoco del campo.

Numero di versione
versionNumber True integer

Numero di versione dell'allegato di file.

Restituisce

Elimina risposta file
deleteFileResponse

Eliminare un token utente

Elimina il token utente autenticato. Questo non è reversibile.

Restituisce

Eliminare la risposta del token utente
deleteUserTokenResponse

Eliminazione di record

Elimina i record in una tabella in base a una query. In alternativa, è possibile eliminare tutti i record nella tabella.

Parametri

Nome Chiave Necessario Tipo Descrizione
da
from True string

Identificatore univoco della tabella.

where
where True string

Filtro per eliminare i record. Per eliminare tutti i record, specificare un filtro che includerà tutti i record, ad esempio {3.GT.0} dove 3 è l'ID del campo ID record.

Restituisce

Elimina risposta record
deleteRecordsResponse

Eliminazione di una relazione

Usare questo endpoint per eliminare un'intera relazione, inclusi tutti i campi di ricerca e riepilogo. Il campo di riferimento nella relazione non verrà eliminato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco (DBID) della tabella. Si tratta della tabella figlio.

ID relazione
relationshipId True double

ID relazione. ID campo del campo di riferimento nella tabella figlio.

Restituisce

Elimina risposta relazione
deleteRelationshipResponse

Eseguire query per i dati

Passare una query nel linguaggio di query Quickbase. Restituisce i dati dei record con paginazione intelligente in base alle dimensioni approssimative di ogni record. L'oggetto metadati includerà le informazioni necessarie per scorrere la risposta e raccogliere altri dati.

Parametri

Nome Chiave Necessario Tipo Descrizione
skip
skip integer

Numero di record da ignorare.

compareWithAppLocalTime
compareWithAppLocalTime boolean

Indica se eseguire la query su un campo di data e ora rispetto all'ora locale dell'applicazione. La query viene eseguita con l'ora UTC per impostazione predefinita.

top
top integer

Numero massimo di record da visualizzare.

where
where string

Filtro, che usa il linguaggio di query Quickbase, che determina i record da restituire. Se questo parametro viene omesso, la query restituirà tutti i record.

fieldId
fieldId integer

Identificatore univoco di un campo in una tabella.

Grouping
grouping string

Raggruppare in base all'ordine crescente (ASC), all'ordine decrescente (DESC) o ai valori uguali (valori uguali)

sortBy
sortBy object

Per impostazione predefinita, le query verranno ordinate in base ai campi di ordinamento specificati o all'ordinamento predefinito se la query non fornisce alcuna. Impostare su false per evitare l'ordinamento quando l'ordine dei dati restituiti non è importante. La restituzione di dati senza ordinamento può migliorare le prestazioni.

select
select object
da
from True string

Identificatore di tabella.

Restituisce

Eseguire la risposta di query
runQueryResponse

Eseguire un rapporto

Esegue un report, in base a un ID e restituisce i dati sottostanti associati. Il formato dei dati varia in base al tipo di report. I report incentrati sui dati a livello di record (tabella, calendario e così via) restituiscono i singoli record. I report aggregati (riepilogo, grafico) restituiranno le informazioni riepilogate configurate nel report. Gli elementi specifici dell'interfaccia utente non vengono restituiti, ad esempio totali, medie e visualizzazioni. Restituisce dati con paginazione intelligente in base alle dimensioni approssimative di ogni record. L'oggetto metadati includerà le informazioni necessarie per scorrere la risposta e raccogliere altri dati.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore della tabella per il report.

Salta
skip integer

Numero di record da ignorare. È possibile impostare questo valore durante la paginazione tramite un set di risultati.

In alto
top integer

Numero massimo di record da restituire. È possibile eseguire l'override della paginazione predefinita quickbase per ottenere più o meno risultati. Se il valore richiesto qui supera i valori massimi dinamici, verrà restituito un subset di risultati e il resto può essere raccolto nelle chiamate API successive.

object
ID del report
reportId True string

Identificatore del report, univoco per la tabella.

Restituisce

Esegui risposta report
runReportResponse

Eseguire una formula

Consente di eseguire una formula tramite una chiamata API. Utilizzare questo metodo nel codice personalizzato per ottenere il valore di una formula senza un campo discreto in un record.

Parametri

Nome Chiave Necessario Tipo Descrizione
formula
formula True string

Formula da eseguire. Deve essere una formula quickbase valida.

liberarsi
rid integer

ID record su cui eseguire la formula. Necessario solo per le formule eseguite nel contesto di un record. Ad esempio, la formula User() non richiede un ID record.

da
from True string

Identificatore univoco (dbid) della tabella.

Restituisce

Esegui risposta formula
runFormulaResponse

Inserire record di aggiornamento del andor

Inserire e/o aggiornare i record in una tabella. In questa singola chiamata API è possibile inviare inserimenti e aggiornamenti. L'aggiornamento può usare il campo chiave nella tabella o qualsiasi altro campo univoco supportato. Per altre informazioni sulla formattazione di ogni tipo di campo, vedere la pagina Tipi di campo. Questa operazione consente l'elaborazione incrementale dei record riusciti, anche quando alcuni record hanno esito negativo.
Nota: Questo endpoint supporta una dimensione massima del payload di 10 MB.

Parametri

Nome Chiave Necessario Tipo Descrizione
a
to True string

Identificatore di tabella.

data
data object
mergeFieldId
mergeFieldId integer

ID campo unione.

fieldsToReturn
fieldsToReturn array of integer

Specificare una matrice di ID campo che restituirà i dati per tutti gli aggiornamenti o i record aggiunti. L'ID record (FID 3) viene sempre restituito se viene richiesto un ID campo.

Restituisce

Risposta con esito positivo che include dettagli sui record aggiunti, aggiornati o invariati. Nell'esempio seguente la tabella in precedenza aveva dieci record con ID da 1 a 10. L'utente pubblica un upsert che aggiorna il valore del record 1 e aggiunge due nuovi record, tutti correttamente.

Risposta Upsert
upsertResponse

Ottenere campi per una tabella

Ottiene le proprietà per tutti i campi di una tabella specifica. Le proprietà per ogni campo sono le stesse del campo Get.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

Includi autorizzazioni campo
includeFieldPerms boolean

Impostare su "true" se si desidera ottenere le autorizzazioni personalizzate per i campi.

Restituisce

Nome Percorso Tipo Descrizione
array of object
Documento d'identità
id integer

Identificatore.

Etichetta
label string

Etichetta.

Tipo di campo
fieldType string

Tipo di campo.

Nessun ritorno a capo
noWrap boolean

Indica se non è presente alcun wrapping.

Bold
bold boolean

Se grassetto.

Obbligatorio
required boolean

Indica se necessario.

Viene visualizzato per impostazione predefinita
appearsByDefault boolean

Indica se viene visualizzato per impostazione predefinita.

Trova abilitato
findEnabled boolean

Indica se la ricerca è abilitata.

Unico
unique boolean

Se univoco.

Esegue la copia dei dati
doesDataCopy boolean

Indica se i dati vengono copiati.

Guida del campo
fieldHelp string

Guida del campo.

Controllati
audited boolean

Indica se è stato controllato.

Chiave primaria
properties.primaryKey boolean

Indica se la chiave primaria.

Chiave esterna
properties.foreignKey boolean

Indica se la chiave esterna.

Righe num
properties.numLines integer

Numero di righe.

Lunghezza massima
properties.maxLength integer

Lunghezza massima.

Solo accodamento
properties.appendOnly boolean

Solo se accodamento.

allowHTML
properties.allowHTML boolean

Indica se consentire il codice HTML.

Ordina come specificato
properties.sortAsGiven boolean

Indica se ordinare come specificato.

Opzioni di trasporto
properties.carryChoices boolean

Se trasportare le scelte.

Consenti nuove scelte
properties.allowNewChoices boolean

Indica se consentire nuove scelte.

Formula
properties.formula string

Formula.

Valore predefinito
properties.defaultValue string

Valore predefinito.

Formato numeri
properties.numberFormat integer

Formato numerico.

Decimali
properties.decimalPlaces integer

Posizioni decimali.

Media
properties.doesAverage boolean

Indica se la media è media.

Totale operazioni
properties.doesTotal boolean

Indica se il totale è totale.

Vuoto: zero
properties.blankIsZero boolean

Indica se vuoto è zero.

Permissions
permissions array of object
Tipo di autorizzazione
permissions.permissionType string

Tipo di autorizzazione.

Ruolo
permissions.role string

Ruolo.

ID ruolo
permissions.roleId integer

Identificatore del ruolo.

Aggiungi a moduli
addToForms boolean

Indica se aggiungere ai moduli.

Ottenere gli eventi dell'app

Ottenere un elenco di eventi che possono essere attivati in base ai dati o alle azioni dell'utente in questa applicazione, inclusi: notifica tramite posta elettronica, promemoria, sottoscrizioni, azioni QB, webhook, automazione attivate da record (non include pianificate).

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'app
appId True string

Identificatore univoco di un'app.

Restituisce

Nome Percorso Tipo Descrizione
array of object
TIPO
type string

Tipo.

Email
owner.email string

Indirizzo di posta elettronica del proprietario.

Documento d'identità
owner.id string

Identificatore del proprietario.

Nome
owner.name string

Nome del proprietario.

Nome utente
owner.userName string

Nome utente del proprietario.

È attivo
isActive boolean

Indica se è attivo.

ID tabella
tableId string

Identificatore della tabella.

Nome
name string

Nome.

URL
url string

Indirizzo URL.

Ottenere l'utilizzo per tutti i campi

Ottenere tutte le statistiche di utilizzo dei campi per una tabella. Si tratta di un riepilogo delle informazioni disponibili nella tabella di utilizzo delle proprietà dei campi.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

Salta
skip integer

Numero di campi da ignorare dall'elenco.

In alto
top integer

Numero massimo di campi da restituire.

Restituisce

Nome Percorso Tipo Descrizione
array of object
Documento d'identità
field.id integer

Identificatore.

Nome
field.name string

Nome.

TIPO
field.type string

Tipo.

Conteggio
usage.actions.count integer

Conteggio.

Conteggio
usage.appHomePages.count integer

Conteggio.

Conteggio
usage.defaultReports.count integer

Conteggio.

Conteggio
usage.exactForms.count integer

Conteggio.

Conteggio
usage.fields.count integer

Conteggio.

Conteggio
usage.forms.count integer

Conteggio.

Conteggio
usage.notifications.count integer

Conteggio.

Conteggio
usage.personalReports.count integer

Conteggio.

Conteggio
usage.relationships.count integer

Conteggio.

Conteggio
usage.reminders.count integer

Conteggio.

Conteggio
usage.reports.count integer

Conteggio.

Conteggio
usage.roles.count integer

Conteggio.

Conteggio
usage.webhooks.count integer

Conteggio.

Ottenere tabelle per un'app

Ottiene un elenco di tutte le tabelle presenti in un'applicazione specifica. Le proprietà per ogni tabella sono uguali a quanto restituito nella tabella Get.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'app
appId True string

Identificatore univoco di un'app

Restituisce

Nome Percorso Tipo Descrizione
array of object
Nome
name string

Nome.

Created
created string

Al momento della creazione.

Updated
updated string

Quando viene aggiornato.

Alias
alias string

Alias.

Description
description string

Descrizione.

Documento d'identità
id string

Identificatore.

ID record successivo
nextRecordId integer

Identificatore del record successivo.

ID campo successivo
nextFieldId integer

Identificatore del campo successivo.

ID campo ordinamento predefinito
defaultSortFieldId integer

Identificatore del campo di ordinamento predefinito.

Ordinamento predefinito
defaultSortOrder string

Ordinamento predefinito.

ID campo chiave
keyFieldId integer

Identificatore del campo della chiave.

Nome singolo record
singleRecordName string

Nome singolo del record.

Nome record plurale
pluralRecordName string

Nome del record plurale.

Limite dimensioni
sizeLimit string

Limite di dimensioni.

Spazio usato
spaceUsed string

Spazio utilizzato.

Spazio rimanente
spaceRemaining string

Spazio rimanente.

Ottenere tutte le relazioni

Ottenere un elenco di tutte le relazioni e le relative definizioni per una tabella specifica. I dettagli vengono forniti sia per i lati padre che per i lati figlio delle relazioni all'interno di una determinata applicazione. Vengono restituiti dettagli limitati per le relazioni tra applicazioni.

Parametri

Nome Chiave Necessario Tipo Descrizione
Salta
skip integer

Numero di relazioni da ignorare.

ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

Restituisce

Ottenere la risposta alle relazioni
getRelationshipsResponse

Ottenere tutti i report di tabella

Ottenere lo schema (proprietà) di tutti i report per una tabella. Se l'utente che esegue l'API è un amministratore dell'applicazione, l'API restituirà anche tutti i report personali con l'ID utente del proprietario.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco della tabella.

Restituisce

Nome Percorso Tipo Descrizione
array of object
Documento d'identità
id string

Identificatore.

Nome
name string

Nome.

TIPO
type string

Tipo.

Description
description string

Descrizione.

ID proprietario
ownerId string

Identificatore del proprietario.

Ultima operazione usata
usedLast string

Se usato per ultimo.

Conteggio usato
usedCount integer

Conteggio utilizzato.

Ottenere un'app

Restituisce le proprietà principali di un'applicazione, incluse le variabili dell'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'app
appId True string

Identificatore univoco di un'app.

Restituisce

Ottenere la risposta dell'app
getAppResponse

Ottenere un report

Ottenere lo schema (proprietà) di un singolo report.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco della tabella.

ID del report
reportId True string

Identificatore del report, univoco per la tabella.

Restituisce

Ottenere una risposta al report
getReportResponse

Ottenere un token temporaneo per un DBID

Usare questo endpoint per ottenere un token di autorizzazione temporaneo, con ambito un'app o una tabella. È quindi possibile usare questo token per effettuare altre chiamate API (vedere autorizzazione). Questo token scade in 5 minuti.

Parametri

Nome Chiave Necessario Tipo Descrizione
Token dell'app
QB-App-Token string

Token dell'app Quickbase

DBID
dbid True string

Identificatore univoco di un'app o di una tabella.

Restituisce

getTempTokenDBIDResponse
getTempTokenDBIDResponse

Ottenere un utilizzo del campo

Ottenere una singola statistica di utilizzo dei campi. Si tratta di un riepilogo delle informazioni disponibili nella tabella di utilizzo delle proprietà dei campi.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

ID campo
fieldId True integer

Identificatore univoco (FID) del campo.

Restituisce

Nome Percorso Tipo Descrizione
array of object
Documento d'identità
field.id integer

Identificatore.

Nome
field.name string

Nome.

TIPO
field.type string

Tipo.

Conteggio
usage.actions.count integer

Conteggio.

Conteggio
usage.appHomePages.count integer

Conteggio.

Conteggio
usage.defaultReports.count integer

Conteggio.

Conteggio
usage.exactForms.count integer

Conteggio.

Conteggio
usage.fields.count integer

Conteggio.

Conteggio
usage.forms.count integer

Conteggio.

Conteggio
usage.notifications.count integer

Conteggio.

Conteggio
usage.personalReports.count integer

Conteggio.

Conteggio
usage.relationships.count integer

Conteggio.

Conteggio
usage.reminders.count integer

Conteggio.

Conteggio
usage.reports.count integer

Conteggio.

Conteggio
usage.roles.count integer

Conteggio.

Conteggio
usage.webhooks.count integer

Conteggio.

Ottenere una tabella

Ottiene le proprietà di una singola tabella che fa parte di un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'app
appId True string

Identificatore univoco di un'app

ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

Restituisce

Ottenere la risposta alla tabella
getTableResponse

Recupera campo

Ottiene le proprietà di un singolo campo, in base all'ID campo.
Le proprietà presenti in tutti i tipi di campo vengono restituite al livello superiore. Le proprietà univoche per un tipo specifico di campo vengono restituite sotto l'attributo 'properties'. Per altri dettagli sulle proprietà per ogni tipo di campo, vedere la pagina Tipi di campo.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco (DBID) della tabella.

Includi autorizzazioni campo
includeFieldPerms boolean

Impostare su "true" se si desidera ottenere le autorizzazioni personalizzate per i campi.

ID campo
fieldId True integer

Identificatore univoco (FID) del campo.

Restituisce

Ottenere la risposta al campo
getFieldResponse

Scaricare un allegato

Scarica l'allegato di file, con il contenuto dell'allegato di file codificato in formato Base64. La risposta API restituisce il nome del file nell'intestazione Content-Disposition . I metadati sui file possono essere recuperati dagli endpoint /records e /reports, se applicabile. Usare questi endpoint per ottenere le informazioni necessarie per recuperare i file.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID tabella
tableId True string

Identificatore univoco della tabella.

ID record
recordId True integer

Identificatore univoco del record.

ID campo
fieldId True integer

Identificatore univoco del campo.

Numero di versione
versionNumber True integer

Numero di versione dell'allegato di file.

Restituisce

response
string

Definizioni

createAppResponse

Nome Percorso Tipo Descrizione
nome
name string

Nome dell'app. È possibile creare più app con lo stesso nome, nella stessa area di autenticazione, perché avranno valori dbid diversi. Vi invitiamo ad essere attenti a farlo.

descrizione
description string

Descrizione dell'app. Se questa proprietà viene interrotta, la descrizione dell'app sarà vuota.

creato
created string

Ora e data di creazione dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (in fuso orario UTC).

aggiornato
updated string

Ora e data dell'ultimo aggiornamento dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (nel fuso orario UTC).

dateFormat
dateFormat string

Descrizione del formato usato per la visualizzazione dei valori di data in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nella Guida API. Vedi Informazioni sulla localizzazione delle date per impostare il formato della data dell'app.

timeZone
timeZone string

Descrizione del fuso orario usato per la visualizzazione dei valori di ora in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nel portale. Vedere Impostare il fuso orario per l'applicazione e l'account per impostare il fuso orario dell'applicazione.

id
id string

Identificatore univoco per l'applicazione.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica se l'app include Tutti gli utenti sull'accesso a Internet. Vedi Condivisione di app con Tutti su Internet (EOTI).

variables
variables array of Variable1

Variabili dell'app. Vedere Informazioni sulle variabili dell'applicazione

dataClassification
dataClassification string

Etichetta Classificazione dati assegnata all'applicazione. Se la classificazione dei dati non è attivata, non verrà restituita. Se la classificazione dei dati è attivata, ma l'applicazione non è etichettata, viene restituito "Nessuno". Le etichette di classificazione dei dati possono essere aggiunte nella Console di amministrazione da un amministratore dell'area di autenticazione per i piani Platform+.

Variabile1

Nome Percorso Tipo Descrizione
nome
name string

Nome variabile.

value
value string

Valore variabile.

getAppResponse

Nome Percorso Tipo Descrizione
nome
name string

Nome dell'app. È possibile creare più app con lo stesso nome, nella stessa area di autenticazione, perché avranno valori dbid diversi. Vi invitiamo ad essere attenti a farlo.

descrizione
description string

Descrizione dell'app. Se questa proprietà viene interrotta, la descrizione dell'app sarà vuota.

creato
created string

Ora e data di creazione dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (in fuso orario UTC).

aggiornato
updated string

Ora e data dell'ultimo aggiornamento dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (nel fuso orario UTC).

dateFormat
dateFormat string

Descrizione del formato usato per la visualizzazione dei valori di data in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nella Guida API. Vedi Informazioni sulla localizzazione delle date per impostare il formato della data dell'app.

timeZone
timeZone string

Descrizione del fuso orario usato per la visualizzazione dei valori di ora in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nel portale. Vedere Impostare il fuso orario per l'applicazione e l'account per impostare il fuso orario dell'applicazione.

id
id string

Identificatore univoco per l'applicazione.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica se l'app include Tutti gli utenti sull'accesso a Internet. Vedi Condivisione di app con Tutti su Internet (EOTI).

variables
variables array of Variable1

Variabili dell'app. Vedere Informazioni sulle variabili dell'applicazione

dataClassification
dataClassification string

Etichetta Classificazione dati assegnata all'applicazione. Se la classificazione dei dati non è attivata, non verrà restituita. Se la classificazione dei dati è attivata, ma l'applicazione non è etichettata, viene restituito "Nessuno". Le etichette di classificazione dei dati possono essere aggiunte nella Console di amministrazione da un amministratore dell'area di autenticazione per i piani Platform+.

updateAppResponse

Nome Percorso Tipo Descrizione
nome
name string

Nome dell'app. È possibile creare più app con lo stesso nome, nella stessa area di autenticazione, perché avranno valori dbid diversi. Vi invitiamo ad essere attenti a farlo.

descrizione
description string

Descrizione dell'app. Se questa proprietà viene interrotta, la descrizione dell'app sarà vuota.

creato
created string

Ora e data di creazione dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (in fuso orario UTC).

aggiornato
updated string

Ora e data dell'ultimo aggiornamento dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (nel fuso orario UTC).

dateFormat
dateFormat string

Descrizione del formato usato per la visualizzazione dei valori di data in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nella Guida API. Vedi Informazioni sulla localizzazione delle date per impostare il formato della data dell'app.

timeZone
timeZone string

Descrizione del fuso orario usato per la visualizzazione dei valori di ora in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nel portale. Vedere Impostare il fuso orario per l'applicazione e l'account per impostare il fuso orario dell'applicazione.

id
id string

Identificatore univoco per l'applicazione.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica se l'app include Tutti gli utenti sull'accesso a Internet. Vedi Condivisione di app con Tutti su Internet (EOTI).

variables
variables array of Variable1

Variabili dell'app. Vedere Informazioni sulle variabili dell'applicazione

dataClassification
dataClassification string

Etichetta Classificazione dati assegnata all'applicazione. Se la classificazione dei dati non è attivata, non verrà restituita. Se la classificazione dei dati è attivata, ma l'applicazione non è etichettata, viene restituito "Nessuno". Le etichette di classificazione dei dati possono essere aggiunte nella Console di amministrazione da un amministratore dell'area di autenticazione per i piani Platform+.

deleteAppResponse

Nome Percorso Tipo Descrizione
deletedAppId
deletedAppId string

ID dell'applicazione eliminata.

copyAppResponse

Nome Percorso Tipo Descrizione
nome
name string

Nome dell'app. È possibile creare più app con lo stesso nome, nella stessa area di autenticazione, perché avranno valori dbid diversi. Vi invitiamo ad essere attenti a farlo.

descrizione
description string

Descrizione dell'app

creato
created string

Ora e data di creazione dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (in fuso orario UTC).

aggiornato
updated string

Ora e data dell'ultimo aggiornamento dell'app, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (nel fuso orario UTC).

dateFormat
dateFormat string

Descrizione del formato usato per la visualizzazione dei valori di data in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nella Guida API. Vedi Informazioni sulla localizzazione delle date per impostare il formato della data dell'app.

timeZone
timeZone string

Descrizione del fuso orario usato per la visualizzazione dei valori di ora in questa app. Si noti che si tratta di un parametro solo browser. Per informazioni sulla modalità di restituzione dei valori di ora nelle chiamate API, vedere la pagina Dettagli tipo di campo nel portale. Vedere Impostare il fuso orario per l'applicazione e l'account per impostare il fuso orario dell'applicazione.

id
id string

Identificatore univoco per l'applicazione.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Indica se l'app include Tutti gli utenti sull'accesso a Internet. Vedi Condivisione di app con Tutti su Internet (EOTI).

variables
variables array of Variable1

Variabili dell'app. Vedere Informazioni sulle variabili dell'applicazione

predecessorId
ancestorId string

ID dell'app da cui è stata copiata l'app

dataClassification
dataClassification string

Etichetta Classificazione dati assegnata all'applicazione. Se la classificazione dei dati non è attivata, non verrà restituita. Se la classificazione dei dati è attivata, ma l'applicazione non è etichettata, viene restituito "Nessuno". Le etichette di classificazione dei dati possono essere aggiunte nella Console di amministrazione da un amministratore dell'area di autenticazione per i piani Platform+.

createTableResponse

Nome Percorso Tipo Descrizione
nome
name string

Nome della tabella.

id
id string

Identificatore univoco (dbid) della tabella.

alias
alias string

Alias di tabella creato automaticamente per la tabella.

descrizione
description string

Descrizione della tabella, come configurato da un amministratore dell'applicazione.

creato
created string

Ora e data di creazione della tabella, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (fuso orario UTC).

aggiornato
updated string

Ora e data dell'ultimo aggiornamento dello schema o dei dati della tabella, nel formato ORA ISO 8601 AAAA-MM-GGThh:mm:ss.sssZ (fuso orario UTC).

nextRecordId
nextRecordId integer

ID record incrementale che verrà usato quando viene creato il record successivo, come determinato quando è stata eseguita la chiamata API.

nextFieldId
nextFieldId integer

ID campo incrementale che verrà usato quando viene creato il campo successivo, come determinato quando è stata eseguita la chiamata API.

defaultSortFieldId
defaultSortFieldId integer

ID del campo configurato per l'ordinamento predefinito.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Configurazione dell'ordinamento predefinito nella tabella.

keyFieldId
keyFieldId integer

ID del campo configurato come chiave in questa tabella, che è in genere l'ID record quickbase.

singleRecordName
singleRecordName string

Sostantivo singolare configurato dal generatore della tabella.

pluralRecordName
pluralRecordName string

Sostantivo plurale configurato dal generatore della tabella.

sizeLimit
sizeLimit string

Limite di dimensioni per la tabella.

spaceUsed
spaceUsed string

Quantità di spazio attualmente utilizzata dalla tabella.

spaceRemaining
spaceRemaining string

Quantità di spazio rimanente per l'utilizzo da parte della tabella.

DefaultSortOrder

Configurazione dell'ordinamento predefinito nella tabella.

Configurazione dell'ordinamento predefinito nella tabella.

DefaultSortOrder
string

getTableResponse

Nome Percorso Tipo Descrizione
nome
name string

Nome della tabella.

id
id string

Identificatore univoco (dbid) della tabella.

alias
alias string

Alias di tabella creato automaticamente per la tabella.

descrizione
description string

Descrizione della tabella, come configurato da un amministratore dell'applicazione.

creato
created string

Ora e data di creazione della tabella, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (fuso orario UTC).

aggiornato
updated string

Ora e data dell'ultimo aggiornamento dello schema o dei dati della tabella, nel formato ORA ISO 8601 AAAA-MM-GGThh:mm:ss.sssZ (fuso orario UTC).

nextRecordId
nextRecordId integer

ID record incrementale che verrà usato quando viene creato il record successivo, come determinato quando è stata eseguita la chiamata API.

nextFieldId
nextFieldId integer

ID campo incrementale che verrà usato quando viene creato il campo successivo, come determinato quando è stata eseguita la chiamata API.

defaultSortFieldId
defaultSortFieldId integer

ID del campo configurato per l'ordinamento predefinito.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Configurazione dell'ordinamento predefinito nella tabella.

keyFieldId
keyFieldId integer

ID del campo configurato come chiave in questa tabella, che è in genere l'ID record quickbase.

singleRecordName
singleRecordName string

Sostantivo singolare configurato dal generatore della tabella.

pluralRecordName
pluralRecordName string

Sostantivo plurale configurato dal generatore della tabella.

sizeLimit
sizeLimit string

Limite di dimensioni per la tabella.

spaceUsed
spaceUsed string

Quantità di spazio attualmente utilizzata dalla tabella.

spaceRemaining
spaceRemaining string

Quantità di spazio rimanente per l'utilizzo da parte della tabella.

updateTableResponse

Nome Percorso Tipo Descrizione
nome
name string

Nome della tabella.

id
id string

Identificatore univoco (dbid) della tabella.

alias
alias string

Alias di tabella creato automaticamente per la tabella.

descrizione
description string

Descrizione della tabella, come configurato da un amministratore dell'applicazione.

creato
created string

Ora e data di creazione della tabella, nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (fuso orario UTC).

aggiornato
updated string

Ora e data dell'ultimo aggiornamento dello schema o dei dati della tabella, nel formato ORA ISO 8601 AAAA-MM-GGThh:mm:ss.sssZ (fuso orario UTC).

nextRecordId
nextRecordId integer

ID record incrementale che verrà usato quando viene creato il record successivo, come determinato quando è stata eseguita la chiamata API.

nextFieldId
nextFieldId integer

ID campo incrementale che verrà usato quando viene creato il campo successivo, come determinato quando è stata eseguita la chiamata API.

defaultSortFieldId
defaultSortFieldId integer

ID del campo configurato per l'ordinamento predefinito.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Configurazione dell'ordinamento predefinito nella tabella.

keyFieldId
keyFieldId integer

ID del campo configurato come chiave in questa tabella, che è in genere l'ID record quickbase.

singleRecordName
singleRecordName string

Sostantivo singolare configurato dal generatore della tabella.

pluralRecordName
pluralRecordName string

Sostantivo plurale configurato dal generatore della tabella.

sizeLimit
sizeLimit string

Limite di dimensioni per la tabella.

spaceUsed
spaceUsed string

Quantità di spazio attualmente utilizzata dalla tabella.

spaceRemaining
spaceRemaining string

Quantità di spazio rimanente per l'utilizzo da parte della tabella.

deleteTableResponse

Nome Percorso Tipo Descrizione
deletedTableId
deletedTableId string

ID tabella eliminato.

getRelationshipsResponse

Nome Percorso Tipo Descrizione
Relazioni
relationships array of Relationship

Relazioni in una tabella.

Metadati
metadata Metadata

Informazioni aggiuntive sui risultati che possono essere utili.

Relazione

Nome Percorso Tipo Descrizione
id
id integer

ID relazione (ID campo chiave esterna).

parentTableId
parentTableId string

ID tabella padre della relazione.

childTableId
childTableId string

ID tabella figlio della relazione.

ForeignKeyField
foreignKeyField ForeignKeyField

Informazioni sul campo chiave esterna.

isCrossApp
isCrossApp boolean

Indica se si tratta di una relazione tra app.

lookupFields
lookupFields array of LookupField

Matrice di campi di ricerca.

summaryFields
summaryFields array of SummaryField

Matrice di campi di riepilogo.

ForeignKeyField

Informazioni sul campo chiave esterna.

Nome Percorso Tipo Descrizione
id
id integer

ID campo.

label
label string

Etichetta campo.

type
type string

Tipo di campo.

LookupField

Nome Percorso Tipo Descrizione
id
id integer

ID campo.

label
label string

Etichetta campo.

type
type string

Tipo di campo.

SummaryField

Nome Percorso Tipo Descrizione
id
id integer

ID campo.

label
label string

Etichetta campo.

type
type string

Tipo di campo.

Metadati

Informazioni aggiuntive sui risultati che possono essere utili.

Nome Percorso Tipo Descrizione
skip
skip integer

Numero di relazioni da ignorare.

totalRelationships
totalRelationships integer

Numero totale di relazioni.

numRelationships
numRelationships integer

Numero di relazioni nell'oggetto risposta corrente.

createRelationshipResponse

Nome Percorso Tipo Descrizione
id
id integer

ID relazione (ID campo chiave esterna).

parentTableId
parentTableId string

ID tabella padre della relazione.

childTableId
childTableId string

ID tabella figlio della relazione.

ForeignKeyField
foreignKeyField ForeignKeyField

Informazioni sul campo chiave esterna.

isCrossApp
isCrossApp boolean

Indica se si tratta di una relazione tra app.

lookupFields
lookupFields array of LookupField

Matrice di campi di ricerca.

summaryFields
summaryFields array of SummaryField

Matrice di campi di riepilogo.

updateRelationshipResponse

Nome Percorso Tipo Descrizione
id
id integer

ID relazione (ID campo chiave esterna).

parentTableId
parentTableId string

ID tabella padre della relazione.

childTableId
childTableId string

ID tabella figlio della relazione.

ForeignKeyField
foreignKeyField ForeignKeyField

Informazioni sul campo chiave esterna.

isCrossApp
isCrossApp boolean

Indica se si tratta di una relazione tra app.

lookupFields
lookupFields array of LookupField

Matrice di campi di ricerca.

summaryFields
summaryFields array of SummaryField

Matrice di campi di riepilogo.

deleteRelationshipResponse

Nome Percorso Tipo Descrizione
relationshipId
relationshipId integer

ID relazione.

Query

Definizione di query configurata in Quickbase che viene eseguita quando viene eseguito il report.

Nome Percorso Tipo Descrizione
tableId
tableId string

Identificatore di tabella per il report.

filtro
filter string

Filtro usato per eseguire query sui dati.

formulaFields
formulaFields array of FormulaField

Campi formula calcolati.

FormulaField

Nome Percorso Tipo Descrizione
id
id integer

Identificatore del campo della formula.

label
label string

Etichetta del campo formula.

FieldType
fieldType FieldType

Tipo di valore della formula risultante.

formula
formula string

Testo della formula.

decimalPrecision
decimalPrecision integer

Per la formula numerica la precisione numerica del numero.

FieldType

Tipo di valore della formula risultante.

Tipo di valore della formula risultante.

FieldType
string

getReportResponse

Nome Percorso Tipo Descrizione
id
id string

Identificatore del report, univoco per la tabella.

nome
name string

Nome configurato del report.

type
type string

Tipo di report in Quickbase (ad esempio, grafico).

descrizione
description string

Descrizione configurata di un report.

ownerId
ownerId integer

Facoltativo, mostrato solo per i report personali. ID utente del proprietario del report.

Query
query Query

Definizione di query configurata in Quickbase che viene eseguita quando viene eseguito il report.

proprietà
properties object

Elenco di proprietà specifiche del tipo di report. Per visualizzare una descrizione dettagliata delle proprietà per ogni tipo di report, vedere Tipi di report.

usedLast
usedLast string

Istante in cui è stato utilizzato un report per l'ultima volta.

usedCount
usedCount integer

Numero di volte in cui è stato utilizzato un report.

runReportResponse

Nome Percorso Tipo Descrizione
fields
fields array of Field

Matrice di oggetti che contiene metadati limitati di ogni campo visualizzato nel report. Ciò consente di creare logica che dipende da tipi di campo e ID.

data
data array of object

Matrice di oggetti che rappresenta i dati del record o i valori riepilogati, a seconda del tipo di report.

items
data object
Metadati1
metadata Metadata1

Informazioni aggiuntive sui risultati che possono essere utili. L'impaginazione può essere necessaria se si specifica un numero inferiore di risultati da ignorare rispetto a quanto disponibile oppure se l'API restituisce automaticamente un minor numero di risultati. numRecords può essere confrontato con totalRecords per determinare se è necessaria un'ulteriore impaginazione.

Campo

Nome Percorso Tipo Descrizione
id
id integer

ID campo.

label
label string

Etichetta campo.

type
type string

Tipo di campo.

labelOverride
labelOverride string

Override dell'etichetta dell'intestazione di colonna per il campo nel report.

Metadati1

Informazioni aggiuntive sui risultati che possono essere utili. L'impaginazione può essere necessaria se si specifica un numero inferiore di risultati da ignorare rispetto a quanto disponibile oppure se l'API restituisce automaticamente un minor numero di risultati. numRecords può essere confrontato con totalRecords per determinare se è necessaria un'ulteriore impaginazione.

Nome Percorso Tipo Descrizione
skip
skip integer

Numero di record da ignorare

numFields
numFields integer

Numero di campi in ogni record nell'oggetto risposta corrente

top
top integer

Se presente, numero massimo di record richiesti dal chiamante

totalRecords
totalRecords integer

Numero totale di record nel set di risultati

numRecords
numRecords integer

Numero di record nell'oggetto risposta corrente

Proprietà1

Proprietà aggiuntive per il campo. Per altri dettagli sulle proprietà per ogni tipo di campo, vedere la pagina Dei dettagli sul tipo di campo.

Nome Percorso Tipo Descrizione
comments
comments string

Commenti immessi nelle proprietà del campo da un amministratore.

doesTotal
doesTotal boolean

Indica se questo campo viene totale nei report all'interno del prodotto.

Salvataggio automatico
autoSave boolean

Indica se il campo del collegamento verrà salvato automaticamente.

defaultValueLuid
defaultValueLuid integer

Valore id utente predefinito.

maxVersions
maxVersions integer

Numero massimo di versioni configurate per un allegato di file.

carryChoices
carryChoices boolean

Indica se il campo deve contenere i campi a scelta multipla durante la copia.

format
format integer

Formato da visualizzare.

lunghezza massima
maxLength integer

Numero massimo di caratteri consentiti per la voce in Quickbase per questo campo.

linkText
linkText string

Valore di testo configurato che sostituisce l'URL visualizzato dagli utenti all'interno del prodotto.

parentFieldId
parentFieldId integer

ID del campo composito padre, se applicabile.

displayTimezone
displayTimezone boolean

Indica se visualizzare il fuso orario all'interno del prodotto.

summaryTargetFieldId
summaryTargetFieldId integer

ID del campo utilizzato per aggregare i valori dell'elemento figlio, se applicabile. Viene visualizzato 0 se la funzione di riepilogo non richiede una selezione di campi (ad esempio count).

allowNewChoices
allowNewChoices boolean

Indica se gli utenti possono aggiungere nuove opzioni a un elenco di selezione.

masterChoiceFieldId
masterChoiceFieldId integer

ID del campo che rappresenta il riferimento nella relazione.

defaultToday
defaultToday boolean

Indica se il valore del campo è attualmente predefinito per i nuovi record.

Unità
units string

Etichetta unità.

lookupTargetFieldId
lookupTargetFieldId integer

ID del campo che rappresenta la destinazione nella tabella master per questa ricerca.

SummaryFunction
summaryFunction SummaryFunction

Tipo di funzione di accumulo di riepilogo.

sourceFieldId
sourceFieldId integer

ID del campo di origine.

masterTableTag
masterTableTag string

L'alias di tabella per la tabella master nella relazione di cui fa parte questo campo.

doesAverage
doesAverage boolean

Indica se questo campo viene mediato nei report all'interno del prodotto.

formula
formula string

Formula del campo come configurato in Quickbase.

decimalPlaces
decimalPlaces integer

Numero di posizioni decimali visualizzate nel prodotto per questo campo.

seeVersions
seeVersions boolean

Indica se l'utente può visualizzare altre versioni, a parte la più recente, di un allegato di file all'interno del prodotto.

displayMonth
displayMonth string

Come visualizzare i mesi.

numLines
numLines integer

Numero di righe visualizzate in Quickbase per questo campo di testo.

displayEmail
displayEmail string

Modalità di visualizzazione del messaggio di posta elettronica.

defaultKind
defaultKind string

Tipo predefinito dell'utente.

coverText
coverText string

Testo descrittivo alternativo che può essere usato per visualizzare un collegamento nel browser.

currencySymbol
currencySymbol string

Simbolo corrente utilizzato durante la visualizzazione dei valori di campo all'interno del prodotto.

masterChoiceTableId
masterChoiceTableId integer

ID della tabella master in questa relazione.

targetFieldId
targetFieldId integer

ID del campo di destinazione.

displayUser
displayUser string

Opzione configurata per la modalità di visualizzazione degli utenti all'interno del prodotto.

blankIsZero
blankIsZero boolean

Indica se un valore vuoto viene considerato uguale a 0 nei calcoli all'interno del prodotto.

esatto
exact boolean

Indica se è necessaria una corrispondenza esatta per un collegamento al report.

startField
startField integer

ID campo iniziale.

defaultDomain
defaultDomain string

Dominio di posta elettronica predefinito.

defaultValue
defaultValue string

Valore predefinito configurato per un campo quando viene aggiunto un nuovo record.

choicesLuid
choicesLuid array of object

Elenco di scelte utente.

items
choicesLuid object
abbreviare
abbreviate boolean

Non visualizzare il protocollo URL quando viene visualizzato l'URL.

xmlTag
xmlTag string

Tag xml del campo.

targetTableName
targetTableName string

Nome della tabella di destinazione del campo.

formatoNumero
numberFormat integer

Formato utilizzato per la visualizzazione di valori numerici nel prodotto (decimale, separatori, gruppo di cifre).

appearsAs
appearsAs string

Il testo del collegamento, se vuoto, verrà usato come testo del collegamento.

Larghezza
width integer

Larghezza di input html del campo nel prodotto.

CurrencyFormat
currencyFormat CurrencyFormat

Formato di valuta utilizzato per la visualizzazione dei valori di campo all'interno del prodotto.

displayImages
displayImages boolean

Indica se le immagini verranno visualizzate per gli allegati di file nei moduli e nei report all'interno del prodotto.

foreignKey
foreignKey boolean

Indica se il campo è una chiave esterna (o un campo di riferimento) in una relazione.

displayDayOfWeek
displayDayOfWeek boolean

Indica se visualizzare il giorno della settimana all'interno del prodotto.

summaryReferenceFieldId
summaryReferenceFieldId integer

ID del campo che rappresenta il riferimento nella relazione per questo riepilogo.

Avvio virgola
commaStart integer

Numero di cifre prima della visualizzazione delle virgole nel prodotto, se applicabile.

choices
choices array of string

Matrice di voci esistenti per un campo che offre opzioni all'utente.

targetTableId
targetTableId string

ID della tabella di destinazione.

displayRelative
displayRelative boolean

Indica se visualizzare l'ora come relativa.

compositeFields
compositeFields array of object

Matrice dei campi che costituiscono un campo composito (ad esempio, indirizzo).

items
compositeFields object
VersionMode
versionMode VersionMode

Modalità di versione per i file. Mantenere tutte le versioni e mantenere l'ultima versione.

displayTime
displayTime boolean

Indica se visualizzare l'ora, oltre alla data.

durationField
durationField integer

ID campo durata.

snapFieldId
snapFieldId integer

ID del campo utilizzato per creare uno snapshot dei valori, se applicabile.

ore24
hours24 boolean

Indica se visualizzare o meno l'ora nel formato di 24 ore all'interno del prodotto.

sortAlpha
sortAlpha boolean

Se ordinare alfabeticamente, l'ordinamento predefinito è in base all'ID record.

sortAsGiven
sortAsGiven boolean

Indica se le voci elencate vengono ordinate come immesse in ordine alfabetico.

hasExtension
hasExtension boolean

Indica se il campo dispone di un'estensione telefono.

Workweek
workWeek integer

Tipo di settimana lavorativa.

useNewWindow
useNewWindow boolean

Indica se l'URL deve aprire una nuova finestra quando un utente lo fa clic all'interno del prodotto.

appendOnly
appendOnly boolean

Indica se questo campo è solo accodato.

displayAsLink
displayAsLink boolean

Indica se un campo che fa parte della relazione deve essere visualizzato come collegamento ipertestuale al record padre all'interno del prodotto.

allowHTML
allowHTML boolean

Indica se questo campo consente html.

lookupReferenceFieldId
lookupReferenceFieldId integer

ID del campo che rappresenta il riferimento nella relazione per questa ricerca.

SummaryFunction

Tipo di funzione di accumulo di riepilogo.

Tipo di funzione di accumulo di riepilogo.

SummaryFunction
string

CurrencyFormat

Formato di valuta utilizzato per la visualizzazione dei valori di campo all'interno del prodotto.

Formato di valuta utilizzato per la visualizzazione dei valori di campo all'interno del prodotto.

CurrencyFormat
string

VersionMode

Modalità di versione per i file. Mantenere tutte le versioni e mantenere l'ultima versione.

Modalità di versione per i file. Mantenere tutte le versioni e mantenere l'ultima versione.

VersionMode
string

Autorizzazione

Nome Percorso Tipo Descrizione
ruolo
role string

Ruolo associato a una determinata autorizzazione per il campo

permissionType
permissionType string

Autorizzazione assegnata al ruolo per questo campo

roleId
roleId integer

ID del ruolo specificato

createFieldResponse

Nome Percorso Tipo Descrizione
id
id integer

ID del campo, univoco per questa tabella.

fieldType
fieldType string

Tipo di campo, come descritto qui.

mode
mode string

Per i campi derivati, si tratta di 'lookup', 'summary' o 'formula', per indicare il tipo di campo derivato. Per i campi non derivati, questo valore sarà vuoto.

label
label string

Etichetta (nome) del campo.

noWrap
noWrap boolean

Indica se il campo è configurato per non eseguire il wrapping quando viene visualizzato nel prodotto.

grassetto
bold boolean

Indica se il campo è configurato per la visualizzazione in grassetto nel prodotto.

required
required boolean

Indica se il campo è contrassegnato come obbligatorio.

appearsByDefault
appearsByDefault boolean

Indica se il campo è contrassegnato come predefinito nei report.

findEnabled
findEnabled boolean

Indica se il campo è contrassegnato come ricercabile.

unico
unique boolean

Indica se il campo è contrassegnato come univoco.

doesDataCopy
doesDataCopy boolean

Indica se i dati del campo verranno copiati quando un utente copia il record.

fieldHelp
fieldHelp string

Testo della Guida configurato visualizzato agli utenti all'interno del prodotto.

Controllati
audited boolean

Indica se il campo viene rilevato come parte dei log di controllo quickbase.

Proprietà1
properties Properties1

Proprietà aggiuntive per il campo. Per altri dettagli sulle proprietà per ogni tipo di campo, vedere la pagina Dei dettagli sul tipo di campo.

permissions
permissions array of Permission

Autorizzazioni campo per ruoli diversi.

deleteFieldsResponse

Nome Percorso Tipo Descrizione
deletedFieldIds
deletedFieldIds array of integer

Elenco di ID campo da eliminare.

errori
errors array of string

Elenco degli errori rilevati.

getFieldResponse

Nome Percorso Tipo Descrizione
id
id integer

ID del campo, univoco per questa tabella.

fieldType
fieldType string

Tipo di campo, come descritto qui.

mode
mode string

Per i campi derivati, si tratta di 'lookup', 'summary' o 'formula', per indicare il tipo di campo derivato. Per i campi non derivati, questo valore sarà vuoto.

label
label string

Etichetta (nome) del campo.

noWrap
noWrap boolean

Indica se il campo è configurato per non eseguire il wrapping quando viene visualizzato nel prodotto.

grassetto
bold boolean

Indica se il campo è configurato per la visualizzazione in grassetto nel prodotto.

required
required boolean

Indica se il campo è contrassegnato come obbligatorio.

appearsByDefault
appearsByDefault boolean

Indica se il campo è contrassegnato come predefinito nei report.

findEnabled
findEnabled boolean

Indica se il campo è contrassegnato come ricercabile.

unico
unique boolean

Indica se il campo è contrassegnato come univoco.

doesDataCopy
doesDataCopy boolean

Indica se i dati del campo verranno copiati quando un utente copia il record.

fieldHelp
fieldHelp string

Testo della Guida configurato visualizzato agli utenti all'interno del prodotto.

Controllati
audited boolean

Indica se il campo viene rilevato come parte dei log di controllo quickbase.

Proprietà1
properties Properties1

Proprietà aggiuntive per il campo. Per altri dettagli sulle proprietà per ogni tipo di campo, vedere la pagina Dei dettagli sul tipo di campo.

permissions
permissions array of Permission

Autorizzazioni campo per ruoli diversi.

updateFieldResponse

Nome Percorso Tipo Descrizione
id
id integer

ID del campo, univoco per questa tabella.

fieldType
fieldType string

Tipo di campo, come descritto qui.

mode
mode string

Per i campi derivati, si tratta di 'lookup', 'summary' o 'formula', per indicare il tipo di campo derivato. Per i campi non derivati, questo valore sarà vuoto.

label
label string

Etichetta (nome) del campo.

noWrap
noWrap boolean

Indica se il campo è configurato per non eseguire il wrapping quando viene visualizzato nel prodotto.

grassetto
bold boolean

Indica se il campo è configurato per la visualizzazione in grassetto nel prodotto.

required
required boolean

Indica se il campo è contrassegnato come obbligatorio.

appearsByDefault
appearsByDefault boolean

Indica se il campo è contrassegnato come predefinito nei report.

findEnabled
findEnabled boolean

Indica se il campo è contrassegnato come ricercabile.

unico
unique boolean

Indica se il campo è contrassegnato come univoco.

doesDataCopy
doesDataCopy boolean

Indica se i dati del campo verranno copiati quando un utente copia il record.

fieldHelp
fieldHelp string

Testo della Guida configurato visualizzato agli utenti all'interno del prodotto.

Controllati
audited boolean

Indica se il campo viene rilevato come parte dei log di controllo quickbase.

Proprietà1
properties Properties1

Proprietà aggiuntive per il campo. Per altri dettagli sulle proprietà per ogni tipo di campo, vedere la pagina Dei dettagli sul tipo di campo.

permissions
permissions array of Permission

Autorizzazioni campo per ruoli diversi.

runFormulaResponse

Nome Percorso Tipo Descrizione
risultato
result string

Risultato dell'esecuzione della formula.

upsertResponse

Risposta con esito positivo che include dettagli sui record aggiunti, aggiornati o invariati. Nell'esempio seguente la tabella in precedenza aveva dieci record con ID da 1 a 10. L'utente pubblica un upsert che aggiorna il valore del record 1 e aggiunge due nuovi record, tutti correttamente.

Nome Percorso Tipo Descrizione
Metadati2
metadata Metadata2

Informazioni sui record creati, sui record aggiornati, sui record a cui si fa riferimento ma non modificati e sui record che presentano errori durante l'elaborazione.

data
data array of object

Dati che si prevede vengano restituiti.

items
data object

Metadati2

Informazioni sui record creati, sui record aggiornati, sui record a cui si fa riferimento ma non modificati e sui record che presentano errori durante l'elaborazione.

Nome Percorso Tipo Descrizione
createdRecordIds
createdRecordIds array of integer

Matrice contenente gli ID record creati.

lineErrors
lineErrors object

Verrà restituito solo in caso di record non riusciti. Si tratta di una raccolta di errori che si sono verificati durante l'elaborazione dei dati in ingresso che hanno causato l'elaborazione dei record non elaborati. Ogni oggetto ha una chiave che rappresenta il numero di sequenza del record nel payload originale (a partire da 1). Il valore è un elenco di errori che si sono verificati.

unchangedRecordIds
unchangedRecordIds array of integer

Matrice contenente gli ID record non modificati.

updatedRecordIds
updatedRecordIds array of integer

Matrice contenente gli ID record aggiornati.

totalNumberOfRecordsProcessed
totalNumberOfRecordsProcessed integer

Numero di record elaborati. Include aggiornamenti dei record riusciti e non riusciti.

deleteRecordsResponse

Nome Percorso Tipo Descrizione
numberDeleted
numberDeleted integer

Numero di record eliminati.

runQueryResponse

Nome Percorso Tipo Descrizione
fields
fields array of Fields2

Matrice di oggetti che contiene metadati limitati di ogni campo visualizzato nel report. Ciò consente di creare logica che dipende da tipi di campo e ID.

data
data array of object

Matrice di oggetti che rappresenta i dati del record o i valori riepilogati, a seconda del tipo di report.

items
data object
Metadati1
metadata Metadata1

Informazioni aggiuntive sui risultati che possono essere utili. L'impaginazione può essere necessaria se si specifica un numero inferiore di risultati da ignorare rispetto a quanto disponibile oppure se l'API restituisce automaticamente un minor numero di risultati. numRecords può essere confrontato con totalRecords per determinare se è necessaria un'ulteriore impaginazione.

Campi2

Nome Percorso Tipo Descrizione
id
id integer

ID campo.

label
label string

Etichetta campo.

type
type string

Tipo di campo.

getTempTokenDBIDResponse

Nome Percorso Tipo Descrizione
temporaryAuthorization
temporaryAuthorization string

Token di autorizzazione temporaneo.

cloneUserTokenResponse

Nome Percorso Tipo Descrizione
attivo
active boolean

Indica se il token utente è attivo.

apps
apps array of App

L'elenco di app a cui è assegnato questo token utente.

lastUsed
lastUsed string

Data dell'ultima utilizzo del token utente nel formato ISO 8601 ora AAAA-MM-GGThh:mm:ss.sssZ (fuso orario UTC).

descrizione
description string

Descrizione del token utente.

id
id integer

ID token utente.

nome
name string

Nome token utente.

token
token string

Valore token utente.

Applicazione

Nome Percorso Tipo Descrizione
id
id string

Identificatore univoco per l'applicazione.

nome
name string

Nome dell'applicazione.

deleteUserTokenResponse

Nome Percorso Tipo Descrizione
id
id integer

ID token utente.

deleteFileResponse

Nome Percorso Tipo Descrizione
versionNumber
versionNumber integer

Numero di versione eliminata.

fileName
fileName string

Nome del file associato alla versione eliminata.

Caricato
uploaded string

Timestamp quando la versione è stata caricata originariamente.

Creatore
creator Creator

Utente che ha caricato la versione.

Creatore

Utente che ha caricato la versione.

Nome Percorso Tipo Descrizione
nome
name string

Nome completo dell'utente.

id
id string

ID utente.

posta elettronica
email string

Indirizzo di posta elettronica dell'utente.

nome utente
userName string

Nome utente aggiornato nelle proprietà utente. Facoltativo, viene visualizzato se non corrisponde all'indirizzo di posta elettronica dell'utente.

corda

Si tratta del tipo di dati di base 'string'.