Freigeben über


Schnellbasis (unabhängiger Herausgeber)

Quickbase ist eine Plattform für die Anwendungsentwicklung, die Geschäfts- und IT-Teams vereint, indem Problemlöser von technischen Hintergründen zusammenarbeiten können, um sicher, sicher und nachhaltig ein Ökosystem von Anwendungen zu schaffen. Quickbase hilft Unternehmen dabei, die kontinuierliche Innovation einzigartiger Prozesse zu beschleunigen, indem sie die Bürgerentwicklung auf einer gemeinsamen Plattform ermöglichen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connectormetadaten
Herausgeber Troy Taylor, Hitachi Solutions
Webseite https://www.quickbase.com/
Datenschutzrichtlinie https://www.quickbase.com/privacy
Kategorien Produktivität;IT-Vorgänge

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Bereichshostname Schnur Geben Sie den Namen Des Bereichs hostnamen an. Richtig
Autorisierung securestring Das Benutzertoken für das Formular "QB-USER-TOKEN YourToken". Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abfragen von Daten

Übergeben Sie eine Abfrage in der Quickbase-Abfragesprache. Gibt Datensatzdaten mit intelligenter Paginierung basierend auf der ungefähren Größe jedes Datensatzes zurück. Das Metadatenobjekt enthält die erforderlichen Informationen, um die Antwort zu durchlaufen und weitere Daten zu sammeln.

Abrufen aller Beziehungen

Dient zum Abrufen einer Liste aller Beziehungen und deren Definitionen für eine bestimmte Tabelle. Details werden sowohl für die übergeordneten als auch die untergeordneten Seiten von Beziehungen innerhalb einer bestimmten Anwendung bereitgestellt. Für anwendungsübergreifende Beziehungen werden eingeschränkte Details zurückgegeben.

Abrufen aller Tabellenberichte

Dient zum Abrufen des Schemas (Eigenschaften) aller Berichte für eine Tabelle. Wenn der Benutzer, der die API ausführt, ein Anwendungsadministrator ist, gibt die API auch alle persönlichen Berichte mit der Benutzer-ID des Besitzers zurück.

Abrufen der Verwendung für alle Felder

Ruft alle Feldnutzungsstatistiken für eine Tabelle ab. Dies ist eine Zusammenfassung der Informationen, die in der Verwendungstabelle der Feldeigenschaften zu finden sind.

Abrufen einer App

Gibt die Haupteigenschaften einer Anwendung zurück, einschließlich Anwendungsvariablen.

Abrufen einer Feldnutzung

Rufen Sie eine einzelne Feldnutzungsstatistik ab. Dies ist eine Zusammenfassung der Informationen, die in der Verwendungstabelle der Feldeigenschaften zu finden sind.

Abrufen einer Tabelle

Ruft die Eigenschaften einer einzelnen Tabelle ab, die Teil einer Anwendung ist.

Abrufen eines Berichts

Rufen Sie das Schema (Eigenschaften) eines einzelnen Berichts ab.

Abrufen eines temporären Tokens für ein DBID

Verwenden Sie diesen Endpunkt, um ein temporäres Autorisierungstoken abzurufen, das auf eine App oder eine Tabelle begrenzt ist. Sie können dieses Token dann verwenden, um andere API-Aufrufe zu tätigen (siehe Autorisierung). Dieses Token läuft in 5 Minuten ab.

Abrufen von App-Ereignissen

Rufen Sie eine Liste von Ereignissen ab, die basierend auf Daten- oder Benutzeraktionen in dieser Anwendung ausgelöst werden können, einschließlich: E-Mail-Benachrichtigung, Erinnerungen, Abonnements, QB-Aktionen, Webhooks, Datensatzänderung ausgelöste Automatisierungen (nicht geplant).

Abrufen von Feldern für eine Tabelle

Ruft die Eigenschaften für alle Felder in einer bestimmten Tabelle ab. Die Eigenschaften für jedes Feld sind identisch mit dem Feld "Get".

Abrufen von Tabellen für eine App

Ruft eine Liste aller Tabellen ab, die in einer bestimmten Anwendung vorhanden sind. Die Eigenschaften für jede Tabelle sind identisch mit dem, was in der Tabelle "Get" zurückgegeben wird.

Aktualisieren einer App

Aktualisiert die Haupteigenschaften und/oder Anwendungsvariablen für eine bestimmte Anwendung. Alle Eigenschaften der App, die Sie nicht im Anforderungstext angeben, bleiben unverändert.

Aktualisieren einer Beziehung

Verwenden Sie diesen Endpunkt, um Nachschlagefelder und Zusammenfassungsfelder zu einer vorhandenen Beziehung hinzuzufügen. Durch das Aktualisieren einer Beziehung werden vorhandene Nachschlage-/Zusammenfassungsfelder nicht gelöscht.

Aktualisieren einer Tabelle

Aktualisiert die Haupteigenschaften einer bestimmten Tabelle. Alle Eigenschaften der Tabelle, die Sie nicht im Anforderungstext angeben, bleiben unverändert.

Aktualisieren eines Felds

Aktualisiert die Eigenschaften und benutzerdefinierten Berechtigungen eines Felds. Der Versuch, bestimmte Eigenschaften zu aktualisieren, kann dazu führen, dass vorhandene Daten nicht mehr den neuen Eigenschaften des Felds gehorchen und möglicherweise abgelehnt werden. Unter den Beschreibungen der erforderlichen, eindeutigen und auswahlspezifischen Optionen finden Sie unten für bestimmte Situationen. Alle Eigenschaften des Felds, das Sie nicht im Anforderungstext angeben, bleiben unverändert.

App erstellen

Erstellt eine Anwendung in einem Konto. Sie müssen über Anwendungserstellungsrechte im jeweiligen Konto verfügen. Haupteigenschaften und Anwendungsvariablen können mit dieser API festgelegt werden.

Ausführen einer Formel

Ermöglicht das Ausführen einer Formel über einen API-Aufruf. Verwenden Sie diese Methode im benutzerdefinierten Code, um den Wert einer Formel ohne einzelnes Feld in einem Datensatz zurückzuholen.

Ausführen eines Berichts

Führt einen Bericht basierend auf einer ID aus und gibt die zugrunde liegenden Daten zurück, die ihr zugeordnet sind. Das Format der Daten variiert je nach Berichtstyp. Berichte, die sich auf Daten auf Datensatzebene (Tabelle, Kalender usw.) konzentrieren, geben die einzelnen Datensätze zurück. Aggregierte Berichte (Zusammenfassung, Diagramm) geben die zusammengefassten Informationen zurück, wie im Bericht konfiguriert. Ui-spezifische Elemente werden nicht zurückgegeben, z. B. Summen, Mittelwerte und Visualisierungen. Gibt Daten mit intelligenter Paginierung basierend auf der ungefähren Größe jedes Datensatzes zurück. Das Metadatenobjekt enthält die erforderlichen Informationen, um die Antwort zu durchlaufen und weitere Daten zu sammeln.

Beziehung löschen

Verwenden Sie diesen Endpunkt, um eine ganze Beziehung zu löschen, einschließlich aller Nachschlage- und Zusammenfassungsfelder. Das Referenzfeld in der Beziehung wird nicht gelöscht.

Deaktivieren eines Benutzertokens

Deaktiviert das authentifizierte Benutzertoken. Sobald dies erfolgt ist, muss das Benutzertoken auf der Benutzeroberfläche erneut aktiviert werden.

Eine App löschen

Löscht eine gesamte Anwendung, einschließlich aller Tabellen und Daten.

Einfügen und Aktualisieren von Datensätzen

Einfügen und/oder Aktualisieren von Datensätzen in einer Tabelle In diesem einzelnen API-Aufruf können Einfügungen und Aktualisierungen übermittelt werden. Aktualisieren kann das Schlüsselfeld in der Tabelle oder ein anderes unterstütztes eindeutiges Feld verwenden. Weitere Informationen dazu, wie jeder Feldtyp formatiert werden soll, finden Sie auf der Seite "Feldtypen ". Dieser Vorgang ermöglicht die inkrementelle Verarbeitung erfolgreicher Datensätze, auch wenn einige der Datensätze fehlschlagen.
Anmerkung: Dieser Endpunkt unterstützt eine maximale Nutzlastgröße von 10 MB.

Erstellen einer Beziehung

Erstellt eine Beziehung in einer Tabelle sowie Nachschlage-/Sammelfelder. Beziehungen können nur für Tabellen innerhalb derselben App erstellt werden.

Erstellen einer Tabelle

Erstellt eine Tabelle in einer Anwendung.

Erstellen eines Felds

Erstellt ein Feld in einer Tabelle, einschließlich der benutzerdefinierten Berechtigungen dieses Felds.

Feld abrufen

Ruft die Eigenschaften eines einzelnen Felds basierend auf der Feld-ID ab.
Eigenschaften, die für alle Feldtypen vorhanden sind, werden auf oberster Ebene zurückgegeben. Eigenschaften, die für einen bestimmten Feldtyp eindeutig sind, werden unter dem Attribut "properties" zurückgegeben. Weitere Informationen zu den Eigenschaften für jeden Feldtyp finden Sie auf der Seite "Feldtypen ".

Felder löschen

Löscht ein oder mehrere Felder in einer Tabelle, basierend auf der Feld-ID. Dadurch werden auch alle Daten oder Berechnungen in diesem Feld endgültig gelöscht.

Herunterladen einer Anlage

Lädt die Dateianlage herunter, wobei der Dateianlageinhalt im Base64-Format codiert ist. Die API-Antwort gibt den Dateinamen im Content-Disposition Header zurück. Metadaten zu Dateien können ggf. aus den Endpunkten /records und /reports abgerufen werden. Verwenden Sie diese Endpunkte, um die erforderlichen Informationen abzurufen, um Dateien abzurufen.

Klonen eines Benutzertokens

Klont das authentifizierte Benutzertoken. Alle anwendungen, die diesem Token zugeordnet sind, werden automatisch dem neuen Token zugeordnet.

Kopieren einer App

Kopiert die angegebene Anwendung. Die neue Anwendung hat das gleiche Schema wie das Original. Weitere Kopieroptionen finden Sie unten.

Löschen einer Anlage

Löscht eine Dateianlageversion. Metadaten zu Dateien können ggf. aus den Endpunkten /records und /reports abgerufen werden. Verwenden Sie diese Endpunkte, um die erforderlichen Informationen zum Löschen von Dateiversionen abzurufen.

Löschen einer Tabelle

Löscht eine bestimmte Tabelle in einer Anwendung, einschließlich aller darin enthaltenen Daten.

Löschen eines Benutzertokens

Löscht das authentifizierte Benutzertoken. Dies ist nicht umkehrbar.

Löschen von Datensätzen

Löscht Datensätze in einer Tabelle basierend auf einer Abfrage. Alternativ können alle Datensätze in der Tabelle gelöscht werden.

Abfragen von Daten

Übergeben Sie eine Abfrage in der Quickbase-Abfragesprache. Gibt Datensatzdaten mit intelligenter Paginierung basierend auf der ungefähren Größe jedes Datensatzes zurück. Das Metadatenobjekt enthält die erforderlichen Informationen, um die Antwort zu durchlaufen und weitere Daten zu sammeln.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
skip
skip integer

Die Anzahl der zu überspringenden Datensätze.

compareWithAppLocalTime
compareWithAppLocalTime boolean

Gibt an, ob die Abfrage für ein Datumszeitfeld in Bezug auf die lokale Uhrzeit der Anwendung ausgeführt werden soll. Die Abfrage wird standardmäßig mit UTC-Zeit ausgeführt.

top
top integer

Die maximale Anzahl anzuzeigender Datensätze.

where
where string

Der Filter mithilfe der Quickbase-Abfragesprache, der die zurückzugebenden Datensätze bestimmt. Wenn dieser Parameter nicht angegeben wird, gibt die Abfrage alle Datensätze zurück.

fieldId
fieldId integer

Der eindeutige Bezeichner eines Felds in einer Tabelle.

Grouping
grouping string

Gruppieren nach aufsteigender Reihenfolge (ASC), absteigender Reihenfolge (DESC) oder gleichen Werten (Gleichheitswerte)

sortBy
sortBy object

Standardmäßig werden Abfragen nach den angegebenen Sortierfeldern oder der Standardsortierung sortiert, wenn die Abfrage keines bereitstellt. Auf "false" festgelegt, um die Sortierung zu vermeiden, wenn die Reihenfolge der zurückgegebenen Daten nicht wichtig ist. Das Zurückgeben von Daten ohne Sortierung kann die Leistung verbessern.

select
select object
from
from True string

Der Tabellenbezeichner.

Gibt zurück

Abfrageantwort ausführen
runQueryResponse

Abrufen aller Beziehungen

Dient zum Abrufen einer Liste aller Beziehungen und deren Definitionen für eine bestimmte Tabelle. Details werden sowohl für die übergeordneten als auch die untergeordneten Seiten von Beziehungen innerhalb einer bestimmten Anwendung bereitgestellt. Für anwendungsübergreifende Beziehungen werden eingeschränkte Details zurückgegeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Überspringen
skip integer

Die Anzahl der zu überspringenden Beziehungen.

Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Gibt zurück

Beziehungsantwort abrufen
getRelationshipsResponse

Abrufen aller Tabellenberichte

Dient zum Abrufen des Schemas (Eigenschaften) aller Berichte für eine Tabelle. Wenn der Benutzer, der die API ausführt, ein Anwendungsadministrator ist, gibt die API auch alle persönlichen Berichte mit der Benutzer-ID des Besitzers zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner der Tabelle.

Gibt zurück

Name Pfad Typ Beschreibung
array of object
ID
id string

Der Bezeichner.

Name
name string

Der Name.

Typ
type string

Der Typ.

Description
description string

Die Beschreibung.

Besitzer-ID
ownerId string

Der Bezeichner des Besitzers.

Zuletzt verwendet
usedLast string

Wird zuletzt verwendet.

Verwendete Anzahl
usedCount integer

Die verwendete Anzahl.

Abrufen der Verwendung für alle Felder

Ruft alle Feldnutzungsstatistiken für eine Tabelle ab. Dies ist eine Zusammenfassung der Informationen, die in der Verwendungstabelle der Feldeigenschaften zu finden sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Überspringen
skip integer

Die Anzahl der Felder, die aus der Liste übersprungen werden sollen.

Nach oben
top integer

Die maximale Anzahl der zurückzugebenden Felder.

Gibt zurück

Name Pfad Typ Beschreibung
array of object
ID
field.id integer

Der Bezeichner.

Name
field.name string

Der Name.

Typ
field.type string

Der Typ.

Anzahl
usage.actions.count integer

Die Anzahl.

Anzahl
usage.appHomePages.count integer

Die Anzahl.

Anzahl
usage.defaultReports.count integer

Die Anzahl.

Anzahl
usage.exactForms.count integer

Die Anzahl.

Anzahl
usage.fields.count integer

Die Anzahl.

Anzahl
usage.forms.count integer

Die Anzahl.

Anzahl
usage.notifications.count integer

Die Anzahl.

Anzahl
usage.personalReports.count integer

Die Anzahl.

Anzahl
usage.relationships.count integer

Die Anzahl.

Anzahl
usage.reminders.count integer

Die Anzahl.

Anzahl
usage.reports.count integer

Die Anzahl.

Anzahl
usage.roles.count integer

Die Anzahl.

Anzahl
usage.webhooks.count integer

Die Anzahl.

Abrufen einer App

Gibt die Haupteigenschaften einer Anwendung zurück, einschließlich Anwendungsvariablen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der eindeutige Bezeichner einer App.

Gibt zurück

App-Antwort abrufen
getAppResponse

Abrufen einer Feldnutzung

Rufen Sie eine einzelne Feldnutzungsstatistik ab. Dies ist eine Zusammenfassung der Informationen, die in der Verwendungstabelle der Feldeigenschaften zu finden sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Feld-ID
fieldId True integer

Der eindeutige Bezeichner (FID) des Felds.

Gibt zurück

Name Pfad Typ Beschreibung
array of object
ID
field.id integer

Der Bezeichner.

Name
field.name string

Der Name.

Typ
field.type string

Der Typ.

Anzahl
usage.actions.count integer

Die Anzahl.

Anzahl
usage.appHomePages.count integer

Die Anzahl.

Anzahl
usage.defaultReports.count integer

Die Anzahl.

Anzahl
usage.exactForms.count integer

Die Anzahl.

Anzahl
usage.fields.count integer

Die Anzahl.

Anzahl
usage.forms.count integer

Die Anzahl.

Anzahl
usage.notifications.count integer

Die Anzahl.

Anzahl
usage.personalReports.count integer

Die Anzahl.

Anzahl
usage.relationships.count integer

Die Anzahl.

Anzahl
usage.reminders.count integer

Die Anzahl.

Anzahl
usage.reports.count integer

Die Anzahl.

Anzahl
usage.roles.count integer

Die Anzahl.

Anzahl
usage.webhooks.count integer

Die Anzahl.

Abrufen einer Tabelle

Ruft die Eigenschaften einer einzelnen Tabelle ab, die Teil einer Anwendung ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der eindeutige Bezeichner einer App

Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Gibt zurück

Tabellenantwort abrufen
getTableResponse

Abrufen eines Berichts

Rufen Sie das Schema (Eigenschaften) eines einzelnen Berichts ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner der Tabelle.

Berichts-ID
reportId True string

Der Bezeichner des Berichts, der für die Tabelle eindeutig ist.

Gibt zurück

Berichtsantwort abrufen
getReportResponse

Abrufen eines temporären Tokens für ein DBID

Verwenden Sie diesen Endpunkt, um ein temporäres Autorisierungstoken abzurufen, das auf eine App oder eine Tabelle begrenzt ist. Sie können dieses Token dann verwenden, um andere API-Aufrufe zu tätigen (siehe Autorisierung). Dieses Token läuft in 5 Minuten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-Token
QB-App-Token string

Ihr Quickbase-App-Token

DBID
dbid True string

Der eindeutige Bezeichner einer App oder Tabelle.

Gibt zurück

getTempTokenDBIDResponse
getTempTokenDBIDResponse

Abrufen von App-Ereignissen

Rufen Sie eine Liste von Ereignissen ab, die basierend auf Daten- oder Benutzeraktionen in dieser Anwendung ausgelöst werden können, einschließlich: E-Mail-Benachrichtigung, Erinnerungen, Abonnements, QB-Aktionen, Webhooks, Datensatzänderung ausgelöste Automatisierungen (nicht geplant).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der eindeutige Bezeichner einer App.

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Typ
type string

Der Typ.

Email
owner.email string

Die E-Mail-Adresse des Besitzers.

ID
owner.id string

Der Bezeichner des Besitzers.

Name
owner.name string

Der Name des Besitzers.

Benutzername
owner.userName string

Der Benutzername des Besitzers.

Ist aktiv
isActive boolean

Gibt an, ob aktiv ist.

Tabellenkennung (ID)
tableId string

Der Bezeichner der Tabelle.

Name
name string

Der Name.

URL
url string

Die URL-Adresse.

Abrufen von Feldern für eine Tabelle

Ruft die Eigenschaften für alle Felder in einer bestimmten Tabelle ab. Die Eigenschaften für jedes Feld sind identisch mit dem Feld "Get".

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Feldberechtigungen einschließen
includeFieldPerms boolean

Legen Sie diesen Wert auf "true" fest, wenn Sie die benutzerdefinierten Berechtigungen für die Felder(n) zurückholen möchten.

Gibt zurück

Name Pfad Typ Beschreibung
array of object
ID
id integer

Der Bezeichner.

Etikett
label string

Die Bezeichnung.

Feldtyp
fieldType string

Der Feldtyp.

Kein Umbruch
noWrap boolean

Gibt an, ob kein Umbruch vorhanden ist.

Bold
bold boolean

Ob fett formatiert.

Erforderlich
required boolean

Gibt an, ob erforderlich.

Standardmäßig angezeigt
appearsByDefault boolean

Gibt an, ob standardmäßig angezeigt wird.

Aktivierte Suche
findEnabled boolean

Gibt an, ob die Suche aktiviert ist.

Einzigartig
unique boolean

Gibt an, ob eindeutig.

Datenkopie
doesDataCopy boolean

Gibt an, ob Daten kopiert werden.

Feldhilfe
fieldHelp string

Die Feldhilfe.

Auditiert
audited boolean

Gibt an, ob überwacht wird.

Primärschlüssel
properties.primaryKey boolean

Gibt an, ob der Primärschlüssel.

Fremdschlüssel
properties.foreignKey boolean

Gibt an, ob der Fremdschlüssel.

Zahlenzeilen
properties.numLines integer

Die Anzahl der Zeilen.

Max. Länge
properties.maxLength integer

Die maximale Länge.

Nur anfügen
properties.appendOnly boolean

Gibt an, ob nur angefügt wird.

allowHTML
properties.allowHTML boolean

Gibt an, ob HTML zulässig ist.

Sortieren nach Gegebener Angabe
properties.sortAsGiven boolean

Gibt an, ob die Sortierung angegeben ist.

Auswahlmöglichkeiten tragen
properties.carryChoices boolean

Ob Wahlmöglichkeiten zu tragen sind.

Neue Auswahlmöglichkeiten zulassen
properties.allowNewChoices boolean

Gibt an, ob neue Optionen zulässig sind.

Formula
properties.formula string

Die Formel.

Standardwert
properties.defaultValue string

Der Standardwert.

Zahlenformat
properties.numberFormat integer

Das Zahlenformat.

Dezimalstellen
properties.decimalPlaces integer

Die Dezimalstellen.

Durchschnittliche Funktion
properties.doesAverage boolean

Gibt an, ob der Mittelwert erfolgt.

Gesamtsumme
properties.doesTotal boolean

Gibt an, ob die Summe erfolgt.

Leer ist Null
properties.blankIsZero boolean

Gibt an, ob leer ist.

Erlaubnisse
permissions array of object
Berechtigungstyp
permissions.permissionType string

Der Berechtigungstyp.

Rolle
permissions.role string

Die Rolle.

Rollen-ID
permissions.roleId integer

Der Bezeichner der Rolle.

Zu Formularen hinzufügen
addToForms boolean

Gibt an, ob Formularen hinzugefügt werden sollen.

Abrufen von Tabellen für eine App

Ruft eine Liste aller Tabellen ab, die in einer bestimmten Anwendung vorhanden sind. Die Eigenschaften für jede Tabelle sind identisch mit dem, was in der Tabelle "Get" zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der eindeutige Bezeichner einer App

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Name
name string

Der Name.

Erstellt
created string

Beim Erstellen.

Updated
updated string

Wenn aktualisiert.

Alias
alias string

Der Alias.

Description
description string

Die Beschreibung.

ID
id string

Der Bezeichner.

Nächste Datensatz-ID
nextRecordId integer

Der Bezeichner des nächsten Datensatzes.

Nächste Feld-ID
nextFieldId integer

Der Bezeichner des nächsten Felds.

Standardsortierfeld-ID
defaultSortFieldId integer

Der Bezeichner des Standardsortierfelds.

Standardsortierreihenfolge
defaultSortOrder string

Die Standardsortierreihenfolge.

Schlüsselfeld-ID
keyFieldId integer

Der Bezeichner des Schlüsselfelds.

Name eines einzelnen Datensatzes
singleRecordName string

Der Name des einzelnen Datensatzes.

Plural-Datensatzname
pluralRecordName string

Der Name des pluralen Datensatzes.

Größenbeschränkung
sizeLimit string

Die Größenbeschränkung.

Verwendeter Raum
spaceUsed string

Der verwendete Platz.

Verbleibender Speicherplatz
spaceRemaining string

Der verbleibende Platz.

Aktualisieren einer App

Aktualisiert die Haupteigenschaften und/oder Anwendungsvariablen für eine bestimmte Anwendung. Alle Eigenschaften der App, die Sie nicht im Anforderungstext angeben, bleiben unverändert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
name
name True string

Der Name für die Variable.

value
value True string

Der Wert für die Variable.

name
name string

Der Name für die App.

Beschreibung
description string

Die Beschreibung für die App.

App-ID
appId True string

Der eindeutige Bezeichner einer App.

Gibt zurück

App-Antwort aktualisieren
updateAppResponse

Aktualisieren einer Beziehung

Verwenden Sie diesen Endpunkt, um Nachschlagefelder und Zusammenfassungsfelder zu einer vorhandenen Beziehung hinzuzufügen. Durch das Aktualisieren einer Beziehung werden vorhandene Nachschlage-/Zusammenfassungsfelder nicht gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
summaryFid
summaryFid double

Die feld-ID, die zusammengefasst werden soll.

label
label string

Die Beschriftung für das Zusammenfassungsfeld.

AccumulationType
accumulationType True string

Der Akkumulationstyp für das Zusammenfassungsfeld.

where
where string

Der Filter mithilfe der Quickbase-Abfragesprache, der die zurückzugebenden Datensätze bestimmt.

lookupFieldIds
lookupFieldIds array of integer

Ein Array von Feld-IDs in der übergeordneten Tabelle, die Nachschlagefelder in der untergeordneten Tabelle werden.

Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle. Dies ist die untergeordnete Tabelle.

Beziehungs-ID
relationshipId True double

Die Beziehungs-ID. Dies ist die Feld-ID des Referenzfelds in der untergeordneten Tabelle.

Gibt zurück

Beziehungsantwort aktualisieren
updateRelationshipResponse

Aktualisieren einer Tabelle

Aktualisiert die Haupteigenschaften einer bestimmten Tabelle. Alle Eigenschaften der Tabelle, die Sie nicht im Anforderungstext angeben, bleiben unverändert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der eindeutige Bezeichner einer App

name
name string

Der Name für die Tabelle.

pluralRecordName
pluralRecordName string

Das Plural-Substantiv für Datensätze in der Tabelle. Wenn dieser Wert nicht übergeben wird, lautet der Standardwert "Records".

singleRecordName
singleRecordName string

Das Singular-Substantiv für Datensätze in der Tabelle. Wenn dieser Wert nicht übergeben wird, lautet der Standardwert "Record".

Beschreibung
description string

Die Beschreibung für die Tabelle. Wenn dieser Wert nicht übergeben wird, ist der Standardwert leer.

Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Gibt zurück

Aktualisieren der Tabellenantwort
updateTableResponse

Aktualisieren eines Felds

Aktualisiert die Eigenschaften und benutzerdefinierten Berechtigungen eines Felds. Der Versuch, bestimmte Eigenschaften zu aktualisieren, kann dazu führen, dass vorhandene Daten nicht mehr den neuen Eigenschaften des Felds gehorchen und möglicherweise abgelehnt werden. Unter den Beschreibungen der erforderlichen, eindeutigen und auswahlspezifischen Optionen finden Sie unten für bestimmte Situationen. Alle Eigenschaften des Felds, das Sie nicht im Anforderungstext angeben, bleiben unverändert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner der Tabelle.

auditiert
audited boolean

Gibt an, ob das Feld als Teil von Quickbase-Überwachungsprotokollen nachverfolgt wird. Sie können diese Eigenschaft nur auf "true" festlegen, wenn die App Überwachungsprotokolle aktiviert hat. Siehe "Aktivieren von Datenänderungsprotokollen" unter "Schnellbasisüberwachungsprotokolle".

fieldHelp
fieldHelp string

Der konfigurierte Hilfetext, der Benutzern innerhalb des Produkts angezeigt wird.

fett
bold boolean

Gibt an, ob das Feld so konfiguriert ist, dass es fett im Produkt angezeigt wird.

required
required boolean

Gibt an, ob das Feld erforderlich ist (d. h., wenn jeder Datensatz einen Wert ungleich NULL in diesem Feld aufweisen muss). Wenn Sie versuchen, ein Feld von "nicht erforderlich" in "erforderlich" zu ändern, und die Tabelle enthält derzeit Datensätze mit Nullwerten in diesem Feld, wird ein Fehler angezeigt, der angibt, dass es Nullwerte des Felds gibt. In diesem Fall müssen Sie diese Datensätze mit NULL-Werten des Felds suchen und aktualisieren, bevor Sie das Feld in erforderlich ändern.

comments
comments string

Die Kommentare, die von einem Administrator in die Feldeigenschaften eingegeben wurden.

doesTotal
doesTotal boolean

Gibt an, ob dieses Feld in Berichten innerhalb des Produkts summet.

AutoSpeichern
autoSave boolean

Gibt an, ob das Verknüpfungsfeld automatisch gespeichert wird.

defaultValueLuid
defaultValueLuid integer

Standardbenutzer-ID-Wert.

maxVersions
maxVersions integer

Die maximale Anzahl von Versionen, die für eine Dateianlage konfiguriert sind.

format
format integer

Das Format zum Anzeigen der Zeit.

carryChoices
carryChoices boolean

Gibt an, ob das Feld seine Mehrfachauswahlfelder beim Kopieren tragen soll.

Maximale Länge
maxLength integer

Die maximale Anzahl von Zeichen, die für die Eingabe in der Schnellbasis für dieses Feld zulässig sind.

linkText
linkText string

Der konfigurierte Textwert, der die URL ersetzt, die Benutzer im Produkt sehen.

parentFieldId
parentFieldId integer

Die ID des übergeordneten zusammengesetzten Felds, falls zutreffend.

displayTimezone
displayTimezone boolean

Gibt an, ob die Zeitzone innerhalb des Produkts angezeigt werden soll.

summaryTargetFieldId
summaryTargetFieldId integer

Die ID des Felds, das verwendet wird, um Werte aus dem untergeordneten Element zu aggregieren, falls zutreffend. Dadurch wird 0 angezeigt, wenn für die Zusammenfassungsfunktion keine Feldauswahl erforderlich ist (z. B. Anzahl).

allowNewChoices
allowNewChoices boolean

Gibt an, ob Benutzer einer Auswahlliste neue Auswahlmöglichkeiten hinzufügen können.

defaultToday
defaultToday boolean

Gibt an, ob der Feldwert heute für neue Datensätze standardmäßig ist.

Einheiten
units string

Die Einheitenbezeichnung.

lookupTargetFieldId
lookupTargetFieldId integer

Die ID des Felds, das das Ziel in der übergeordneten Tabelle für diese Suche ist.

SummaryFunction3
summaryFunction string

Der Akkumulationstyp für das Zusammenfassungsfeld.

sourceFieldId
sourceFieldId integer

Die ID des Quellfelds.

doesAverage
doesAverage boolean

Gibt an, ob dieses Feld in Berichten innerhalb des Produkts mittelwertt.

Formel
formula string

Die Formel des Felds, wie in der Schnellbasis konfiguriert.

Dezimalstellen
decimalPlaces integer

Die Anzahl der dezimalen Stellen, die im Produkt für dieses Feld angezeigt werden.

displayMonth
displayMonth string

Anzeigen von Monaten

seeVersions
seeVersions boolean

Gibt an, ob der Benutzer neben der neuesten Version einer Dateianlage innerhalb des Produkts andere Versionen sehen kann.

numLines
numLines integer

Die Anzahl der Zeilen, die in der Schnellbasis für dieses Textfeld angezeigt werden.

defaultKind
defaultKind string

Der Standardtyp des Benutzers.

displayEmail
displayEmail string

Wie die E-Mail angezeigt wird.

coverText
coverText string

Ein alternativer benutzerfreundlicher Text, der zum Anzeigen eines Links im Browser verwendet werden kann.

currencySymbol
currencySymbol string

Das aktuelle Symbol, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

summaryQuery
summaryQuery string

Die Zusammenfassungsabfrage.

targetFieldId
targetFieldId integer

Die ID des Zielfelds.

displayUser
displayUser string

Die konfigurierte Option für die Anzeige von Benutzern innerhalb des Produkts.

blankIsZero
blankIsZero boolean

Gibt an, ob ein leerer Wert in Berechnungen innerhalb des Produkts gleich 0 behandelt wird.

genau
exact boolean

Gibt an, ob für einen Berichtslink eine genaue Übereinstimmung erforderlich ist.

defaultDomain
defaultDomain string

Standard-E-Mail-Domäne.

defaultValue
defaultValue string

Der Standardwert, der für ein Feld konfiguriert ist, wenn ein neuer Datensatz hinzugefügt wird.

abkürzen
abbreviate boolean

Zeigen Sie das URL-Protokoll nicht an, wenn die URL angezeigt wird.

Zahlenformat
numberFormat integer

Das Format, das zum Anzeigen numerischer Werte im Produkt verwendet wird (Dezimalzeichen, Trennzeichen, Zifferngruppe).

targetTableName
targetTableName string

Der Zieltabellenname des Felds.

appearsAs
appearsAs string

Wenn er leer ist, wird die URL als Linktext verwendet.

width
width integer

Die HTML-Eingabebreite des Felds im Produkt.

CurrencyFormat
currencyFormat string

Das Währungsformat, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

displayImages
displayImages boolean

Gibt an, ob Bilder für Dateianlagen in Formularen und Berichten innerhalb des Produkts angezeigt werden.

displayDayOfWeek
displayDayOfWeek boolean

Gibt an, ob der Wochentag innerhalb des Produkts angezeigt werden soll.

summaryReferenceFieldId
summaryReferenceFieldId integer

Die ID des Felds, das der Verweis in der Beziehung für diese Zusammenfassung ist.

kommmaStart
commaStart integer

Die Anzahl der Ziffern, bevor Kommas im Produkt angezeigt werden, falls zutreffend.

Optionen
choices array of string

Ein Array von Einträgen, die für ein Feld vorhanden sind, das dem Benutzer Auswahlmöglichkeiten bietet. Beachten Sie, dass diese Auswahl auf die gültigen Werte aller in Zukunft hinzugefügten Datensätze verweist. Sie dürfen Werte aus der Auswahlliste entfernen, auch wenn in diesem Feld Datensätze mit diesen Werten vorhanden sind. Sie werden rot angezeigt, wenn Benutzer die Daten im Browser betrachten, aber es gibt keinen anderen Effekt. Beim Aktualisieren eines Felds mit dieser Eigenschaft werden die alten Auswahlmöglichkeiten entfernt und durch die neuen Optionen ersetzt.

targetTableId
targetTableId string

Die ID der Zieltabelle.

displayRelative
displayRelative boolean

Gibt an, ob die Zeit relativ angezeigt werden soll.

compositeFields
compositeFields object
summaryTableId
summaryTableId string

In der Tabelle verweist das Zusammenfassungsfeld auf Felder.

displayTime
displayTime boolean

Gibt an, ob die Uhrzeit zusätzlich zum Datum angezeigt werden soll.

VersionMode
versionMode string

Versionsmodi für Dateien. Behalten Sie alle Versionen bei, und behalten Sie die letzte Version bei.

snapFieldId
snapFieldId integer

Die ID des Felds, das bei Bedarf für Momentaufnahmenwerte verwendet wird.

Stunden24
hours24 boolean

Gibt an, ob die Zeit im 24-Stunden-Format innerhalb des Produkts angezeigt werden soll.

sortAlpha
sortAlpha boolean

Ob alphabetisch sortiert werden soll, ist die Standardsortierung nach Datensatz-ID.

sortAsGiven
sortAsGiven boolean

Gibt an, ob die aufgelisteten Einträge wie eingegeben oder alphabetisch sortiert werden.

hasExtension
hasExtension boolean

Gibt an, ob dieses Feld über eine Telefonerweiterung verfügt.

useNewWindow
useNewWindow boolean

Gibt an, ob die URL ein neues Fenster öffnen soll, wenn ein Benutzer innerhalb des Produkts darauf klickt.

appendOnly
appendOnly boolean

Gibt an, ob dieses Feld nur angefügt wird.

displayAsLink
displayAsLink boolean

Gibt an, ob ein Feld, das Teil der Beziehung ist, als Link zum übergeordneten Datensatz innerhalb des Produkts angezeigt werden soll.

lookupReferenceFieldId
lookupReferenceFieldId integer

Die ID des Felds, das der Verweis in der Beziehung für diese Suche ist.

appearsByDefault
appearsByDefault boolean

Gibt an, ob das Feld in Berichten als Standard markiert ist.

einzigartig
unique boolean

Gibt an, ob jeder Datensatz in der Tabelle einen eindeutigen Wert dieses Felds enthalten muss. Wenn Sie versuchen, ein Feld von "nicht eindeutig" in "eindeutig" zu ändern, und die Tabelle enthält derzeit Datensätze mit demselben Wert dieses Felds, wird ein Fehler angezeigt. In diesem Fall müssen Sie diese Datensätze mit doppelten Werten des Felds suchen und aktualisieren, bevor Sie das Feld in "eindeutig" ändern.

role
role string

Die Rolle, die einer bestimmten Berechtigung für das Feld zugeordnet ist

permissionType
permissionType string

Die Berechtigung, die der Rolle für dieses Feld erteilt wurde

Rollen-ID
roleId integer

Die ID der angegebenen Rolle

addToForms
addToForms boolean

Gibt an, ob das feld, das Sie hinzufügen, in Formularen angezeigt werden soll.

label
label string

Die Bezeichnung (Name) des Felds.

findEnabled
findEnabled boolean

Gibt an, ob das Feld als durchsuchbar markiert ist.

noWrap
noWrap boolean

Gibt an, ob das Feld so konfiguriert ist, dass es nicht umbrochen wird, wenn es im Produkt angezeigt wird.

Feld-ID
fieldId True integer

Der eindeutige Bezeichner (FID) des Felds.

Gibt zurück

Feldantwort aktualisieren
updateFieldResponse

App erstellen

Erstellt eine Anwendung in einem Konto. Sie müssen über Anwendungserstellungsrechte im jeweiligen Konto verfügen. Haupteigenschaften und Anwendungsvariablen können mit dieser API festgelegt werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
assignToken
assignToken boolean

Legen Sie diesen Wert auf "true" fest, wenn Sie die App dem Benutzertoken zuweisen möchten, das Sie zum Erstellen der Anwendung verwendet haben. Der Standardwert ist "false".

name
name True string

Der Name für die Variable.

value
value True string

Der Wert für die Variable.

name
name True string

Der App-Name. Sie dürfen mehrere Apps mit demselben Namen im selben Bereich erstellen, da sie unterschiedlicheBidwerte aufweisen. Wir fordern Sie nachdrücklich auf, dies zu tun.

Beschreibung
description string

Die Beschreibung für die App. Wenn diese Eigenschaft ausgelassen wird, ist die App-Beschreibung leer.

Gibt zurück

App-Antwort erstellen
createAppResponse

Ausführen einer Formel

Ermöglicht das Ausführen einer Formel über einen API-Aufruf. Verwenden Sie diese Methode im benutzerdefinierten Code, um den Wert einer Formel ohne einzelnes Feld in einem Datensatz zurückzuholen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Formel
formula True string

Die auszuführende Formel. Dies muss eine gültige Schnellbasisformel sein.

los
rid integer

Die Datensatz-ID, für die die Formel ausgeführt werden soll. Nur für Formeln erforderlich, die im Kontext eines Datensatzes ausgeführt werden. Beispielsweise benötigt die Formel "User()" keine Datensatz-ID.

from
from True string

Der eindeutige Bezeichner (dbid) der Tabelle.

Gibt zurück

Formelantwort ausführen
runFormulaResponse

Ausführen eines Berichts

Führt einen Bericht basierend auf einer ID aus und gibt die zugrunde liegenden Daten zurück, die ihr zugeordnet sind. Das Format der Daten variiert je nach Berichtstyp. Berichte, die sich auf Daten auf Datensatzebene (Tabelle, Kalender usw.) konzentrieren, geben die einzelnen Datensätze zurück. Aggregierte Berichte (Zusammenfassung, Diagramm) geben die zusammengefassten Informationen zurück, wie im Bericht konfiguriert. Ui-spezifische Elemente werden nicht zurückgegeben, z. B. Summen, Mittelwerte und Visualisierungen. Gibt Daten mit intelligenter Paginierung basierend auf der ungefähren Größe jedes Datensatzes zurück. Das Metadatenobjekt enthält die erforderlichen Informationen, um die Antwort zu durchlaufen und weitere Daten zu sammeln.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der Bezeichner der Tabelle für den Bericht.

Überspringen
skip integer

Die Anzahl der zu überspringenden Datensätze. Sie können diesen Wert festlegen, wenn Sie eine Reihe von Ergebnissen durchlaufen.

Nach oben
top integer

Die maximale Anzahl der zurückzugebenden Datensätze. Sie können die Standardmäßige Quickbase-Paginierung außer Kraft setzen, um mehr oder weniger Ergebnisse zu erhalten. Wenn Ihr angeforderter Wert hier die dynamischen Höchstwerte überschreitet, geben wir eine Teilmenge der Ergebnisse zurück, und der Rest kann in nachfolgenden API-Aufrufen erfasst werden.

object
Berichts-ID
reportId True string

Der Bezeichner des Berichts, der für die Tabelle eindeutig ist.

Gibt zurück

Berichtsantwort ausführen
runReportResponse

Beziehung löschen

Verwenden Sie diesen Endpunkt, um eine ganze Beziehung zu löschen, einschließlich aller Nachschlage- und Zusammenfassungsfelder. Das Referenzfeld in der Beziehung wird nicht gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle. Dies ist die untergeordnete Tabelle.

Beziehungs-ID
relationshipId True double

Die Beziehungs-ID. Dies ist die Feld-ID des Referenzfelds in der untergeordneten Tabelle.

Gibt zurück

Beziehungsantwort löschen
deleteRelationshipResponse

Deaktivieren eines Benutzertokens

Deaktiviert das authentifizierte Benutzertoken. Sobald dies erfolgt ist, muss das Benutzertoken auf der Benutzeroberfläche erneut aktiviert werden.

Gibt zurück

Name Pfad Typ Beschreibung
id
id integer

id

Eine App löschen

Löscht eine gesamte Anwendung, einschließlich aller Tabellen und Daten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
name
name True string

Um den Anwendungslöschvorgang zu bestätigen, fordern wir den Anwendungsnamen an.

App-ID
appId True string

Der eindeutige Bezeichner einer App.

Gibt zurück

App-Antwort löschen
deleteAppResponse

Einfügen und Aktualisieren von Datensätzen

Einfügen und/oder Aktualisieren von Datensätzen in einer Tabelle In diesem einzelnen API-Aufruf können Einfügungen und Aktualisierungen übermittelt werden. Aktualisieren kann das Schlüsselfeld in der Tabelle oder ein anderes unterstütztes eindeutiges Feld verwenden. Weitere Informationen dazu, wie jeder Feldtyp formatiert werden soll, finden Sie auf der Seite "Feldtypen ". Dieser Vorgang ermöglicht die inkrementelle Verarbeitung erfolgreicher Datensätze, auch wenn einige der Datensätze fehlschlagen.
Anmerkung: Dieser Endpunkt unterstützt eine maximale Nutzlastgröße von 10 MB.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
zu
to True string

Der Tabellenbezeichner.

Daten
data object
mergeFieldId
mergeFieldId integer

Die Seriendruckfeld-ID.

fieldsToReturn
fieldsToReturn array of integer

Geben Sie ein Array von Feld-IDs an, das Daten für aktualisierungen oder hinzugefügten Datensatz zurückgibt. Die Datensatz-ID (FID 3) wird immer zurückgegeben, wenn eine Feld-ID angefordert wird.

Gibt zurück

Eine erfolgreiche Antwort, die Details zu den hinzugefügten, aktualisierten oder unveränderten Datensätzen enthält. Im folgenden Beispiel hatte die Tabelle zuvor zehn Datensätze mit IDs von 1 bis 10. Der Benutzer veröffentlicht einen Upsert, der den Wert von Datensatz 1 aktualisiert und zwei neue Datensätze hinzufügt, alle erfolgreich.

Upsert-Antwort
upsertResponse

Erstellen einer Beziehung

Erstellt eine Beziehung in einer Tabelle sowie Nachschlage-/Sammelfelder. Beziehungen können nur für Tabellen innerhalb derselben App erstellt werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
summaryFid
summaryFid double

Die feld-ID, die zusammengefasst werden soll.

label
label string

Die Beschriftung für das Zusammenfassungsfeld.

AccumulationType
accumulationType True string

Der Akkumulationstyp für das Zusammenfassungsfeld.

where
where string

Der Filter mithilfe der Quickbase-Abfragesprache, der die zurückzugebenden Datensätze bestimmt.

lookupFieldIds
lookupFieldIds array of integer

Array von Feld-IDs in der übergeordneten Tabelle, die Nachschlagefelder in der untergeordneten Tabelle werden.

parentTableId
parentTableId True string

Die übergeordnete Tabellen-ID für die Beziehung.

label
label string

Die Bezeichnung für das Fremdschlüsselfeld.

Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle. Dies ist die untergeordnete Tabelle.

Gibt zurück

Beziehungsantwort erstellen
createRelationshipResponse

Erstellen einer Tabelle

Erstellt eine Tabelle in einer Anwendung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der eindeutige Bezeichner einer App

name
name True string

Der Name für die Tabelle.

pluralRecordName
pluralRecordName string

Das Plural-Substantiv für Datensätze in der Tabelle. Wenn dieser Wert nicht übergeben wird, lautet der Standardwert "Records".

singleRecordName
singleRecordName string

Das Singular-Substantiv für Datensätze in der Tabelle. Wenn dieser Wert nicht übergeben wird, lautet der Standardwert "Record".

Beschreibung
description string

Die Beschreibung für die Tabelle. Wenn dieser Wert nicht übergeben wird, ist der Standardwert leer.

Gibt zurück

Tabellenantwort erstellen
createTableResponse

Erstellen eines Felds

Erstellt ein Feld in einer Tabelle, einschließlich der benutzerdefinierten Berechtigungen dieses Felds.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner der Tabelle.

auditiert
audited boolean

Gibt an, ob das Feld als Teil von Quickbase-Überwachungsprotokollen nachverfolgt wird. Sie können diese Eigenschaft nur auf "true" festlegen, wenn die App Überwachungsprotokolle aktiviert hat. Siehe "Aktivieren von Datenänderungsprotokollen" unter "Schnellbasisüberwachungsprotokolle".

fieldHelp
fieldHelp string

Der konfigurierte Hilfetext, der Benutzern innerhalb des Produkts angezeigt wird.

fett
bold boolean

Gibt an, ob das Feld so konfiguriert ist, dass es fett im Produkt angezeigt wird.

comments
comments string

Die Kommentare, die von einem Administrator in die Feldeigenschaften eingegeben wurden.

doesTotal
doesTotal boolean

Gibt an, ob dieses Feld in Berichten innerhalb des Produkts summet.

AutoSpeichern
autoSave boolean

Gibt an, ob das Verknüpfungsfeld automatisch gespeichert wird.

defaultValueLuid
defaultValueLuid integer

Standardbenutzer-ID-Wert.

maxVersions
maxVersions integer

Die maximale Anzahl von Versionen, die für eine Dateianlage konfiguriert sind.

format
format integer

Das Format zum Anzeigen der Zeit.

carryChoices
carryChoices boolean

Gibt an, ob das Feld seine Mehrfachauswahlfelder beim Kopieren tragen soll.

Maximale Länge
maxLength integer

Die maximale Anzahl von Zeichen, die für die Eingabe in der Schnellbasis für dieses Feld zulässig sind.

linkText
linkText string

Der konfigurierte Textwert, der die URL ersetzt, die Benutzer im Produkt sehen.

parentFieldId
parentFieldId integer

Die ID des übergeordneten zusammengesetzten Felds, falls zutreffend.

displayTimezone
displayTimezone boolean

Gibt an, ob die Zeitzone innerhalb des Produkts angezeigt werden soll.

allowNewChoices
allowNewChoices boolean

Gibt an, ob Benutzer einer Auswahlliste neue Auswahlmöglichkeiten hinzufügen können.

defaultToday
defaultToday boolean

Gibt an, ob der Feldwert heute für neue Datensätze standardmäßig ist.

Einheiten
units string

Die Einheitenbezeichnung.

sourceFieldId
sourceFieldId integer

Die ID des Quellfelds.

doesAverage
doesAverage boolean

Gibt an, ob dieses Feld in Berichten innerhalb des Produkts mittelwertt.

Formel
formula string

Die Formel des Felds, wie in der Schnellbasis konfiguriert.

Dezimalstellen
decimalPlaces integer

Die Anzahl der dezimalen Stellen, die im Produkt für dieses Feld angezeigt werden.

displayMonth
displayMonth string

Anzeigen von Monaten

seeVersions
seeVersions boolean

Gibt an, ob der Benutzer neben der neuesten Version einer Dateianlage innerhalb des Produkts andere Versionen sehen kann.

numLines
numLines integer

Die Anzahl der Zeilen, die in der Schnellbasis für dieses Textfeld angezeigt werden.

defaultKind
defaultKind string

Der Standardtyp des Benutzers.

displayEmail
displayEmail string

Wie die E-Mail angezeigt wird.

coverText
coverText string

Ein alternativer benutzerfreundlicher Text, der zum Anzeigen eines Links im Browser verwendet werden kann.

currencySymbol
currencySymbol string

Das aktuelle Symbol, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

targetFieldId
targetFieldId integer

Die ID des Zielfelds.

displayUser
displayUser string

Die konfigurierte Option für die Anzeige von Benutzern innerhalb des Produkts.

blankIsZero
blankIsZero boolean

Gibt an, ob ein leerer Wert in Berechnungen innerhalb des Produkts gleich 0 behandelt wird.

genau
exact boolean

Gibt an, ob für einen Berichtslink eine genaue Übereinstimmung erforderlich ist.

defaultDomain
defaultDomain string

Standard-E-Mail-Domäne.

defaultValue
defaultValue string

Der Standardwert, der für ein Feld konfiguriert ist, wenn ein neuer Datensatz hinzugefügt wird.

abkürzen
abbreviate boolean

Zeigen Sie das URL-Protokoll nicht an, wenn die URL angezeigt wird.

Zahlenformat
numberFormat integer

Das Format, das zum Anzeigen numerischer Werte im Produkt verwendet wird (Dezimalzeichen, Trennzeichen, Zifferngruppe).

targetTableName
targetTableName string

Der Zieltabellenname des Felds.

appearsAs
appearsAs string

Wenn er leer ist, wird die URL als Linktext verwendet.

width
width integer

Die HTML-Eingabebreite des Felds im Produkt.

CurrencyFormat
currencyFormat string

Das Währungsformat, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

displayImages
displayImages boolean

Gibt an, ob Bilder für Dateianlagen in Formularen und Berichten innerhalb des Produkts angezeigt werden.

displayDayOfWeek
displayDayOfWeek boolean

Gibt an, ob der Wochentag innerhalb des Produkts angezeigt werden soll.

kommmaStart
commaStart integer

Die Anzahl der Ziffern, bevor Kommas im Produkt angezeigt werden, falls zutreffend.

Optionen
choices array of string

Ein Array von Einträgen, die für ein Feld vorhanden sind, das dem Benutzer Auswahlmöglichkeiten bietet. Beachten Sie, dass diese Auswahl auf die gültigen Werte aller in Zukunft hinzugefügten Datensätze verweist. Sie dürfen Werte aus der Auswahlliste entfernen, auch wenn in diesem Feld Datensätze mit diesen Werten vorhanden sind. Sie werden rot angezeigt, wenn Benutzer die Daten im Browser betrachten, aber es gibt keinen anderen Effekt. Beim Aktualisieren eines Felds mit dieser Eigenschaft werden die alten Auswahlmöglichkeiten entfernt und durch die neuen Optionen ersetzt.

targetTableId
targetTableId string

Die ID der Zieltabelle.

displayRelative
displayRelative boolean

Gibt an, ob die Zeit relativ angezeigt werden soll.

compositeFields
compositeFields object
displayTime
displayTime boolean

Gibt an, ob die Uhrzeit zusätzlich zum Datum angezeigt werden soll.

VersionMode
versionMode string

Versionsmodi für Dateien. Behalten Sie alle Versionen bei, und behalten Sie die letzte Version bei.

snapFieldId
snapFieldId integer

Die ID des Felds, das bei Bedarf für Momentaufnahmenwerte verwendet wird.

Stunden24
hours24 boolean

Gibt an, ob die Zeit im 24-Stunden-Format innerhalb des Produkts angezeigt werden soll.

sortAlpha
sortAlpha boolean

Ob alphabetisch sortiert werden soll, ist die Standardsortierung nach Datensatz-ID.

sortAsGiven
sortAsGiven boolean

Gibt an, ob die aufgelisteten Einträge wie eingegeben oder alphabetisch sortiert werden.

hasExtension
hasExtension boolean

Gibt an, ob dieses Feld über eine Telefonerweiterung verfügt.

useNewWindow
useNewWindow boolean

Gibt an, ob die URL ein neues Fenster öffnen soll, wenn ein Benutzer innerhalb des Produkts darauf klickt.

appendOnly
appendOnly boolean

Gibt an, ob dieses Feld nur angefügt wird.

displayAsLink
displayAsLink boolean

Gibt an, ob ein Feld, das Teil der Beziehung ist, als Link zum übergeordneten Datensatz innerhalb des Produkts angezeigt werden soll.

appearsByDefault
appearsByDefault boolean

Gibt an, ob das Feld in Berichten als Standard markiert ist.

FieldType2
fieldType True string

Klicken Sie auf eine der Feldtyplinks, um weitere Informationen zu erhalten.

role
role string

Die Rolle, die einer bestimmten Berechtigung für das Feld zugeordnet ist

permissionType
permissionType string

Die Berechtigung, die der Rolle für dieses Feld erteilt wurde

Rollen-ID
roleId integer

Die ID der angegebenen Rolle

addToForms
addToForms boolean

Gibt an, ob das feld, das Sie hinzufügen, in Formularen angezeigt werden soll.

label
label True string

Die Bezeichnung (Name) des Felds.

findEnabled
findEnabled boolean

Gibt an, ob das Feld als durchsuchbar markiert ist.

noWrap
noWrap boolean

Gibt an, ob das Feld so konfiguriert ist, dass es nicht umbrochen wird, wenn es im Produkt angezeigt wird.

Gibt zurück

Feldantwort erstellen
createFieldResponse

Feld abrufen

Ruft die Eigenschaften eines einzelnen Felds basierend auf der Feld-ID ab.
Eigenschaften, die für alle Feldtypen vorhanden sind, werden auf oberster Ebene zurückgegeben. Eigenschaften, die für einen bestimmten Feldtyp eindeutig sind, werden unter dem Attribut "properties" zurückgegeben. Weitere Informationen zu den Eigenschaften für jeden Feldtyp finden Sie auf der Seite "Feldtypen ".

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Feldberechtigungen einschließen
includeFieldPerms boolean

Legen Sie diesen Wert auf "true" fest, wenn Sie die benutzerdefinierten Berechtigungen für die Felder(n) zurückholen möchten.

Feld-ID
fieldId True integer

Der eindeutige Bezeichner (FID) des Felds.

Gibt zurück

Feldantwort abrufen
getFieldResponse

Felder löschen

Löscht ein oder mehrere Felder in einer Tabelle, basierend auf der Feld-ID. Dadurch werden auch alle Daten oder Berechnungen in diesem Feld endgültig gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner der Tabelle.

fieldIds
fieldIds True array of integer

Liste der zu löschenden Feld-IDs.

Gibt zurück

Antwort auf Felder löschen
deleteFieldsResponse

Herunterladen einer Anlage

Lädt die Dateianlage herunter, wobei der Dateianlageinhalt im Base64-Format codiert ist. Die API-Antwort gibt den Dateinamen im Content-Disposition Header zurück. Metadaten zu Dateien können ggf. aus den Endpunkten /records und /reports abgerufen werden. Verwenden Sie diese Endpunkte, um die erforderlichen Informationen abzurufen, um Dateien abzurufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner der Tabelle.

Datensatzkennung
recordId True integer

Der eindeutige Bezeichner des Datensatzes.

Feld-ID
fieldId True integer

Der eindeutige Bezeichner des Felds.

Versionsnummer
versionNumber True integer

Die Versionsnummer der Dateianlage.

Gibt zurück

response
string

Klonen eines Benutzertokens

Klont das authentifizierte Benutzertoken. Alle anwendungen, die diesem Token zugeordnet sind, werden automatisch dem neuen Token zugeordnet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
name
name string

Der neue Name für das geklonte Benutzertoken.

Beschreibung
description string

Die Beschreibung für das geklonte Benutzertoken.

Gibt zurück

Klonen der Benutzertokenantwort
cloneUserTokenResponse

Kopieren einer App

Kopiert die angegebene Anwendung. Die neue Anwendung hat das gleiche Schema wie das Original. Weitere Kopieroptionen finden Sie unten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
name
name True string

Der Name der neu kopierten App

Beschreibung
description string

Die Beschreibung der neu kopierten App

assignUserToken
assignUserToken boolean

Gibt an, ob das Benutzertoken hinzugefügt werden soll, mit dem diese Anforderung an die neue App gestellt wird.

excludeFiles
excludeFiles boolean

If keepData is true, whether to copy the file attachments as well. Wenn keepData falsch ist, wird diese Eigenschaft ignoriert.

keepData
keepData boolean

Gibt an, ob die App-Daten zusammen mit dem Schema kopiert werden sollen.

usersAndRoles
usersAndRoles boolean

Wenn true, werden Benutzer zusammen mit ihren zugewiesenen Rollen kopiert. Wenn "false" lautet, werden Benutzer und Rollen kopiert, rollen werden jedoch nicht zugewiesen.

App-ID
appId True string

Der eindeutige Bezeichner einer App.

Gibt zurück

App-Antwort kopieren
copyAppResponse

Löschen einer Anlage

Löscht eine Dateianlageversion. Metadaten zu Dateien können ggf. aus den Endpunkten /records und /reports abgerufen werden. Verwenden Sie diese Endpunkte, um die erforderlichen Informationen zum Löschen von Dateiversionen abzurufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner der Tabelle.

Datensatzkennung
recordId True integer

Der eindeutige Bezeichner des Datensatzes.

Feld-ID
fieldId True integer

Der eindeutige Bezeichner des Felds.

Versionsnummer
versionNumber True integer

Die Versionsnummer der Dateianlage.

Gibt zurück

Dateiantwort löschen
deleteFileResponse

Löschen einer Tabelle

Löscht eine bestimmte Tabelle in einer Anwendung, einschließlich aller darin enthaltenen Daten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der eindeutige Bezeichner einer App

Tabellenkennung (ID)
tableId True string

Der eindeutige Bezeichner (DBID) der Tabelle.

Gibt zurück

Tabellenantwort löschen
deleteTableResponse

Löschen eines Benutzertokens

Löscht das authentifizierte Benutzertoken. Dies ist nicht umkehrbar.

Gibt zurück

Löschen der Benutzertokenantwort
deleteUserTokenResponse

Löschen von Datensätzen

Löscht Datensätze in einer Tabelle basierend auf einer Abfrage. Alternativ können alle Datensätze in der Tabelle gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
from
from True string

Der eindeutige Bezeichner der Tabelle.

where
where True string

Der Filter zum Löschen von Datensätzen. Um alle Datensätze zu löschen, geben Sie einen Filter an, der alle Datensätze enthält, z. B. {3.GT.0}, wobei 3 die ID des Felds Datensatz-ID ist.

Gibt zurück

Datensatzantwort löschen
deleteRecordsResponse

Definitionen

createAppResponse

Name Pfad Typ Beschreibung
name
name string

Der App-Name. Sie dürfen mehrere Apps mit demselben Namen im selben Bereich erstellen, da sie unterschiedlicheBidwerte aufweisen. Wir fordern Sie nachdrücklich auf, dies zu tun.

Beschreibung
description string

Die Beschreibung für die App. Wenn diese Eigenschaft ausgelassen wird, ist die App-Beschreibung leer.

erstellt
created string

Die Uhrzeit und das Datum, zu dem die App erstellt wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

aktualisierte
updated string

Die Uhrzeit und das Datum, zu dem die App zuletzt aktualisiert wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

dateFormat
dateFormat string

Eine Beschreibung des Formats, das beim Anzeigen von Datumswerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im API-Leitfaden, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Informationen zum Lokalisieren von Datumsangaben zum Festlegen des Datumsformats der App.

timeZone
timeZone string

Eine Beschreibung der Zeitzone, die beim Anzeigen von Zeitwerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im Portal, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Weitere Informationen finden Sie unter "Zeitzone für die Anwendung und das Konto festlegen", um die Zeitzone der Anwendung festzulegen.

id
id string

Der eindeutige Bezeichner für diese Anwendung.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Gibt an, ob die App "Jeder im Internet" zugriff enthält. Siehe Freigabe-Apps für jeden im Internet (EOTI).

variables
variables array of Variable1

Die App-Variablen. Informationen zu Anwendungsvariablen

dataClassification
dataClassification string

Die der Anwendung zugewiesene Datenklassifizierungsbezeichnung. Wenn die Datenklassifizierung nicht aktiviert ist, wird dies nicht zurückgegeben. Wenn die Datenklassifizierung aktiviert ist, die Anwendung jedoch nicht beschriftet ist, wird "None" zurückgegeben. Datenklassifizierungsbezeichnungen können von einem Bereichsadministrator für Plattform+-Pläne in der Verwaltungskonsole hinzugefügt werden.

Variable1

Name Pfad Typ Beschreibung
name
name string

Variablenname.

value
value string

Variabler Wert.

getAppResponse

Name Pfad Typ Beschreibung
name
name string

Der App-Name. Sie dürfen mehrere Apps mit demselben Namen im selben Bereich erstellen, da sie unterschiedlicheBidwerte aufweisen. Wir fordern Sie nachdrücklich auf, dies zu tun.

Beschreibung
description string

Die Beschreibung für die App. Wenn diese Eigenschaft ausgelassen wird, ist die App-Beschreibung leer.

erstellt
created string

Die Uhrzeit und das Datum, zu dem die App erstellt wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

aktualisierte
updated string

Die Uhrzeit und das Datum, zu dem die App zuletzt aktualisiert wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

dateFormat
dateFormat string

Eine Beschreibung des Formats, das beim Anzeigen von Datumswerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im API-Leitfaden, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Informationen zum Lokalisieren von Datumsangaben zum Festlegen des Datumsformats der App.

timeZone
timeZone string

Eine Beschreibung der Zeitzone, die beim Anzeigen von Zeitwerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im Portal, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Weitere Informationen finden Sie unter "Zeitzone für die Anwendung und das Konto festlegen", um die Zeitzone der Anwendung festzulegen.

id
id string

Der eindeutige Bezeichner für diese Anwendung.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Gibt an, ob die App "Jeder im Internet" zugriff enthält. Siehe Freigabe-Apps für jeden im Internet (EOTI).

variables
variables array of Variable1

Die App-Variablen. Informationen zu Anwendungsvariablen

dataClassification
dataClassification string

Die der Anwendung zugewiesene Datenklassifizierungsbezeichnung. Wenn die Datenklassifizierung nicht aktiviert ist, wird dies nicht zurückgegeben. Wenn die Datenklassifizierung aktiviert ist, die Anwendung jedoch nicht beschriftet ist, wird "None" zurückgegeben. Datenklassifizierungsbezeichnungen können von einem Bereichsadministrator für Plattform+-Pläne in der Verwaltungskonsole hinzugefügt werden.

updateAppResponse

Name Pfad Typ Beschreibung
name
name string

Der App-Name. Sie dürfen mehrere Apps mit demselben Namen im selben Bereich erstellen, da sie unterschiedlicheBidwerte aufweisen. Wir fordern Sie nachdrücklich auf, dies zu tun.

Beschreibung
description string

Die Beschreibung für die App. Wenn diese Eigenschaft ausgelassen wird, ist die App-Beschreibung leer.

erstellt
created string

Die Uhrzeit und das Datum, zu dem die App erstellt wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

aktualisierte
updated string

Die Uhrzeit und das Datum, zu dem die App zuletzt aktualisiert wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

dateFormat
dateFormat string

Eine Beschreibung des Formats, das beim Anzeigen von Datumswerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im API-Leitfaden, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Informationen zum Lokalisieren von Datumsangaben zum Festlegen des Datumsformats der App.

timeZone
timeZone string

Eine Beschreibung der Zeitzone, die beim Anzeigen von Zeitwerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im Portal, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Weitere Informationen finden Sie unter "Zeitzone für die Anwendung und das Konto festlegen", um die Zeitzone der Anwendung festzulegen.

id
id string

Der eindeutige Bezeichner für diese Anwendung.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Gibt an, ob die App "Jeder im Internet" zugriff enthält. Siehe Freigabe-Apps für jeden im Internet (EOTI).

variables
variables array of Variable1

Die App-Variablen. Informationen zu Anwendungsvariablen

dataClassification
dataClassification string

Die der Anwendung zugewiesene Datenklassifizierungsbezeichnung. Wenn die Datenklassifizierung nicht aktiviert ist, wird dies nicht zurückgegeben. Wenn die Datenklassifizierung aktiviert ist, die Anwendung jedoch nicht beschriftet ist, wird "None" zurückgegeben. Datenklassifizierungsbezeichnungen können von einem Bereichsadministrator für Plattform+-Pläne in der Verwaltungskonsole hinzugefügt werden.

deleteAppResponse

Name Pfad Typ Beschreibung
deletedAppId
deletedAppId string

Eine ID der gelöschten Anwendung.

copyAppResponse

Name Pfad Typ Beschreibung
name
name string

Der App-Name. Sie dürfen mehrere Apps mit demselben Namen im selben Bereich erstellen, da sie unterschiedlicheBidwerte aufweisen. Wir fordern Sie nachdrücklich auf, dies zu tun.

Beschreibung
description string

Die Beschreibung für die App

erstellt
created string

Die Uhrzeit und das Datum, zu dem die App erstellt wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

aktualisierte
updated string

Die Uhrzeit und das Datum, zu dem die App zuletzt aktualisiert wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

dateFormat
dateFormat string

Eine Beschreibung des Formats, das beim Anzeigen von Datumswerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im API-Leitfaden, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Informationen zum Lokalisieren von Datumsangaben zum Festlegen des Datumsformats der App.

timeZone
timeZone string

Eine Beschreibung der Zeitzone, die beim Anzeigen von Zeitwerten in dieser App verwendet wird. Beachten Sie, dass es sich hierbei um einen browsergeschützten Parameter handelt. Informationen dazu finden Sie auf der Seite " Feldtypdetails " im Portal, wie Zeitwerte in API-Aufrufen zurückgegeben werden. Weitere Informationen finden Sie unter "Zeitzone für die Anwendung und das Konto festlegen", um die Zeitzone der Anwendung festzulegen.

id
id string

Der eindeutige Bezeichner für diese Anwendung.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Gibt an, ob die App "Jeder im Internet" zugriff enthält. Siehe Freigabe-Apps für jeden im Internet (EOTI).

variables
variables array of Variable1

Die App-Variablen. Informationen zu Anwendungsvariablen

ancestorId
ancestorId string

Die ID der App, aus der diese App kopiert wurde

dataClassification
dataClassification string

Die der Anwendung zugewiesene Datenklassifizierungsbezeichnung. Wenn die Datenklassifizierung nicht aktiviert ist, wird dies nicht zurückgegeben. Wenn die Datenklassifizierung aktiviert ist, die Anwendung jedoch nicht beschriftet ist, wird "None" zurückgegeben. Datenklassifizierungsbezeichnungen können von einem Bereichsadministrator für Plattform+-Pläne in der Verwaltungskonsole hinzugefügt werden.

createTableResponse

Name Pfad Typ Beschreibung
name
name string

Der Name der Tabelle.

id
id string

Der eindeutige Bezeichner (dbid) der Tabelle.

alias
alias string

Der automatisch erstellte Tabellenalias für die Tabelle.

Beschreibung
description string

Die Beschreibung der Tabelle, wie von einem Anwendungsadministrator konfiguriert.

erstellt
created string

Die Uhrzeit und das Datum, zu dem die Tabelle erstellt wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

aktualisierte
updated string

Die Uhrzeit und das Datum, zu dem das Tabellenschema oder die Daten zuletzt aktualisiert wurden, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssSZ (in UTC-Zeitzone).

nextRecordId
nextRecordId integer

Die inkrementelle Datensatz-ID, die beim Erstellen des nächsten Datensatzes verwendet wird, wie bestimmt, wann der API-Aufruf ausgeführt wurde.

nextFieldId
nextFieldId integer

Die inkrementelle Feld-ID, die beim Erstellen des nächsten Felds verwendet wird, wie bestimmt, wann der API-Aufruf ausgeführt wurde.

defaultSortFieldId
defaultSortFieldId integer

Die ID des Felds, das für die Standardsortierung konfiguriert ist.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Die Konfiguration der Standardsortierreihenfolge in der Tabelle.

keyFieldId
keyFieldId integer

Die ID des Felds, das für den Schlüssel in dieser Tabelle konfiguriert ist, in der Regel die Quickbase Record ID.

singleRecordName
singleRecordName string

Das vom Generator konfigurierte Singular-Substantiv der Tabelle.

pluralRecordName
pluralRecordName string

Das vom Generator konfigurierte Plural-Substantiv der Tabelle.

sizeLimit
sizeLimit string

Die Größenbeschränkung für die Tabelle.

spaceUsed
spaceUsed string

Die Menge an Speicherplatz, der derzeit von der Tabelle verwendet wird.

spaceRemaining
spaceRemaining string

Der verbleibende Speicherplatz für die Verwendung durch die Tabelle.

DefaultSortOrder

Die Konfiguration der Standardsortierreihenfolge in der Tabelle.

Die Konfiguration der Standardsortierreihenfolge in der Tabelle.

DefaultSortOrder
string

getTableResponse

Name Pfad Typ Beschreibung
name
name string

Der Name der Tabelle.

id
id string

Der eindeutige Bezeichner (dbid) der Tabelle.

alias
alias string

Der automatisch erstellte Tabellenalias für die Tabelle.

Beschreibung
description string

Die Beschreibung der Tabelle, wie von einem Anwendungsadministrator konfiguriert.

erstellt
created string

Die Uhrzeit und das Datum, zu dem die Tabelle erstellt wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

aktualisierte
updated string

Die Uhrzeit und das Datum, zu dem das Tabellenschema oder die Daten zuletzt aktualisiert wurden, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssSZ (in UTC-Zeitzone).

nextRecordId
nextRecordId integer

Die inkrementelle Datensatz-ID, die beim Erstellen des nächsten Datensatzes verwendet wird, wie bestimmt, wann der API-Aufruf ausgeführt wurde.

nextFieldId
nextFieldId integer

Die inkrementelle Feld-ID, die beim Erstellen des nächsten Felds verwendet wird, wie bestimmt, wann der API-Aufruf ausgeführt wurde.

defaultSortFieldId
defaultSortFieldId integer

Die ID des Felds, das für die Standardsortierung konfiguriert ist.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Die Konfiguration der Standardsortierreihenfolge in der Tabelle.

keyFieldId
keyFieldId integer

Die ID des Felds, das für den Schlüssel in dieser Tabelle konfiguriert ist, in der Regel die Quickbase Record ID.

singleRecordName
singleRecordName string

Das vom Generator konfigurierte Singular-Substantiv der Tabelle.

pluralRecordName
pluralRecordName string

Das vom Generator konfigurierte Plural-Substantiv der Tabelle.

sizeLimit
sizeLimit string

Die Größenbeschränkung für die Tabelle.

spaceUsed
spaceUsed string

Die Menge an Speicherplatz, der derzeit von der Tabelle verwendet wird.

spaceRemaining
spaceRemaining string

Der verbleibende Speicherplatz für die Verwendung durch die Tabelle.

updateTableResponse

Name Pfad Typ Beschreibung
name
name string

Der Name der Tabelle.

id
id string

Der eindeutige Bezeichner (dbid) der Tabelle.

alias
alias string

Der automatisch erstellte Tabellenalias für die Tabelle.

Beschreibung
description string

Die Beschreibung der Tabelle, wie von einem Anwendungsadministrator konfiguriert.

erstellt
created string

Die Uhrzeit und das Datum, zu dem die Tabelle erstellt wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

aktualisierte
updated string

Die Uhrzeit und das Datum, zu dem das Tabellenschema oder die Daten zuletzt aktualisiert wurden, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssSZ (in UTC-Zeitzone).

nextRecordId
nextRecordId integer

Die inkrementelle Datensatz-ID, die beim Erstellen des nächsten Datensatzes verwendet wird, wie bestimmt, wann der API-Aufruf ausgeführt wurde.

nextFieldId
nextFieldId integer

Die inkrementelle Feld-ID, die beim Erstellen des nächsten Felds verwendet wird, wie bestimmt, wann der API-Aufruf ausgeführt wurde.

defaultSortFieldId
defaultSortFieldId integer

Die ID des Felds, das für die Standardsortierung konfiguriert ist.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Die Konfiguration der Standardsortierreihenfolge in der Tabelle.

keyFieldId
keyFieldId integer

Die ID des Felds, das für den Schlüssel in dieser Tabelle konfiguriert ist, in der Regel die Quickbase Record ID.

singleRecordName
singleRecordName string

Das vom Generator konfigurierte Singular-Substantiv der Tabelle.

pluralRecordName
pluralRecordName string

Das vom Generator konfigurierte Plural-Substantiv der Tabelle.

sizeLimit
sizeLimit string

Die Größenbeschränkung für die Tabelle.

spaceUsed
spaceUsed string

Die Menge an Speicherplatz, der derzeit von der Tabelle verwendet wird.

spaceRemaining
spaceRemaining string

Der verbleibende Speicherplatz für die Verwendung durch die Tabelle.

deleteTableResponse

Name Pfad Typ Beschreibung
deletedTableId
deletedTableId string

Die gelöschte Tabellen-ID.

getRelationshipsResponse

Name Pfad Typ Beschreibung
Beziehungen
relationships array of Relationship

Die Beziehungen in einer Tabelle.

Metadaten
metadata Metadata

Zusätzliche Informationen zu den Ergebnissen, die hilfreich sein können.

Beziehung

Name Pfad Typ Beschreibung
id
id integer

Die Beziehungs-ID (Fremdschlüsselfeld-ID).

parentTableId
parentTableId string

Die übergeordnete Tabellen-ID der Beziehung.

childTableId
childTableId string

Die id der untergeordneten Tabelle der Beziehung.

ForeignKeyField
foreignKeyField ForeignKeyField

Die Fremdschlüsselfeldinformationen.

isCrossApp
isCrossApp boolean

Gibt an, ob es sich um eine appübergreifende Beziehung handelt.

LookupFields
lookupFields array of LookupField

Das Nachschlagefeldarray.

summaryFields
summaryFields array of SummaryField

Das Array "Zusammenfassungsfelder".

ForeignKeyField

Die Fremdschlüsselfeldinformationen.

Name Pfad Typ Beschreibung
id
id integer

Feld-ID.

label
label string

Feldbezeichnung.

type
type string

Feldtyp.

LookupField

Name Pfad Typ Beschreibung
id
id integer

Feld-ID.

label
label string

Feldbezeichnung.

type
type string

Feldtyp.

SummaryField

Name Pfad Typ Beschreibung
id
id integer

Feld-ID.

label
label string

Feldbezeichnung.

type
type string

Feldtyp.

Metadaten

Zusätzliche Informationen zu den Ergebnissen, die hilfreich sein können.

Name Pfad Typ Beschreibung
skip
skip integer

Die Anzahl der zu überspringenden Beziehungen.

totalRelationships
totalRelationships integer

Die Gesamtzahl der Beziehungen.

numRelationships
numRelationships integer

Die Anzahl der Beziehungen im aktuellen Antwortobjekt.

createRelationshipResponse

Name Pfad Typ Beschreibung
id
id integer

Die Beziehungs-ID (Fremdschlüsselfeld-ID).

parentTableId
parentTableId string

Die übergeordnete Tabellen-ID der Beziehung.

childTableId
childTableId string

Die id der untergeordneten Tabelle der Beziehung.

ForeignKeyField
foreignKeyField ForeignKeyField

Die Fremdschlüsselfeldinformationen.

isCrossApp
isCrossApp boolean

Gibt an, ob es sich um eine appübergreifende Beziehung handelt.

LookupFields
lookupFields array of LookupField

Das Nachschlagefeldarray.

summaryFields
summaryFields array of SummaryField

Das Array "Zusammenfassungsfelder".

updateRelationshipResponse

Name Pfad Typ Beschreibung
id
id integer

Die Beziehungs-ID (Fremdschlüsselfeld-ID).

parentTableId
parentTableId string

Die übergeordnete Tabellen-ID der Beziehung.

childTableId
childTableId string

Die id der untergeordneten Tabelle der Beziehung.

ForeignKeyField
foreignKeyField ForeignKeyField

Die Fremdschlüsselfeldinformationen.

isCrossApp
isCrossApp boolean

Gibt an, ob es sich um eine appübergreifende Beziehung handelt.

LookupFields
lookupFields array of LookupField

Das Nachschlagefeldarray.

summaryFields
summaryFields array of SummaryField

Das Array "Zusammenfassungsfelder".

deleteRelationshipResponse

Name Pfad Typ Beschreibung
relationshipId
relationshipId integer

Die Beziehungs-ID.

Query

Die Abfragedefinition wie in der Schnellbasis konfiguriert, die beim Ausführen des Berichts ausgeführt wird.

Name Pfad Typ Beschreibung
tableId
tableId string

Der Tabellenbezeichner für den Bericht.

Filter
filter string

Filter, der zum Abfragen von Daten verwendet wird.

formulaFields
formulaFields array of FormulaField

Berechnete Formelfelder.

FormulaField

Name Pfad Typ Beschreibung
id
id integer

Formelfeldbezeichner.

label
label string

Formelfeldbezeichnung.

FieldType
fieldType FieldType

Resultierender Formelwerttyp.

Formel
formula string

Formeltext.

decimalPrecision
decimalPrecision integer

Bei numerischer Formel wird die Zahlengenauigkeit angegeben.

FieldType

Resultierender Formelwerttyp.

Resultierender Formelwerttyp.

FieldType
string

getReportResponse

Name Pfad Typ Beschreibung
id
id string

Der Bezeichner des Berichts, der für die Tabelle eindeutig ist.

name
name string

Der konfigurierte Name des Berichts.

type
type string

Der Berichtstyp in der Schnellbasis (z. B. Diagramm).

Beschreibung
description string

Die konfigurierte Beschreibung eines Berichts.

ownerId
ownerId integer

Optional, nur für persönliche Berichte angezeigt. Die Benutzer-ID des Berichtsbesitzers.

Query
query Query

Die Abfragedefinition wie in der Schnellbasis konfiguriert, die beim Ausführen des Berichts ausgeführt wird.

Eigenschaften
properties object

Eine Liste der eigenschaften, die für den Berichtstyp spezifisch sind. Eine detaillierte Beschreibung der Eigenschaften für jeden Berichtstyp finden Sie unter Berichtstypen.

usedLast
usedLast string

Der Zeitpunkt, zu dem ein Bericht zuletzt verwendet wurde.

usedCount
usedCount integer

Die Häufigkeit, mit der ein Bericht verwendet wurde.

runReportResponse

Name Pfad Typ Beschreibung
fields
fields array of Field

Ein Array von Objekten, die begrenzte Metadaten jedes Felds enthalten, das im Bericht angezeigt wird. Dies hilft beim Erstellen von Logik, die von Feldtypen und IDs abhängt.

Daten
data array of object

Ein Array von Objekten, die je nach Berichtstyp entweder die Datensatzdaten oder zusammengefassten Werte darstellen.

items
data object
Metadaten1
metadata Metadata1

Zusätzliche Informationen zu den Ergebnissen, die hilfreich sein können. Die Paginierung kann erforderlich sein, wenn Sie entweder eine kleinere Anzahl von Ergebnissen angeben, die übersprungen werden sollen, als verfügbar ist, oder wenn die API automatisch weniger Ergebnisse zurückgibt. numRecords können mit "totalRecords" verglichen werden, um festzustellen, ob eine weitere Paginierung erforderlich ist.

Feld

Name Pfad Typ Beschreibung
id
id integer

Feld-ID.

label
label string

Feldbezeichnung.

type
type string

Feldtyp.

labelOverride
labelOverride string

Spaltenüberschriftsbeschriftung für Feld im Bericht außer Kraft setzen.

Metadaten1

Zusätzliche Informationen zu den Ergebnissen, die hilfreich sein können. Die Paginierung kann erforderlich sein, wenn Sie entweder eine kleinere Anzahl von Ergebnissen angeben, die übersprungen werden sollen, als verfügbar ist, oder wenn die API automatisch weniger Ergebnisse zurückgibt. numRecords können mit "totalRecords" verglichen werden, um festzustellen, ob eine weitere Paginierung erforderlich ist.

Name Pfad Typ Beschreibung
skip
skip integer

Die Anzahl der zu überspringenden Datensätze

numFields
numFields integer

Die Anzahl der Felder in jedem Datensatz im aktuellen Antwortobjekt

top
top integer

Wenn vorhanden, die maximale Anzahl von Datensätzen, die vom Anrufer angefordert werden

totalRecords
totalRecords integer

Die Gesamtzahl der Datensätze im Resultset

numRecords
numRecords integer

Die Anzahl der Datensätze im aktuellen Antwortobjekt

Eigenschaften1

Zusätzliche Eigenschaften für das Feld. Weitere Informationen zu den Eigenschaften für jeden Feldtyp finden Sie auf der Seite " Feldtypdetails ".

Name Pfad Typ Beschreibung
comments
comments string

Die Kommentare, die von einem Administrator in die Feldeigenschaften eingegeben wurden.

doesTotal
doesTotal boolean

Gibt an, ob dieses Feld in Berichten innerhalb des Produkts summet.

AutoSpeichern
autoSave boolean

Gibt an, ob das Verknüpfungsfeld automatisch gespeichert wird.

defaultValueLuid
defaultValueLuid integer

Standardbenutzer-ID-Wert.

maxVersions
maxVersions integer

Die maximale Anzahl von Versionen, die für eine Dateianlage konfiguriert sind.

carryChoices
carryChoices boolean

Gibt an, ob das Feld seine Mehrfachauswahlfelder beim Kopieren tragen soll.

format
format integer

Das Format zum Anzeigen der Zeit.

Maximale Länge
maxLength integer

Die maximale Anzahl von Zeichen, die für die Eingabe in der Schnellbasis für dieses Feld zulässig sind.

linkText
linkText string

Der konfigurierte Textwert, der die URL ersetzt, die Benutzer im Produkt sehen.

parentFieldId
parentFieldId integer

Die ID des übergeordneten zusammengesetzten Felds, falls zutreffend.

displayTimezone
displayTimezone boolean

Gibt an, ob die Zeitzone innerhalb des Produkts angezeigt werden soll.

summaryTargetFieldId
summaryTargetFieldId integer

Die ID des Felds, das verwendet wird, um Werte aus dem untergeordneten Element zu aggregieren, falls zutreffend. Dadurch wird 0 angezeigt, wenn für die Zusammenfassungsfunktion keine Feldauswahl erforderlich ist (z. B. Anzahl).

allowNewChoices
allowNewChoices boolean

Gibt an, ob Benutzer einer Auswahlliste neue Auswahlmöglichkeiten hinzufügen können.

masterChoiceFieldId
masterChoiceFieldId integer

Die ID des Felds, das der Verweis in der Beziehung ist.

defaultToday
defaultToday boolean

Gibt an, ob der Feldwert heute für neue Datensätze standardmäßig ist.

Einheiten
units string

Die Einheitenbezeichnung.

lookupTargetFieldId
lookupTargetFieldId integer

Die ID des Felds, das das Ziel in der Mastertabelle für diese Suche ist.

SummaryFunction
summaryFunction SummaryFunction

Der Zusammenfassungsfunktionstyp der Akkumulation.

sourceFieldId
sourceFieldId integer

Die ID des Quellfelds.

masterTableTag
masterTableTag string

Der Tabellenalias für die Mastertabelle in der Beziehung, zu der dieses Feld gehört.

doesAverage
doesAverage boolean

Gibt an, ob dieses Feld in Berichten innerhalb des Produkts mittelwertt.

Formel
formula string

Die Formel des Felds, wie in der Schnellbasis konfiguriert.

Dezimalstellen
decimalPlaces integer

Die Anzahl der dezimalen Stellen, die im Produkt für dieses Feld angezeigt werden.

seeVersions
seeVersions boolean

Gibt an, ob der Benutzer neben der neuesten Version einer Dateianlage innerhalb des Produkts andere Versionen sehen kann.

displayMonth
displayMonth string

Anzeigen von Monaten

numLines
numLines integer

Die Anzahl der Zeilen, die in der Schnellbasis für dieses Textfeld angezeigt werden.

displayEmail
displayEmail string

Wie die E-Mail angezeigt wird.

defaultKind
defaultKind string

Der Standardtyp des Benutzers.

coverText
coverText string

Ein alternativer benutzerfreundlicher Text, der zum Anzeigen eines Links im Browser verwendet werden kann.

currencySymbol
currencySymbol string

Das aktuelle Symbol, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

masterChoiceTableId
masterChoiceTableId integer

Die ID der Tabelle, die der Master in dieser Beziehung ist.

targetFieldId
targetFieldId integer

Die ID des Zielfelds.

displayUser
displayUser string

Die konfigurierte Option für die Anzeige von Benutzern innerhalb des Produkts.

blankIsZero
blankIsZero boolean

Gibt an, ob ein leerer Wert in Berechnungen innerhalb des Produkts gleich 0 behandelt wird.

genau
exact boolean

Gibt an, ob für einen Berichtslink eine genaue Übereinstimmung erforderlich ist.

startField
startField integer

Die Startfeld-ID.

defaultDomain
defaultDomain string

Standard-E-Mail-Domäne.

defaultValue
defaultValue string

Der Standardwert, der für ein Feld konfiguriert ist, wenn ein neuer Datensatz hinzugefügt wird.

choicesLuid
choicesLuid array of object

Liste der Benutzeroptionen.

items
choicesLuid object
abkürzen
abbreviate boolean

Zeigen Sie das URL-Protokoll nicht an, wenn die URL angezeigt wird.

xmlTag
xmlTag string

Das XML-Tag des Felds.

targetTableName
targetTableName string

Der Zieltabellenname des Felds.

Zahlenformat
numberFormat integer

Das Format, das zum Anzeigen numerischer Werte im Produkt verwendet wird (Dezimalzeichen, Trennzeichen, Zifferngruppe).

appearsAs
appearsAs string

Wenn er leer ist, wird die URL als Linktext verwendet.

width
width integer

Die HTML-Eingabebreite des Felds im Produkt.

CurrencyFormat
currencyFormat CurrencyFormat

Das Währungsformat, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

displayImages
displayImages boolean

Gibt an, ob Bilder für Dateianlagen in Formularen und Berichten innerhalb des Produkts angezeigt werden.

foreignKey
foreignKey boolean

Gibt an, ob es sich bei dem Feld um einen Fremdschlüssel (oder ein Bezugsfeld) in einer Beziehung handelt.

displayDayOfWeek
displayDayOfWeek boolean

Gibt an, ob der Wochentag innerhalb des Produkts angezeigt werden soll.

summaryReferenceFieldId
summaryReferenceFieldId integer

Die ID des Felds, das der Verweis in der Beziehung für diese Zusammenfassung ist.

kommmaStart
commaStart integer

Die Anzahl der Ziffern, bevor Kommas im Produkt angezeigt werden, falls zutreffend.

Optionen
choices array of string

Ein Array von Einträgen, die für ein Feld vorhanden sind, das dem Benutzer Auswahlmöglichkeiten bietet.

targetTableId
targetTableId string

Die ID der Zieltabelle.

displayRelative
displayRelative boolean

Gibt an, ob die Zeit relativ angezeigt werden soll.

compositeFields
compositeFields array of object

Ein Array der Felder, aus denen ein zusammengesetztes Feld besteht (z. B. Adresse).

items
compositeFields object
VersionMode
versionMode VersionMode

Versionsmodi für Dateien. Behalten Sie alle Versionen bei, und behalten Sie die letzte Version bei.

displayTime
displayTime boolean

Gibt an, ob die Uhrzeit zusätzlich zum Datum angezeigt werden soll.

durationField
durationField integer

Die Dauerfeld-ID.

snapFieldId
snapFieldId integer

Die ID des Felds, das bei Bedarf für Momentaufnahmenwerte verwendet wird.

Stunden24
hours24 boolean

Gibt an, ob die Zeit im 24-Stunden-Format innerhalb des Produkts angezeigt werden soll.

sortAlpha
sortAlpha boolean

Ob alphabetisch sortiert werden soll, ist die Standardsortierung nach Datensatz-ID.

sortAsGiven
sortAsGiven boolean

Gibt an, ob die aufgelisteten Einträge wie eingegeben oder alphabetisch sortiert werden.

hasExtension
hasExtension boolean

Gibt an, ob dieses Feld über eine Telefonerweiterung verfügt.

Arbeitswoche
workWeek integer

Der Arbeitswochentyp.

useNewWindow
useNewWindow boolean

Gibt an, ob die URL ein neues Fenster öffnen soll, wenn ein Benutzer innerhalb des Produkts darauf klickt.

appendOnly
appendOnly boolean

Gibt an, ob dieses Feld nur angefügt wird.

displayAsLink
displayAsLink boolean

Gibt an, ob ein Feld, das Teil der Beziehung ist, als Link zum übergeordneten Datensatz innerhalb des Produkts angezeigt werden soll.

allowHTML
allowHTML boolean

Gibt an, ob dieses Feld HTML zulässt.

lookupReferenceFieldId
lookupReferenceFieldId integer

Die ID des Felds, das der Verweis in der Beziehung für diese Suche ist.

SummaryFunction

Der Zusammenfassungsfunktionstyp der Akkumulation.

Der Zusammenfassungsfunktionstyp der Akkumulation.

SummaryFunction
string

CurrencyFormat

Das Währungsformat, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

Das Währungsformat, das beim Anzeigen von Feldwerten innerhalb des Produkts verwendet wird.

CurrencyFormat
string

VersionMode

Versionsmodi für Dateien. Behalten Sie alle Versionen bei, und behalten Sie die letzte Version bei.

Versionsmodi für Dateien. Behalten Sie alle Versionen bei, und behalten Sie die letzte Version bei.

VersionMode
string

Erlaubnis

Name Pfad Typ Beschreibung
role
role string

Die Rolle, die einer bestimmten Berechtigung für das Feld zugeordnet ist

permissionType
permissionType string

Die Berechtigung, die der Rolle für dieses Feld erteilt wurde

Rollen-ID
roleId integer

Die ID der angegebenen Rolle

createFieldResponse

Name Pfad Typ Beschreibung
id
id integer

Die ID des Felds, das für diese Tabelle eindeutig ist.

fieldType
fieldType string

Der Typ des Felds, wie hier beschrieben.

mode
mode string

Bei abgeleiteten Feldern ist dies "Nachschlagevorgang", "Zusammenfassung" oder "Formel", um den Typ des abgeleiteten Felds anzugeben. Bei nicht abgeleiteten Feldern ist dies leer.

label
label string

Die Bezeichnung (Name) des Felds.

noWrap
noWrap boolean

Gibt an, ob das Feld so konfiguriert ist, dass es nicht umbrochen wird, wenn es im Produkt angezeigt wird.

fett
bold boolean

Gibt an, ob das Feld so konfiguriert ist, dass es fett im Produkt angezeigt wird.

required
required boolean

Gibt an, ob das Feld als erforderlich markiert ist.

appearsByDefault
appearsByDefault boolean

Gibt an, ob das Feld in Berichten als Standard markiert ist.

findEnabled
findEnabled boolean

Gibt an, ob das Feld als durchsuchbar markiert ist.

einzigartig
unique boolean

Gibt an, ob das Feld eindeutig markiert ist.

doesDataCopy
doesDataCopy boolean

Gibt an, ob die Felddaten kopiert werden, wenn ein Benutzer den Datensatz kopiert.

fieldHelp
fieldHelp string

Der konfigurierte Hilfetext, der Benutzern innerhalb des Produkts angezeigt wird.

auditiert
audited boolean

Gibt an, ob das Feld als Teil von Quickbase-Überwachungsprotokollen nachverfolgt wird.

Eigenschaften1
properties Properties1

Zusätzliche Eigenschaften für das Feld. Weitere Informationen zu den Eigenschaften für jeden Feldtyp finden Sie auf der Seite " Feldtypdetails ".

Erlaubnisse
permissions array of Permission

Feldberechtigungen für unterschiedliche Rollen.

deleteFieldsResponse

Name Pfad Typ Beschreibung
deletedFieldIds
deletedFieldIds array of integer

Liste der zu löschenden Feld-IDs.

Irrtümer
errors array of string

Liste der gefundenen Fehler.

getFieldResponse

Name Pfad Typ Beschreibung
id
id integer

Die ID des Felds, das für diese Tabelle eindeutig ist.

fieldType
fieldType string

Der Typ des Felds, wie hier beschrieben.

mode
mode string

Bei abgeleiteten Feldern ist dies "Nachschlagevorgang", "Zusammenfassung" oder "Formel", um den Typ des abgeleiteten Felds anzugeben. Bei nicht abgeleiteten Feldern ist dies leer.

label
label string

Die Bezeichnung (Name) des Felds.

noWrap
noWrap boolean

Gibt an, ob das Feld so konfiguriert ist, dass es nicht umbrochen wird, wenn es im Produkt angezeigt wird.

fett
bold boolean

Gibt an, ob das Feld so konfiguriert ist, dass es fett im Produkt angezeigt wird.

required
required boolean

Gibt an, ob das Feld als erforderlich markiert ist.

appearsByDefault
appearsByDefault boolean

Gibt an, ob das Feld in Berichten als Standard markiert ist.

findEnabled
findEnabled boolean

Gibt an, ob das Feld als durchsuchbar markiert ist.

einzigartig
unique boolean

Gibt an, ob das Feld eindeutig markiert ist.

doesDataCopy
doesDataCopy boolean

Gibt an, ob die Felddaten kopiert werden, wenn ein Benutzer den Datensatz kopiert.

fieldHelp
fieldHelp string

Der konfigurierte Hilfetext, der Benutzern innerhalb des Produkts angezeigt wird.

auditiert
audited boolean

Gibt an, ob das Feld als Teil von Quickbase-Überwachungsprotokollen nachverfolgt wird.

Eigenschaften1
properties Properties1

Zusätzliche Eigenschaften für das Feld. Weitere Informationen zu den Eigenschaften für jeden Feldtyp finden Sie auf der Seite " Feldtypdetails ".

Erlaubnisse
permissions array of Permission

Feldberechtigungen für unterschiedliche Rollen.

updateFieldResponse

Name Pfad Typ Beschreibung
id
id integer

Die ID des Felds, das für diese Tabelle eindeutig ist.

fieldType
fieldType string

Der Typ des Felds, wie hier beschrieben.

mode
mode string

Bei abgeleiteten Feldern ist dies "Nachschlagevorgang", "Zusammenfassung" oder "Formel", um den Typ des abgeleiteten Felds anzugeben. Bei nicht abgeleiteten Feldern ist dies leer.

label
label string

Die Bezeichnung (Name) des Felds.

noWrap
noWrap boolean

Gibt an, ob das Feld so konfiguriert ist, dass es nicht umbrochen wird, wenn es im Produkt angezeigt wird.

fett
bold boolean

Gibt an, ob das Feld so konfiguriert ist, dass es fett im Produkt angezeigt wird.

required
required boolean

Gibt an, ob das Feld als erforderlich markiert ist.

appearsByDefault
appearsByDefault boolean

Gibt an, ob das Feld in Berichten als Standard markiert ist.

findEnabled
findEnabled boolean

Gibt an, ob das Feld als durchsuchbar markiert ist.

einzigartig
unique boolean

Gibt an, ob das Feld eindeutig markiert ist.

doesDataCopy
doesDataCopy boolean

Gibt an, ob die Felddaten kopiert werden, wenn ein Benutzer den Datensatz kopiert.

fieldHelp
fieldHelp string

Der konfigurierte Hilfetext, der Benutzern innerhalb des Produkts angezeigt wird.

auditiert
audited boolean

Gibt an, ob das Feld als Teil von Quickbase-Überwachungsprotokollen nachverfolgt wird.

Eigenschaften1
properties Properties1

Zusätzliche Eigenschaften für das Feld. Weitere Informationen zu den Eigenschaften für jeden Feldtyp finden Sie auf der Seite " Feldtypdetails ".

Erlaubnisse
permissions array of Permission

Feldberechtigungen für unterschiedliche Rollen.

runFormulaResponse

Name Pfad Typ Beschreibung
Ergebnis
result string

Das Ergebnis der Formelausführung.

upsertResponse

Eine erfolgreiche Antwort, die Details zu den hinzugefügten, aktualisierten oder unveränderten Datensätzen enthält. Im folgenden Beispiel hatte die Tabelle zuvor zehn Datensätze mit IDs von 1 bis 10. Der Benutzer veröffentlicht einen Upsert, der den Wert von Datensatz 1 aktualisiert und zwei neue Datensätze hinzufügt, alle erfolgreich.

Name Pfad Typ Beschreibung
Metadaten2
metadata Metadata2

Informationen zu erstellten Datensätzen, aktualisierten Datensätzen, referenzierten, aber unveränderten Datensätzen und Datensätzen mit Fehlern während der Verarbeitung.

Daten
data array of object

Die Daten, die zurückgegeben werden sollen.

items
data object

Metadaten2

Informationen zu erstellten Datensätzen, aktualisierten Datensätzen, referenzierten, aber unveränderten Datensätzen und Datensätzen mit Fehlern während der Verarbeitung.

Name Pfad Typ Beschreibung
createdRecordIds
createdRecordIds array of integer

Array mit den erstellten Datensatz-IDs.

lineErrors
lineErrors object

Dies wird nur bei fehlgeschlagenen Datensätzen zurückgegeben. Es handelt sich um eine Sammlung von Fehlern, die beim Verarbeiten der eingehenden Daten aufgetreten sind, die dazu geführt haben, dass Datensätze nicht verarbeitet werden. Jedes Objekt weist einen Schlüssel auf, der die Sequenznummer des Datensatzes in der ursprünglichen Nutzlast darstellt (beginnend mit 1). Der Wert ist eine Liste der aufgetretenen Fehler.

unverändertRecordIds
unchangedRecordIds array of integer

Array mit den unveränderten Datensatz-IDs.

updatedRecordIds
updatedRecordIds array of integer

Array mit den aktualisierten Datensatz-IDs.

totalNumberOfRecordsProcessed
totalNumberOfRecordsProcessed integer

Anzahl der verarbeiteten Datensätze. Enthält erfolgreiche und fehlgeschlagene Datensatzaktualisierungen.

deleteRecordsResponse

Name Pfad Typ Beschreibung
numberDeleted
numberDeleted integer

Die Anzahl der gelöschten Datensätze.

runQueryResponse

Name Pfad Typ Beschreibung
fields
fields array of Fields2

Ein Array von Objekten, die begrenzte Metadaten jedes Felds enthalten, das im Bericht angezeigt wird. Dies hilft beim Erstellen von Logik, die von Feldtypen und IDs abhängt.

Daten
data array of object

Ein Array von Objekten, die je nach Berichtstyp entweder die Datensatzdaten oder zusammengefassten Werte darstellen.

items
data object
Metadaten1
metadata Metadata1

Zusätzliche Informationen zu den Ergebnissen, die hilfreich sein können. Die Paginierung kann erforderlich sein, wenn Sie entweder eine kleinere Anzahl von Ergebnissen angeben, die übersprungen werden sollen, als verfügbar ist, oder wenn die API automatisch weniger Ergebnisse zurückgibt. numRecords können mit "totalRecords" verglichen werden, um festzustellen, ob eine weitere Paginierung erforderlich ist.

Felder2

Name Pfad Typ Beschreibung
id
id integer

Feld-ID.

label
label string

Feldbezeichnung.

type
type string

Feldtyp.

getTempTokenDBIDResponse

Name Pfad Typ Beschreibung
temporaryAuthorization
temporaryAuthorization string

Temporäres Autorisierungstoken.

cloneUserTokenResponse

Name Pfad Typ Beschreibung
active
active boolean

Gibt an, ob das Benutzertoken aktiv ist.

apps
apps array of App

Die Liste der Apps, denen dieses Benutzertoken zugewiesen ist.

lastUsed
lastUsed string

Das letzte Datum, an dem dieses Benutzertoken verwendet wurde, im ISO 8601-Zeitformat JJJJ-MM-DDThh:mm:sssZ (in UTC-Zeitzone).

Beschreibung
description string

Beschreibung des Benutzertokens.

id
id integer

Benutzertoken-ID.

name
name string

Benutzertokenname.

token
token string

Benutzertokenwert.

Anwendung

Name Pfad Typ Beschreibung
id
id string

Der eindeutige Bezeichner für diese Anwendung.

name
name string

Der Name der Anwendung.

deleteUserTokenResponse

Name Pfad Typ Beschreibung
id
id integer

Die Benutzertoken-ID.

deleteFileResponse

Name Pfad Typ Beschreibung
versionNumber
versionNumber integer

Die Anzahl der gelöschten Versionen.

fileName
fileName string

Der Name der Datei, die der gelöschten Version zugeordnet ist.

hochgeladen
uploaded string

Der Zeitstempel, zu dem die Version ursprünglich hochgeladen wurde.

Schöpfer
creator Creator

Der Benutzer, der die Version hochgeladen hat.

Schöpfer

Der Benutzer, der die Version hochgeladen hat.

Name Pfad Typ Beschreibung
name
name string

Vollständiger Benutzername.

id
id string

Benutzer-ID.

E-Mail
email string

Benutzer-E-Mail.

Nutzername
userName string

Der Benutzername wird in den Benutzereigenschaften aktualisiert. Optional, wird angezeigt, wenn nicht mit der E-Mail-Adresse des Benutzers identisch.

Schnur

Dies ist der grundlegende Datentyp "string".