Sdílet prostřednictvím


QuickBase (nezávislý vydavatel)

QuickBase je platforma pro vývoj aplikací, která spojuje obchodní a IT týmy tím, že umožňuje řešitelům problémů jakéhokoli technického pozadí spolupracovat na bezpečném, bezpečném a udržitelném vytvoření ekosystému aplikací. QuickBase pomáhá podnikům urychlit kontinuální inovace jedinečných procesů tím, že umožňuje rozvoj občanů ve velkém měřítku napříč jednou společnou platformou.

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure Government
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Premium Všechny oblasti Power Apps s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Power Automate Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Kontakt
Název Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadata konektoru
Vydavatel Troy Taylor, Hitachi Solutions
Internetová stránka https://www.quickbase.com/
Zásady ochrany osobních údajů https://www.quickbase.com/privacy
Kategorie produktivita, IT provoz

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí Parametry pro vytvoření připojení Všechny oblasti Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název Typ Description Povinné
Název hostitele sféry řetězec Zadejte název hostitele sféry. Pravdivé
Authorization securestring Token uživatele ve formátu "QB-USER-TOKEN yourToken". Pravdivé

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 100 60 sekund

Akce

Aktualizace aplikace

Aktualizuje hlavní vlastnosti a/nebo proměnné aplikace pro konkrétní aplikaci. Všechny vlastnosti aplikace, kterou nezadáte v textu požadavku, zůstanou beze změny.

Aktualizace pole

Aktualizuje vlastnosti a vlastní oprávnění pole. Pokus o aktualizaci určitých vlastností může způsobit, že stávající data přestanou poslouchat nové vlastnosti pole a mohou být odmítnuta. Konkrétní situace najdete níže v popisu požadovaných, jedinečných a voleb. Všechny vlastnosti pole, které nezadáte v textu požadavku, zůstanou beze změny.

Aktualizace relace

Tento koncový bod slouží k přidání vyhledávacích polí a souhrnných polí do existující relace. Aktualizace relace neodstraní existující vyhledávací a souhrnná pole.

Aktualizace tabulky

Aktualizuje hlavní vlastnosti konkrétní tabulky. Všechny vlastnosti tabulky, kterou nezadáte v textu požadavku, zůstanou beze změny.

Deaktivace tokenu uživatele

Deaktivuje ověřený token uživatele. Po dokončení se uživatelský token musí znovu aktivovat v uživatelském rozhraní.

Dotaz na data

Předejte dotaz v dotazovacím jazyce Quickbase. Vrátí data záznamů s inteligentní stránkováním na základě přibližné velikosti každého záznamu. Objekt metadat bude obsahovat potřebné informace pro iteraci odpovědi a shromáždění dalších dat.

Klonování tokenu uživatele

Naklonuje ověřený token uživatele. Všechny aplikace přidružené k ho tokenu se automaticky přidružují k novému tokenu.

Kopírování aplikace

Zkopíruje zadanou aplikaci. Nová aplikace bude mít stejné schéma jako původní. Další možnosti kopírování najdete níže.

Odebrání aplikace

Odstraní celou aplikaci, včetně všech tabulek a dat.

Odstranění přílohy

Odstraní jednu verzi přílohy souboru. Meta-data o souborech lze načíst z koncových bodů /records a /reports, kde je to možné. Pomocí těchto koncových bodů získejte potřebné informace k odstranění verzí souborů.

Odstranění relace

Tento koncový bod slouží k odstranění celé relace včetně všech vyhledávacích a souhrnných polí. Referenční pole v relaci se neodstraní.

Odstranění tokenu uživatele

Odstraní ověřený token uživatele. To není nevratné.

Odstranění záznamů

Odstraní záznamy v tabulce na základě dotazu. Případně je možné odstranit všechny záznamy v tabulce.

Odstraňte pole

Odstraní jedno nebo více polí v tabulce na základě ID pole. Tím se také trvale odstraní všechna data nebo výpočty v tomto poli.

Odstraňte tabulku

Odstraní konkrétní tabulku v aplikaci, včetně všech dat v ní.

Spuštění sestavy

Spustí sestavu na základě ID a vrátí související data. Formát dat se bude lišit v závislosti na typu sestavy. Sestavy, které se zaměřují na data na úrovni záznamů (tabulka, kalendář atd.), vrátí jednotlivé záznamy. Agregované sestavy (souhrn, graf) vrátí souhrnné informace podle konfigurace v sestavě. Prvky specifické pro uživatelské rozhraní se nevrací, jako jsou součty, průměry a vizualizace. Vrátí data s inteligentní stránkováním na základě přibližné velikosti každého záznamu. Objekt metadat bude obsahovat potřebné informace pro iteraci odpovědi a shromáždění dalších dat.

Spuštění vzorce

Umožňuje spuštění vzorce prostřednictvím volání rozhraní API. Tuto metodu ve vlastním kódu použijte k získání hodnoty zpět vzorce bez samostatného pole záznamu.

Stažení přílohy

Stáhne přílohu souboru s obsahem přílohy souboru kódovaným ve formátu base64. Odpověď rozhraní API vrátí název souboru v Content-Disposition hlavičce. Meta-data o souborech lze načíst z koncových bodů /records a /reports, kde je to možné. Pomocí těchto koncových bodů získejte potřebné informace k načtení souborů.

Vložení andor update records

Vložení a/nebo aktualizace záznamů v tabulce V tomto jediném volání rozhraní API je možné odesílat vložení a aktualizace. Aktualizace může použít pole klíče v tabulce nebo jakékoli jiné podporované jedinečné pole. Další informace o formátování jednotlivých typů polí najdete na stránce Typy polí . Tato operace umožňuje přírůstkové zpracování úspěšných záznamů, i když některé záznamy selžou.
Poznámka: Tento koncový bod podporuje maximální velikost datové části 10 MB.

Vytvoření aplikace

Vytvoří aplikaci v účtu. V příslušném účtu musíte mít práva k vytvoření aplikace. Pomocí tohoto rozhraní API je možné nastavit hlavní vlastnosti a proměnné aplikace.

Vytvoření pole

Vytvoří pole v tabulce, včetně vlastních oprávnění daného pole.

Vytvoření tabulky

Vytvoří tabulku v aplikaci.

Vytvoření vztahu

Vytvoří relaci v tabulce i vyhledávací a souhrnná pole. Relace se dají vytvářet jenom pro tabulky ve stejné aplikaci.

Získat pole

Získá vlastnosti jednotlivých polí na základě ID pole.
Vlastnosti, které jsou přítomné na všech typech polí, se vrátí na nejvyšší úrovni. Vlastnosti jedinečné pro určitý typ pole jsou vráceny pod atributem properties. Další podrobnosti o vlastnostech jednotlivých typů polí najdete na stránce Typy polí .

Získání aplikace

Vrátí hlavní vlastnosti aplikace, včetně proměnných aplikace.

Získání dočasného tokenu pro DBID

Tento koncový bod slouží k získání dočasného autorizačního tokenu s oborem aplikace nebo tabulky. Tento token pak můžete použít k provádění dalších volání rozhraní API (viz autorizace). Platnost tohoto tokenu vyprší za 5 minut.

Získání polí pro tabulku

Získá vlastnosti pro všechna pole v konkrétní tabulce. Vlastnosti pro každé pole jsou stejné jako v poli Získat.

Získání sestavy

Získejte schéma (vlastnosti) jednotlivé sestavy.

Získání tabulek pro aplikaci

Získá seznam všech tabulek, které existují v konkrétní aplikaci. Vlastnosti pro každou tabulku jsou stejné jako vlastnosti vrácené v tabulce Get.

Získání tabulky

Získá vlastnosti jednotlivé tabulky, která je součástí aplikace.

Získání událostí aplikace

Získejte seznam událostí, které se dají aktivovat na základě dat nebo akcí uživatelů v této aplikaci, včetně e-mailových oznámení, připomenutí, odběrů, akcí QB, webhooků, aktivovaných automatizací změn záznamů (nezahrnuje naplánované).

Získání využití polí

Získejte statistiku využití pro jednotlivá pole. Toto je souhrn informací, které najdete v tabulce využití vlastností polí.

Získání využití pro všechna pole

Získejte všechny statistiky využití polí pro tabulku. Toto je souhrn informací, které najdete v tabulce využití vlastností polí.

Získání všech relací

Získejte seznam všech relací a jejich definic pro konkrétní tabulku. Podrobnosti jsou k dispozici pro nadřazenou i podřízenou stranu relací v rámci dané aplikace. Pro relace mezi aplikacemi se vrátí omezené podrobnosti.

Získání všech sestav tabulek

Získejte schéma (vlastnosti) všech sestav pro tabulku. Pokud je uživatel, na kterém rozhraní API běží, správce aplikace, vrátí rozhraní API také všechny osobní sestavy s ID uživatele vlastníka.

Aktualizace aplikace

Aktualizuje hlavní vlastnosti a/nebo proměnné aplikace pro konkrétní aplikaci. Všechny vlastnosti aplikace, kterou nezadáte v textu požadavku, zůstanou beze změny.

Parametry

Name Klíč Vyžadováno Typ Description
název
name True string

Název proměnné.

value
value True string

Hodnota proměnné.

název
name string

Název aplikace.

popis
description string

Popis aplikace

ID aplikace
appId True string

Jedinečný identifikátor aplikace.

Návraty

Aktualizace odpovědi aplikace
updateAppResponse

Aktualizace pole

Aktualizuje vlastnosti a vlastní oprávnění pole. Pokus o aktualizaci určitých vlastností může způsobit, že stávající data přestanou poslouchat nové vlastnosti pole a mohou být odmítnuta. Konkrétní situace najdete níže v popisu požadovaných, jedinečných a voleb. Všechny vlastnosti pole, které nezadáte v textu požadavku, zůstanou beze změny.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor tabulky.

Auditovány
audited boolean

Označuje, jestli je pole sledováno jako součást protokolů auditu Quickbase. Tuto vlastnost můžete nastavit jenom na true, pokud má aplikace povolené protokoly auditu. Viz Povolení protokolů změn dat v části Protokoly auditu QuickBase.

fieldHelp
fieldHelp string

Nakonfigurovaný text nápovědy zobrazený uživatelům v rámci produktu.

bold
bold boolean

Označuje, jestli je pole nakonfigurované tak, aby se v produktu zobrazovala tučně.

required
required boolean

Určuje, jestli je pole povinné (tj. pokud každý záznam musí mít v tomto poli hodnotu, která nemá hodnotu null). Pokud se pokusíte změnit pole z nepožadované na povinné a tabulka aktuálně obsahuje záznamy s hodnotami null v tomto poli, zobrazí se chyba označující, že pole obsahuje hodnoty null. V takovém případě je potřeba tyto záznamy najít a aktualizovat s hodnotami null pole před změnou pole na povinné.

comments
comments string

Komentáře zadané ve vlastnostech pole správcem.

doTotal
doesTotal boolean

Určuje, jestli se toto pole součet v sestavách v rámci produktu.

automatické ukládání
autoSave boolean

Určuje, jestli se pole odkazu automaticky uloží.

defaultValueLuid
defaultValueLuid integer

Výchozí hodnota ID uživatele

maxVersions
maxVersions integer

Maximální počet verzí nakonfigurovaných pro přílohu souboru.

format
format integer

Formát pro zobrazení času.

carryChoices
carryChoices boolean

Určuje, jestli má pole při kopírování obsahovat pole s více volbami.

maximální délka
maxLength integer

Maximální početznakůch

linkText
linkText string

Nakonfigurovaná textová hodnota, která nahrazuje adresu URL, kterou uživatelé uvidí v rámci produktu.

parentFieldId
parentFieldId integer

ID nadřazeného složeného pole, pokud je to možné.

displayTimezone
displayTimezone boolean

Určuje, zda se má zobrazit časové pásmo v rámci produktu.

summaryTargetFieldId
summaryTargetFieldId integer

ID pole, které se používá k agregaci hodnot z podřízeného pole, pokud je to možné. Zobrazí se hodnota 0, pokud souhrnná funkce nevyžaduje výběr pole (například počet).

allowNewChoices
allowNewChoices boolean

Označuje, jestli uživatelé můžou do seznamu výběru přidat nové volby.

defaultToday
defaultToday boolean

Určuje, jestli je hodnota pole pro nové záznamy výchozí.

jednotky
units string

Popisek jednotek.

lookupTargetFieldId
lookupTargetFieldId integer

ID pole, které je cílem nadřazené tabulky pro toto vyhledávání.

SummaryFunction3
summaryFunction string

Typ akumulace pro souhrnné pole.

sourceFieldId
sourceFieldId integer

ID zdrojového pole.

doesAverage
doesAverage boolean

Určuje, jestli se toto pole průměruje v sestavách v rámci produktu.

vzorec
formula string

Vzorec pole nakonfigurovaný v quickbase.

decimalPlaces
decimalPlaces integer

Počet desetinných míst zobrazených v produktu pro toto pole

displayMonth
displayMonth string

Jak zobrazit měsíce

seeVersions
seeVersions boolean

Označuje, jestli uživatel uvidí jiné verze kromě nejnovější přílohy souboru v rámci produktu.

numLines
numLines integer

Počet řádků zobrazených v Rychlém základu pro toto textové pole

defaultKind
defaultKind string

Výchozí typ uživatele.

displayEmail
displayEmail string

Způsob zobrazení e-mailu

coverText
coverText string

Alternativní uživatelsky přívětivý text, který lze použít k zobrazení odkazu v prohlížeči.

currencySymbol
currencySymbol string

Aktuální symbol použitý při zobrazení hodnot polí v rámci produktu.

summaryQuery
summaryQuery string

Souhrnný dotaz.

targetFieldId
targetFieldId integer

ID cílového pole.

displayUser
displayUser string

Nakonfigurovaná možnost zobrazení uživatelů v rámci produktu.

blankIsZero
blankIsZero boolean

Zda je prázdná hodnota považována za stejnou jako 0 ve výpočtech v rámci produktu.

přesný
exact boolean

Určuje, jestli je pro odkaz na sestavu vyžadována přesná shoda.

defaultDomain
defaultDomain string

Výchozí e-mailová doména

defaultValue
defaultValue string

Výchozí hodnota nakonfigurovaná pro pole při přidání nového záznamu.

zkrátit
abbreviate boolean

Při zobrazení adresy URL nezobrazovat protokol URL.

formát čísla
numberFormat integer

Formát použitý pro zobrazení číselných hodnot v součinu (desetinné číslo, oddělovače, skupina číslic).

targetTableName
targetTableName string

Název cílové tabulky pole.

zobrazí se jako
appearsAs string

Text odkazu, pokud je prázdný, bude adresa URL použita jako text odkazu.

šířka
width integer

Šířka vstupu html pole v produktu.

Formát měny
currencyFormat string

Formát měny použitý při zobrazení hodnot polí v rámci produktu.

displayImages
displayImages boolean

Určuje, jestli se obrázky budou zobrazovat pro přílohy souborů ve formulářích a sestavách v rámci produktu.

displayDayOfWeek
displayDayOfWeek boolean

Určuje, zda se má zobrazit den v týdnu v rámci produktu.

summaryReferenceFieldId
summaryReferenceFieldId integer

ID pole, které je odkazem v relaci pro tento souhrn.

ČárkaStart
commaStart integer

Počet číslic před čárkami zobrazenými v produktu, pokud je to možné.

choices
choices array of string

Pole položek, které existují pro pole, které nabízí možnosti pro uživatele. Všimněte si, že tyto volby odkazují na platné hodnoty všech záznamů přidaných v budoucnu. Můžete odebrat hodnoty ze seznamu voleb, i když v tomto poli existují záznamy s těmito hodnotami. Když se uživatelé dívají na data v prohlížeči, zobrazí se červeně, ale žádný jiný efekt neexistuje. Při aktualizaci pole s touto vlastností se staré volby odeberou a nahradí novými volbami.

targetTableId
targetTableId string

ID cílové tabulky.

displayRelative
displayRelative boolean

Zda se má zobrazit čas jako relativní.

compositeFields
compositeFields object
summaryTableId
summaryTableId string

Tabulka, ze které souhrnné pole odkazuje na pole.

displayTime
displayTime boolean

Určuje, jestli se má kromě data zobrazit i čas.

VersionMode
versionMode string

Režimy verzí pro soubory. Zachovat všechny verze vs. zachovat poslední verzi.

snapFieldId
snapFieldId integer

ID pole, ze kterého se hodnoty snímků používají, pokud je to možné.

hodiny 24
hours24 boolean

Určuje, zda se má zobrazit čas ve formátu 24 hodin v rámci produktu.

sortAlpha
sortAlpha boolean

Určuje, jestli se má řadit abecedně, výchozí řazení je podle ID záznamu.

sortAsGiven
sortAsGiven boolean

Určuje, jestli se položky uvedené v seznamu seřadí jako zadané v abecedním pořadí.

hasExtension
hasExtension boolean

Jestli má toto pole linku pro telefon.

useNewWindow
useNewWindow boolean

Označuje, jestli má adresa URL otevřít nové okno, když na ni uživatel klikne v rámci produktu.

appendOnly
appendOnly boolean

Zda je toto pole pouze připojeno.

displayAsLink
displayAsLink boolean

Určuje, jestli se má pole, které je součástí relace, zobrazit jako hypertextový odkaz na nadřazený záznam v rámci produktu.

lookupReferenceFieldId
lookupReferenceFieldId integer

ID pole, které je odkazem v relaci pro toto vyhledávání.

zobrazeníByDefault
appearsByDefault boolean

Označuje, jestli je pole v sestavách označené jako výchozí.

jedinečný
unique boolean

Určuje, jestli každý záznam v tabulce musí obsahovat jedinečnou hodnotu tohoto pole. Pokud se pokusíte změnit pole z hodnoty ne jedinečné na jedinečné a tabulka aktuálně obsahuje záznamy se stejnou hodnotou tohoto pole, zobrazí se chyba. V takovém případě je potřeba tyto záznamy najít a aktualizovat duplicitními hodnotami pole před změnou pole na jedinečný.

role
role string

Role přidružená k danému oprávnění pro dané pole

permissionType
permissionType string

Oprávnění udělená roli pro toto pole

ID role
roleId integer

ID dané role

addToForms
addToForms boolean

Určuje, jestli se pole, které přidáváte, má zobrazit ve formulářích.

jmenovka
label string

Popisek (název) pole

findEnabled
findEnabled boolean

Označuje, jestli je pole označené jako prohledávatelné.

noWrap
noWrap boolean

Označuje, jestli je pole nakonfigurované tak, aby se při zobrazení v produktu nezabalila.

ID pole
fieldId True integer

Jedinečný identifikátor (FID) pole.

Návraty

Aktualizace odpovědi pole
updateFieldResponse

Aktualizace relace

Tento koncový bod slouží k přidání vyhledávacích polí a souhrnných polí do existující relace. Aktualizace relace neodstraní existující vyhledávací a souhrnná pole.

Parametry

Name Klíč Vyžadováno Typ Description
summaryFid
summaryFid double

ID pole, které chcete sumarizovat.

jmenovka
label string

Popisek souhrnného pole

AkumulaceType
accumulationType True string

Typ akumulace pro souhrnné pole.

where
where string

Filtr pomocí dotazovacího jazyka Quickbase, který určuje záznamy, které se mají vrátit.

lookupFieldIds
lookupFieldIds array of integer

Pole ID polí v nadřazené tabulce, které se stanou vyhledávacími poli v podřízené tabulce.

ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky. Toto bude podřízená tabulka.

ID relace
relationshipId True double

ID relace. Toto je ID pole referenčního pole v podřízené tabulce.

Návraty

Aktualizace odpovědi na relaci
updateRelationshipResponse

Aktualizace tabulky

Aktualizuje hlavní vlastnosti konkrétní tabulky. Všechny vlastnosti tabulky, kterou nezadáte v textu požadavku, zůstanou beze změny.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
appId True string

Jedinečný identifikátor aplikace

název
name string

Název tabulky.

pluralRecordName
pluralRecordName string

Podstatné jméno v množném čísle pro záznamy v tabulce. Pokud se tato hodnota nepředá, výchozí hodnota je Records(Záznamy).

singleRecordName
singleRecordName string

Jedno podstatné jméno pro záznamy v tabulce. Pokud se tato hodnota nepředá, výchozí hodnota je Record (Záznam).

popis
description string

Popis tabulky. Pokud se tato hodnota nepředá, je výchozí hodnota prázdná.

ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

Návraty

Aktualizace odpovědi tabulky
updateTableResponse

Deaktivace tokenu uživatele

Deaktivuje ověřený token uživatele. Po dokončení se uživatelský token musí znovu aktivovat v uživatelském rozhraní.

Návraty

Name Cesta Typ Description
identifikační číslo
id integer

identifikační číslo

Dotaz na data

Předejte dotaz v dotazovacím jazyce Quickbase. Vrátí data záznamů s inteligentní stránkováním na základě přibližné velikosti každého záznamu. Objekt metadat bude obsahovat potřebné informace pro iteraci odpovědi a shromáždění dalších dat.

Parametry

Name Klíč Vyžadováno Typ Description
přeskočit
skip integer

Počet záznamů, které se mají přeskočit.

compareWithAppLocalTime
compareWithAppLocalTime boolean

Určuje, jestli se má dotaz spouštět na poli data a času s ohledem na místní čas aplikace. Dotaz se ve výchozím nastavení spustí s časem UTC.

top
top integer

Maximální počet záznamů, které se mají zobrazit.

where
where string

Filtr pomocí dotazovacího jazyka Quickbase, který určuje záznamy, které se mají vrátit. Pokud tento parametr vynecháte, dotaz vrátí všechny záznamy.

fieldId
fieldId integer

Jedinečný identifikátor pole v tabulce.

Seskupení
grouping string

Seskupit podle vzestupného pořadí (ASC), sestupného pořadí (DESC) nebo stejných hodnot (equal-values)

sortBy
sortBy object

Ve výchozím nastavení budou dotazy seřazeny podle zadaných polí řazení nebo výchozího řazení, pokud dotaz neposkytuje. Nastavení na hodnotu false, aby se zabránilo řazení, pokud pořadí vrácených dat není důležité. Vrácení dat bez řazení může zlepšit výkon.

select
select object
od
from True string

Identifikátor tabulky.

Návraty

Spuštění odpovědi dotazu
runQueryResponse

Klonování tokenu uživatele

Naklonuje ověřený token uživatele. Všechny aplikace přidružené k ho tokenu se automaticky přidružují k novému tokenu.

Parametry

Name Klíč Vyžadováno Typ Description
název
name string

Nový název klonovaného tokenu uživatele.

popis
description string

Popis klonovaného tokenu uživatele.

Návraty

Odpověď klonování tokenu uživatele
cloneUserTokenResponse

Kopírování aplikace

Zkopíruje zadanou aplikaci. Nová aplikace bude mít stejné schéma jako původní. Další možnosti kopírování najdete níže.

Parametry

Name Klíč Vyžadováno Typ Description
název
name True string

Název nově zkopírované aplikace

popis
description string

Popis nově zkopírované aplikace

assignUserToken
assignUserToken boolean

Zda přidat token uživatele použitý k provedení tohoto požadavku do nové aplikace

excludeFiles
excludeFiles boolean

Pokud je keepData pravdivá, zda se mají zkopírovat i přílohy souboru. Pokud je keepData false, tato vlastnost se ignoruje.

keepData
keepData boolean

Zda se mají kopírovat data aplikace spolu se schématem

usersAndRoles
usersAndRoles boolean

Pokud je pravda, uživatelé se zkopírují spolu s přiřazenými rolemi. Pokud je false, uživatelé a role se zkopírují, ale role nebudou přiřazeny.

ID aplikace
appId True string

Jedinečný identifikátor aplikace.

Návraty

Kopírovat odpověď aplikace
copyAppResponse

Odebrání aplikace

Odstraní celou aplikaci, včetně všech tabulek a dat.

Parametry

Name Klíč Vyžadováno Typ Description
název
name True string

Abychom potvrdili odstranění aplikace, požádáme o název aplikace.

ID aplikace
appId True string

Jedinečný identifikátor aplikace.

Návraty

Odstranit odpověď aplikace
deleteAppResponse

Odstranění přílohy

Odstraní jednu verzi přílohy souboru. Meta-data o souborech lze načíst z koncových bodů /records a /reports, kde je to možné. Pomocí těchto koncových bodů získejte potřebné informace k odstranění verzí souborů.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor tabulky.

ID záznamu
recordId True integer

Jedinečný identifikátor záznamu.

ID pole
fieldId True integer

Jedinečný identifikátor pole.

Číslo verze
versionNumber True integer

Číslo verze přílohy souboru.

Návraty

Odpověď na odstranění souboru
deleteFileResponse

Odstranění relace

Tento koncový bod slouží k odstranění celé relace včetně všech vyhledávacích a souhrnných polí. Referenční pole v relaci se neodstraní.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky. Toto bude podřízená tabulka.

ID relace
relationshipId True double

ID relace. Toto je ID pole referenčního pole v podřízené tabulce.

Návraty

Odpověď na odstranění vztahu
deleteRelationshipResponse

Odstranění tokenu uživatele

Odstraní ověřený token uživatele. To není nevratné.

Návraty

Odpověď na odstranění tokenu uživatele
deleteUserTokenResponse

Odstranění záznamů

Odstraní záznamy v tabulce na základě dotazu. Případně je možné odstranit všechny záznamy v tabulce.

Parametry

Name Klíč Vyžadováno Typ Description
od
from True string

Jedinečný identifikátor tabulky.

where
where True string

Filtr pro odstranění záznamů. Pokud chcete odstranit všechny záznamy, zadejte filtr, který bude obsahovat všechny záznamy, například {3.GT.0}, kde 3 je ID pole ID záznamu.

Návraty

Odpověď odstranit záznamy
deleteRecordsResponse

Odstraňte pole

Odstraní jedno nebo více polí v tabulce na základě ID pole. Tím se také trvale odstraní všechna data nebo výpočty v tomto poli.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor tabulky.

fieldIds
fieldIds True array of integer

Seznam ID polí, které se mají odstranit.

Návraty

Odpověď odstranit pole
deleteFieldsResponse

Odstraňte tabulku

Odstraní konkrétní tabulku v aplikaci, včetně všech dat v ní.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
appId True string

Jedinečný identifikátor aplikace

ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

Návraty

Odpověď na odstranění tabulky
deleteTableResponse

Spuštění sestavy

Spustí sestavu na základě ID a vrátí související data. Formát dat se bude lišit v závislosti na typu sestavy. Sestavy, které se zaměřují na data na úrovni záznamů (tabulka, kalendář atd.), vrátí jednotlivé záznamy. Agregované sestavy (souhrn, graf) vrátí souhrnné informace podle konfigurace v sestavě. Prvky specifické pro uživatelské rozhraní se nevrací, jako jsou součty, průměry a vizualizace. Vrátí data s inteligentní stránkováním na základě přibližné velikosti každého záznamu. Objekt metadat bude obsahovat potřebné informace pro iteraci odpovědi a shromáždění dalších dat.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Identifikátor tabulky pro sestavu.

Přeskočit
skip integer

Počet záznamů, které se mají přeskočit. Tuto hodnotu můžete nastavit při stránkování prostřednictvím sady výsledků.

Vrchol
top integer

Maximální počet záznamů, které se mají vrátit. Výchozí stránkování Quickbase můžete přepsat, abyste získali více nebo méně výsledků. Pokud zde požadovaná hodnota překročí dynamické maximum, vrátíme podmnožinu výsledků a zbytek se dá shromáždit v následných voláních rozhraní API.

object
ID sestavy
reportId True string

Identifikátor sestavy, jedinečný pro tabulku.

Návraty

Spustit odpověď sestavy
runReportResponse

Spuštění vzorce

Umožňuje spuštění vzorce prostřednictvím volání rozhraní API. Tuto metodu ve vlastním kódu použijte k získání hodnoty zpět vzorce bez samostatného pole záznamu.

Parametry

Name Klíč Vyžadováno Typ Description
vzorec
formula True string

Vzorec, který se má spustit. Musí se jednat o platný vzorec Rychlého základu.

zbavit
rid integer

ID záznamu pro spuštění vzorce. Pouze pro vzorce, které se spouštějí v kontextu záznamu. Například vzorec User() nepotřebuje ID záznamu.

od
from True string

Jedinečný identifikátor (dbid) tabulky.

Návraty

Spustit odpověď vzorce
runFormulaResponse

Stažení přílohy

Stáhne přílohu souboru s obsahem přílohy souboru kódovaným ve formátu base64. Odpověď rozhraní API vrátí název souboru v Content-Disposition hlavičce. Meta-data o souborech lze načíst z koncových bodů /records a /reports, kde je to možné. Pomocí těchto koncových bodů získejte potřebné informace k načtení souborů.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor tabulky.

ID záznamu
recordId True integer

Jedinečný identifikátor záznamu.

ID pole
fieldId True integer

Jedinečný identifikátor pole.

Číslo verze
versionNumber True integer

Číslo verze přílohy souboru.

Návraty

response
string

Vložení andor update records

Vložení a/nebo aktualizace záznamů v tabulce V tomto jediném volání rozhraní API je možné odesílat vložení a aktualizace. Aktualizace může použít pole klíče v tabulce nebo jakékoli jiné podporované jedinečné pole. Další informace o formátování jednotlivých typů polí najdete na stránce Typy polí . Tato operace umožňuje přírůstkové zpracování úspěšných záznamů, i když některé záznamy selžou.
Poznámka: Tento koncový bod podporuje maximální velikost datové části 10 MB.

Parametry

Name Klíč Vyžadováno Typ Description
na
to True string

Identifikátor tabulky.

data
data object
mergeFieldId
mergeFieldId integer

ID slučovacího pole.

fieldsToReturn
fieldsToReturn array of integer

Zadejte pole ID polí, které vrátí data pro všechny aktualizace nebo přidaný záznam. ID záznamu (FID 3) se vždy vrátí, pokud se požaduje nějaké ID pole.

Návraty

Úspěšná odpověď, která obsahuje podrobnosti o přidaných, aktualizovaných nebo nezměněných záznamech. V následujícím příkladu měla tabulka dříve deset záznamů s ID od 1 do 10. Uživatel publikuje upsert, který aktualizuje hodnotu záznamu 1 a přidá dva nové záznamy, všechny úspěšně.

Odpověď upsertu
upsertResponse

Vytvoření aplikace

Vytvoří aplikaci v účtu. V příslušném účtu musíte mít práva k vytvoření aplikace. Pomocí tohoto rozhraní API je možné nastavit hlavní vlastnosti a proměnné aplikace.

Parametry

Name Klíč Vyžadováno Typ Description
assignToken
assignToken boolean

Pokud chcete aplikaci přiřadit k tokenu uživatele, který jste použili k vytvoření aplikace, nastavte na hodnotu true. Výchozí hodnota je false.

název
name True string

Název proměnné.

value
value True string

Hodnota proměnné.

název
name True string

Název aplikace. Ve stejné sférě můžete vytvořit více aplikací se stejným názvem, protože budou mít různé hodnoty dbid. Žádáme vás, abyste byli opatrní, abyste to udělali.

popis
description string

Popis aplikace Pokud je tato vlastnost vynecháná, popis aplikace bude prázdný.

Návraty

Vytvoření odpovědi aplikace
createAppResponse

Vytvoření pole

Vytvoří pole v tabulce, včetně vlastních oprávnění daného pole.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor tabulky.

Auditovány
audited boolean

Označuje, jestli je pole sledováno jako součást protokolů auditu Quickbase. Tuto vlastnost můžete nastavit jenom na true, pokud má aplikace povolené protokoly auditu. Viz Povolení protokolů změn dat v části Protokoly auditu QuickBase.

fieldHelp
fieldHelp string

Nakonfigurovaný text nápovědy zobrazený uživatelům v rámci produktu.

bold
bold boolean

Označuje, jestli je pole nakonfigurované tak, aby se v produktu zobrazovala tučně.

comments
comments string

Komentáře zadané ve vlastnostech pole správcem.

doTotal
doesTotal boolean

Určuje, jestli se toto pole součet v sestavách v rámci produktu.

automatické ukládání
autoSave boolean

Určuje, jestli se pole odkazu automaticky uloží.

defaultValueLuid
defaultValueLuid integer

Výchozí hodnota ID uživatele

maxVersions
maxVersions integer

Maximální počet verzí nakonfigurovaných pro přílohu souboru.

format
format integer

Formát pro zobrazení času.

carryChoices
carryChoices boolean

Určuje, jestli má pole při kopírování obsahovat pole s více volbami.

maximální délka
maxLength integer

Maximální početznakůch

linkText
linkText string

Nakonfigurovaná textová hodnota, která nahrazuje adresu URL, kterou uživatelé uvidí v rámci produktu.

parentFieldId
parentFieldId integer

ID nadřazeného složeného pole, pokud je to možné.

displayTimezone
displayTimezone boolean

Určuje, zda se má zobrazit časové pásmo v rámci produktu.

allowNewChoices
allowNewChoices boolean

Označuje, jestli uživatelé můžou do seznamu výběru přidat nové volby.

defaultToday
defaultToday boolean

Určuje, jestli je hodnota pole pro nové záznamy výchozí.

jednotky
units string

Popisek jednotek.

sourceFieldId
sourceFieldId integer

ID zdrojového pole.

doesAverage
doesAverage boolean

Určuje, jestli se toto pole průměruje v sestavách v rámci produktu.

vzorec
formula string

Vzorec pole nakonfigurovaný v quickbase.

decimalPlaces
decimalPlaces integer

Počet desetinných míst zobrazených v produktu pro toto pole

displayMonth
displayMonth string

Jak zobrazit měsíce

seeVersions
seeVersions boolean

Označuje, jestli uživatel uvidí jiné verze kromě nejnovější přílohy souboru v rámci produktu.

numLines
numLines integer

Počet řádků zobrazených v Rychlém základu pro toto textové pole

defaultKind
defaultKind string

Výchozí typ uživatele.

displayEmail
displayEmail string

Způsob zobrazení e-mailu

coverText
coverText string

Alternativní uživatelsky přívětivý text, který lze použít k zobrazení odkazu v prohlížeči.

currencySymbol
currencySymbol string

Aktuální symbol použitý při zobrazení hodnot polí v rámci produktu.

targetFieldId
targetFieldId integer

ID cílového pole.

displayUser
displayUser string

Nakonfigurovaná možnost zobrazení uživatelů v rámci produktu.

blankIsZero
blankIsZero boolean

Zda je prázdná hodnota považována za stejnou jako 0 ve výpočtech v rámci produktu.

přesný
exact boolean

Určuje, jestli je pro odkaz na sestavu vyžadována přesná shoda.

defaultDomain
defaultDomain string

Výchozí e-mailová doména

defaultValue
defaultValue string

Výchozí hodnota nakonfigurovaná pro pole při přidání nového záznamu.

zkrátit
abbreviate boolean

Při zobrazení adresy URL nezobrazovat protokol URL.

formát čísla
numberFormat integer

Formát použitý pro zobrazení číselných hodnot v součinu (desetinné číslo, oddělovače, skupina číslic).

targetTableName
targetTableName string

Název cílové tabulky pole.

zobrazí se jako
appearsAs string

Text odkazu, pokud je prázdný, bude adresa URL použita jako text odkazu.

šířka
width integer

Šířka vstupu html pole v produktu.

Formát měny
currencyFormat string

Formát měny použitý při zobrazení hodnot polí v rámci produktu.

displayImages
displayImages boolean

Určuje, jestli se obrázky budou zobrazovat pro přílohy souborů ve formulářích a sestavách v rámci produktu.

displayDayOfWeek
displayDayOfWeek boolean

Určuje, zda se má zobrazit den v týdnu v rámci produktu.

ČárkaStart
commaStart integer

Počet číslic před čárkami zobrazenými v produktu, pokud je to možné.

choices
choices array of string

Pole položek, které existují pro pole, které nabízí možnosti pro uživatele. Všimněte si, že tyto volby odkazují na platné hodnoty všech záznamů přidaných v budoucnu. Můžete odebrat hodnoty ze seznamu voleb, i když v tomto poli existují záznamy s těmito hodnotami. Když se uživatelé dívají na data v prohlížeči, zobrazí se červeně, ale žádný jiný efekt neexistuje. Při aktualizaci pole s touto vlastností se staré volby odeberou a nahradí novými volbami.

targetTableId
targetTableId string

ID cílové tabulky.

displayRelative
displayRelative boolean

Zda se má zobrazit čas jako relativní.

compositeFields
compositeFields object
displayTime
displayTime boolean

Určuje, jestli se má kromě data zobrazit i čas.

VersionMode
versionMode string

Režimy verzí pro soubory. Zachovat všechny verze vs. zachovat poslední verzi.

snapFieldId
snapFieldId integer

ID pole, ze kterého se hodnoty snímků používají, pokud je to možné.

hodiny 24
hours24 boolean

Určuje, zda se má zobrazit čas ve formátu 24 hodin v rámci produktu.

sortAlpha
sortAlpha boolean

Určuje, jestli se má řadit abecedně, výchozí řazení je podle ID záznamu.

sortAsGiven
sortAsGiven boolean

Určuje, jestli se položky uvedené v seznamu seřadí jako zadané v abecedním pořadí.

hasExtension
hasExtension boolean

Jestli má toto pole linku pro telefon.

useNewWindow
useNewWindow boolean

Označuje, jestli má adresa URL otevřít nové okno, když na ni uživatel klikne v rámci produktu.

appendOnly
appendOnly boolean

Zda je toto pole pouze připojeno.

displayAsLink
displayAsLink boolean

Určuje, jestli se má pole, které je součástí relace, zobrazit jako hypertextový odkaz na nadřazený záznam v rámci produktu.

zobrazeníByDefault
appearsByDefault boolean

Označuje, jestli je pole v sestavách označené jako výchozí.

FieldType2
fieldType True string

Typy polí zobrazíte kliknutím na některý z odkazů na typ pole.

role
role string

Role přidružená k danému oprávnění pro dané pole

permissionType
permissionType string

Oprávnění udělená roli pro toto pole

ID role
roleId integer

ID dané role

addToForms
addToForms boolean

Určuje, jestli se pole, které přidáváte, má zobrazit ve formulářích.

jmenovka
label True string

Popisek (název) pole

findEnabled
findEnabled boolean

Označuje, jestli je pole označené jako prohledávatelné.

noWrap
noWrap boolean

Označuje, jestli je pole nakonfigurované tak, aby se při zobrazení v produktu nezabalila.

Návraty

Odpověď na vytvoření pole
createFieldResponse

Vytvoření tabulky

Vytvoří tabulku v aplikaci.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
appId True string

Jedinečný identifikátor aplikace

název
name True string

Název tabulky.

pluralRecordName
pluralRecordName string

Podstatné jméno v množném čísle pro záznamy v tabulce. Pokud se tato hodnota nepředá, výchozí hodnota je Records(Záznamy).

singleRecordName
singleRecordName string

Jedno podstatné jméno pro záznamy v tabulce. Pokud se tato hodnota nepředá, výchozí hodnota je Record (Záznam).

popis
description string

Popis tabulky. Pokud se tato hodnota nepředá, je výchozí hodnota prázdná.

Návraty

Vytvoření odpovědi na tabulku
createTableResponse

Vytvoření vztahu

Vytvoří relaci v tabulce i vyhledávací a souhrnná pole. Relace se dají vytvářet jenom pro tabulky ve stejné aplikaci.

Parametry

Name Klíč Vyžadováno Typ Description
summaryFid
summaryFid double

ID pole, které chcete sumarizovat.

jmenovka
label string

Popisek souhrnného pole

AkumulaceType
accumulationType True string

Typ akumulace pro souhrnné pole.

where
where string

Filtr pomocí dotazovacího jazyka Quickbase, který určuje záznamy, které se mají vrátit.

lookupFieldIds
lookupFieldIds array of integer

Pole ID polí v nadřazené tabulce, která se stane vyhledávacími poli v podřízené tabulce.

parentTableId
parentTableId True string

ID nadřazené tabulky pro relaci.

jmenovka
label string

Popisek pole cizího klíče.

ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky. Toto bude podřízená tabulka.

Návraty

Odpověď na vytvoření relace
createRelationshipResponse

Získat pole

Získá vlastnosti jednotlivých polí na základě ID pole.
Vlastnosti, které jsou přítomné na všech typech polí, se vrátí na nejvyšší úrovni. Vlastnosti jedinečné pro určitý typ pole jsou vráceny pod atributem properties. Další podrobnosti o vlastnostech jednotlivých typů polí najdete na stránce Typy polí .

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

Zahrnout oprávnění k polím
includeFieldPerms boolean

Pokud chcete získat zpět vlastní oprávnění pro pole, nastavte na true.

ID pole
fieldId True integer

Jedinečný identifikátor (FID) pole.

Návraty

Získání odpovědi pole
getFieldResponse

Získání aplikace

Vrátí hlavní vlastnosti aplikace, včetně proměnných aplikace.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
appId True string

Jedinečný identifikátor aplikace.

Návraty

Získání odpovědi aplikace
getAppResponse

Získání dočasného tokenu pro DBID

Tento koncový bod slouží k získání dočasného autorizačního tokenu s oborem aplikace nebo tabulky. Tento token pak můžete použít k provádění dalších volání rozhraní API (viz autorizace). Platnost tohoto tokenu vyprší za 5 minut.

Parametry

Name Klíč Vyžadováno Typ Description
Token aplikace
QB-App-Token string

Token aplikace QuickBase

DBID
dbid True string

Jedinečný identifikátor aplikace nebo tabulky.

Návraty

getTempTokenDBIDResponse
getTempTokenDBIDResponse

Získání polí pro tabulku

Získá vlastnosti pro všechna pole v konkrétní tabulce. Vlastnosti pro každé pole jsou stejné jako v poli Získat.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

Zahrnout oprávnění k polím
includeFieldPerms boolean

Pokud chcete získat zpět vlastní oprávnění pro pole, nastavte na true.

Návraty

Name Cesta Typ Description
array of object
ID
id integer

Identifikátor.

Označení
label string

Popisek.

Typ pole
fieldType string

Typ pole.

Bez obtékání
noWrap boolean

Zda neexistuje žádné zabalení.

Bold
bold boolean

Bez ohledu na to, jestli je tučné.

Povinné
required boolean

Bez ohledu na to, jestli je to potřeba.

Zobrazí se ve výchozím nastavení.
appearsByDefault boolean

Určuje, jestli se ve výchozím nastavení zobrazuje.

Najít povoleno
findEnabled boolean

Určuje, jestli je povolené hledání.

Jedinečný
unique boolean

Bez ohledu na to, jestli je jedinečný.

Kopíruje data
doesDataCopy boolean

Určuje, jestli data kopírují.

Nápověda k poli
fieldHelp string

Nápověda k poli.

Auditovány
audited boolean

Zda je auditováno.

Primární klíč
properties.primaryKey boolean

Určuje, jestli primární klíč.

Cizí klíč
properties.foreignKey boolean

Zda cizí klíč.

Num Lines
properties.numLines integer

Počet řádků.

Maximální délka
properties.maxLength integer

Maximální délka.

Pouze připojení
properties.appendOnly boolean

Zda je pouze připojení.

allowHTML
properties.allowHTML boolean

Určuje, jestli chcete povolit HTML.

Seřadit podle zadaného
properties.sortAsGiven boolean

Určuje, jestli je seřazeno jako dané.

Přenést volby
properties.carryChoices boolean

Zda se mají provádět volby.

Povolit nové volby
properties.allowNewChoices boolean

Jestli chcete povolit nové volby.

Formula
properties.formula string

Vzorec.

Výchozí hodnota
properties.defaultValue string

Výchozí hodnota

Formát čísla
properties.numberFormat integer

Formát čísla.

Desetinná místa
properties.decimalPlaces integer

Desetinná místa.

Dělá průměr
properties.doesAverage boolean

Určuje, jestli průměr dělá.

Dělá celkem
properties.doesTotal boolean

Určuje, jestli se součet provede.

Prázdné je nula.
properties.blankIsZero boolean

Určuje, jestli je prázdná hodnota nula.

Povolení
permissions array of object
Typ oprávnění
permissions.permissionType string

Typ oprávnění.

Role
permissions.role string

Role.

Role ID
permissions.roleId integer

Identifikátor role.

Přidat do formulářů
addToForms boolean

Zda se má přidat do formulářů.

Získání sestavy

Získejte schéma (vlastnosti) jednotlivé sestavy.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor tabulky.

ID sestavy
reportId True string

Identifikátor sestavy, jedinečný pro tabulku.

Návraty

Získání odpovědi na sestavu
getReportResponse

Získání tabulek pro aplikaci

Získá seznam všech tabulek, které existují v konkrétní aplikaci. Vlastnosti pro každou tabulku jsou stejné jako vlastnosti vrácené v tabulce Get.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
appId True string

Jedinečný identifikátor aplikace

Návraty

Name Cesta Typ Description
array of object
Název
name string

Název.

Vytvořené
created string

Při vytváření.

Updated
updated string

Po aktualizaci.

Alias
alias string

Alias.

Description
description string

Popis.

ID
id string

Identifikátor.

ID dalšího záznamu
nextRecordId integer

Identifikátor dalšího záznamu.

ID dalšího pole
nextFieldId integer

Identifikátor dalšího pole.

Výchozí ID pole řazení
defaultSortFieldId integer

Identifikátor výchozího pole řazení.

Výchozí pořadí řazení
defaultSortOrder string

Výchozí pořadí řazení.

ID pole klíče
keyFieldId integer

Identifikátor pole klíče.

Název jednoho záznamu
singleRecordName string

Název jednoho záznamu.

Název záznamu v množném čísle
pluralRecordName string

Název záznamu v množném čísle

Limit velikosti
sizeLimit string

Omezení velikosti.

Využité místo
spaceUsed string

Využité místo.

Zbývající mezera
spaceRemaining string

Zbývající místo.

Získání tabulky

Získá vlastnosti jednotlivé tabulky, která je součástí aplikace.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
appId True string

Jedinečný identifikátor aplikace

ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

Návraty

Získání odpovědi na tabulku
getTableResponse

Získání událostí aplikace

Získejte seznam událostí, které se dají aktivovat na základě dat nebo akcí uživatelů v této aplikaci, včetně e-mailových oznámení, připomenutí, odběrů, akcí QB, webhooků, aktivovaných automatizací změn záznamů (nezahrnuje naplánované).

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
appId True string

Jedinečný identifikátor aplikace.

Návraty

Name Cesta Typ Description
array of object
Typ
type string

Typ.

Email
owner.email string

E-mailová adresa vlastníka

ID
owner.id string

Identifikátor vlastníka.

Název
owner.name string

Jméno vlastníka.

Uživatelské jméno
owner.userName string

Uživatelské jméno vlastníka.

Je aktivní
isActive boolean

Zda je aktivní.

ID tabulky
tableId string

Identifikátor tabulky.

Název
name string

Název.

URL
url string

Adresa URL.

Získání využití polí

Získejte statistiku využití pro jednotlivá pole. Toto je souhrn informací, které najdete v tabulce využití vlastností polí.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

ID pole
fieldId True integer

Jedinečný identifikátor (FID) pole.

Návraty

Name Cesta Typ Description
array of object
ID
field.id integer

Identifikátor.

Název
field.name string

Název.

Typ
field.type string

Typ.

Počet
usage.actions.count integer

Počet.

Počet
usage.appHomePages.count integer

Počet.

Počet
usage.defaultReports.count integer

Počet.

Počet
usage.exactForms.count integer

Počet.

Počet
usage.fields.count integer

Počet.

Počet
usage.forms.count integer

Počet.

Počet
usage.notifications.count integer

Počet.

Počet
usage.personalReports.count integer

Počet.

Počet
usage.relationships.count integer

Počet.

Počet
usage.reminders.count integer

Počet.

Počet
usage.reports.count integer

Počet.

Počet
usage.roles.count integer

Počet.

Počet
usage.webhooks.count integer

Počet.

Získání využití pro všechna pole

Získejte všechny statistiky využití polí pro tabulku. Toto je souhrn informací, které najdete v tabulce využití vlastností polí.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

Přeskočit
skip integer

Počet polí, která se mají ze seznamu přeskočit.

Vrchol
top integer

Maximální počet polí, která se mají vrátit.

Návraty

Name Cesta Typ Description
array of object
ID
field.id integer

Identifikátor.

Název
field.name string

Název.

Typ
field.type string

Typ.

Počet
usage.actions.count integer

Počet.

Počet
usage.appHomePages.count integer

Počet.

Počet
usage.defaultReports.count integer

Počet.

Počet
usage.exactForms.count integer

Počet.

Počet
usage.fields.count integer

Počet.

Počet
usage.forms.count integer

Počet.

Počet
usage.notifications.count integer

Počet.

Počet
usage.personalReports.count integer

Počet.

Počet
usage.relationships.count integer

Počet.

Počet
usage.reminders.count integer

Počet.

Počet
usage.reports.count integer

Počet.

Počet
usage.roles.count integer

Počet.

Počet
usage.webhooks.count integer

Počet.

Získání všech relací

Získejte seznam všech relací a jejich definic pro konkrétní tabulku. Podrobnosti jsou k dispozici pro nadřazenou i podřízenou stranu relací v rámci dané aplikace. Pro relace mezi aplikacemi se vrátí omezené podrobnosti.

Parametry

Name Klíč Vyžadováno Typ Description
Přeskočit
skip integer

Počet relací, které se mají přeskočit.

ID tabulky
tableId True string

Jedinečný identifikátor (DBID) tabulky.

Návraty

Získání odpovědi na relace
getRelationshipsResponse

Získání všech sestav tabulek

Získejte schéma (vlastnosti) všech sestav pro tabulku. Pokud je uživatel, na kterém rozhraní API běží, správce aplikace, vrátí rozhraní API také všechny osobní sestavy s ID uživatele vlastníka.

Parametry

Name Klíč Vyžadováno Typ Description
ID tabulky
tableId True string

Jedinečný identifikátor tabulky.

Návraty

Name Cesta Typ Description
array of object
ID
id string

Identifikátor.

Název
name string

Název.

Typ
type string

Typ.

Description
description string

Popis.

ID vlastníka
ownerId string

Identifikátor vlastníka.

Použité naposledy
usedLast string

Při použití naposledy.

Použitý počet
usedCount integer

Použitý počet.

Definice

createAppResponse

Name Cesta Typ Description
název
name string

Název aplikace. Ve stejné sférě můžete vytvořit více aplikací se stejným názvem, protože budou mít různé hodnoty dbid. Žádáme vás, abyste byli opatrní, abyste to udělali.

popis
description string

Popis aplikace Pokud je tato vlastnost vynecháná, popis aplikace bude prázdný.

vytvořil
created string

Čas a datum vytvoření aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

aktualizovaný
updated string

Čas a datum poslední aktualizace aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

dateFormat
dateFormat string

Popis formátu použitého při zobrazení hodnot kalendářních dat v této aplikaci. Všimněte si, že se jedná o parametr jen v prohlížeči – podívejte se na stránku podrobností o typu pole v průvodci rozhraním API, kde najdete informace o tom, jak se časové hodnoty vrací ve voláních rozhraní API. Viz Informace o lokalizaci kalendářních dat pro nastavení formátu data aplikace.

timeZone
timeZone string

Popis časového pásma použitého při zobrazení časových hodnot v této aplikaci Všimněte si, že se jedná o parametr jen pro prohlížeč – podívejte se na stránku podrobností o typu pole na portálu, kde najdete informace o tom, jak se hodnoty času vrací ve voláních rozhraní API. Viz Nastavení časového pásma pro aplikaci i účet pro nastavení časového pásma aplikace.

identifikační číslo
id string

Jedinečný identifikátor této aplikace.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Určuje, jestli aplikace zahrnuje přístup ke všem uživatelům na internetu. Viz Sdílení aplikací se všemi na internetu (EOTI).

variables
variables array of Variable1

Proměnné aplikace. Další informace o proměnných aplikace

dataClassification
dataClassification string

Popisek klasifikace dat přiřazený aplikaci. Pokud není zapnutá klasifikace dat, tato funkce se nevrátí. Pokud je klasifikace dat zapnutá, ale aplikace není označená, vrátíme hodnotu Žádná. Popisky klasifikace dat je možné přidat do konzoly pro správu správcem sféry pro plány Platformy+ .

Proměnná 1

Name Cesta Typ Description
název
name string

Název proměnné.

value
value string

Proměnná hodnota.

getAppResponse

Name Cesta Typ Description
název
name string

Název aplikace. Ve stejné sférě můžete vytvořit více aplikací se stejným názvem, protože budou mít různé hodnoty dbid. Žádáme vás, abyste byli opatrní, abyste to udělali.

popis
description string

Popis aplikace Pokud je tato vlastnost vynecháná, popis aplikace bude prázdný.

vytvořil
created string

Čas a datum vytvoření aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

aktualizovaný
updated string

Čas a datum poslední aktualizace aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

dateFormat
dateFormat string

Popis formátu použitého při zobrazení hodnot kalendářních dat v této aplikaci. Všimněte si, že se jedná o parametr jen v prohlížeči – podívejte se na stránku podrobností o typu pole v průvodci rozhraním API, kde najdete informace o tom, jak se časové hodnoty vrací ve voláních rozhraní API. Viz Informace o lokalizaci kalendářních dat pro nastavení formátu data aplikace.

timeZone
timeZone string

Popis časového pásma použitého při zobrazení časových hodnot v této aplikaci Všimněte si, že se jedná o parametr jen pro prohlížeč – podívejte se na stránku podrobností o typu pole na portálu, kde najdete informace o tom, jak se hodnoty času vrací ve voláních rozhraní API. Viz Nastavení časového pásma pro aplikaci i účet pro nastavení časového pásma aplikace.

identifikační číslo
id string

Jedinečný identifikátor této aplikace.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Určuje, jestli aplikace zahrnuje přístup ke všem uživatelům na internetu. Viz Sdílení aplikací se všemi na internetu (EOTI).

variables
variables array of Variable1

Proměnné aplikace. Další informace o proměnných aplikace

dataClassification
dataClassification string

Popisek klasifikace dat přiřazený aplikaci. Pokud není zapnutá klasifikace dat, tato funkce se nevrátí. Pokud je klasifikace dat zapnutá, ale aplikace není označená, vrátíme hodnotu Žádná. Popisky klasifikace dat je možné přidat do konzoly pro správu správcem sféry pro plány Platformy+ .

updateAppResponse

Name Cesta Typ Description
název
name string

Název aplikace. Ve stejné sférě můžete vytvořit více aplikací se stejným názvem, protože budou mít různé hodnoty dbid. Žádáme vás, abyste byli opatrní, abyste to udělali.

popis
description string

Popis aplikace Pokud je tato vlastnost vynecháná, popis aplikace bude prázdný.

vytvořil
created string

Čas a datum vytvoření aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

aktualizovaný
updated string

Čas a datum poslední aktualizace aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

dateFormat
dateFormat string

Popis formátu použitého při zobrazení hodnot kalendářních dat v této aplikaci. Všimněte si, že se jedná o parametr jen v prohlížeči – podívejte se na stránku podrobností o typu pole v průvodci rozhraním API, kde najdete informace o tom, jak se časové hodnoty vrací ve voláních rozhraní API. Viz Informace o lokalizaci kalendářních dat pro nastavení formátu data aplikace.

timeZone
timeZone string

Popis časového pásma použitého při zobrazení časových hodnot v této aplikaci Všimněte si, že se jedná o parametr jen pro prohlížeč – podívejte se na stránku podrobností o typu pole na portálu, kde najdete informace o tom, jak se hodnoty času vrací ve voláních rozhraní API. Viz Nastavení časového pásma pro aplikaci i účet pro nastavení časového pásma aplikace.

identifikační číslo
id string

Jedinečný identifikátor této aplikace.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Určuje, jestli aplikace zahrnuje přístup ke všem uživatelům na internetu. Viz Sdílení aplikací se všemi na internetu (EOTI).

variables
variables array of Variable1

Proměnné aplikace. Další informace o proměnných aplikace

dataClassification
dataClassification string

Popisek klasifikace dat přiřazený aplikaci. Pokud není zapnutá klasifikace dat, tato funkce se nevrátí. Pokud je klasifikace dat zapnutá, ale aplikace není označená, vrátíme hodnotu Žádná. Popisky klasifikace dat je možné přidat do konzoly pro správu správcem sféry pro plány Platformy+ .

deleteAppResponse

Name Cesta Typ Description
deletedAppId
deletedAppId string

ID odstraněné aplikace.

copyAppResponse

Name Cesta Typ Description
název
name string

Název aplikace. Ve stejné sférě můžete vytvořit více aplikací se stejným názvem, protože budou mít různé hodnoty dbid. Žádáme vás, abyste byli opatrní, abyste to udělali.

popis
description string

Popis aplikace

vytvořil
created string

Čas a datum vytvoření aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

aktualizovaný
updated string

Čas a datum poslední aktualizace aplikace ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

dateFormat
dateFormat string

Popis formátu použitého při zobrazení hodnot kalendářních dat v této aplikaci. Všimněte si, že se jedná o parametr jen v prohlížeči – podívejte se na stránku podrobností o typu pole v průvodci rozhraním API, kde najdete informace o tom, jak se časové hodnoty vrací ve voláních rozhraní API. Viz Informace o lokalizaci kalendářních dat pro nastavení formátu data aplikace.

timeZone
timeZone string

Popis časového pásma použitého při zobrazení časových hodnot v této aplikaci Všimněte si, že se jedná o parametr jen pro prohlížeč – podívejte se na stránku podrobností o typu pole na portálu, kde najdete informace o tom, jak se hodnoty času vrací ve voláních rozhraní API. Viz Nastavení časového pásma pro aplikaci i účet pro nastavení časového pásma aplikace.

identifikační číslo
id string

Jedinečný identifikátor této aplikace.

hasEveryoneOnTheInternet
hasEveryoneOnTheInternet boolean

Určuje, jestli aplikace zahrnuje přístup ke všem uživatelům na internetu. Viz Sdílení aplikací se všemi na internetu (EOTI).

variables
variables array of Variable1

Proměnné aplikace. Další informace o proměnných aplikace

id nadřazené položky
ancestorId string

ID aplikace, ze které byla tato aplikace zkopírována

dataClassification
dataClassification string

Popisek klasifikace dat přiřazený aplikaci. Pokud není zapnutá klasifikace dat, tato funkce se nevrátí. Pokud je klasifikace dat zapnutá, ale aplikace není označená, vrátíme hodnotu Žádná. Popisky klasifikace dat je možné přidat do konzoly pro správu správcem sféry pro plány Platformy+ .

createTableResponse

Name Cesta Typ Description
název
name string

Název tabulky.

identifikační číslo
id string

Jedinečný identifikátor (dbid) tabulky.

alias
alias string

Automaticky vytvořený alias tabulky pro tabulku.

popis
description string

Popis tabulky nakonfigurovaný správcem aplikace.

vytvořil
created string

Čas a datum vytvoření tabulky ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

aktualizovaný
updated string

Čas a datum poslední aktualizace schématu tabulky nebo dat ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

nextRecordId
nextRecordId integer

PŘÍRŮSTKOVÉ ID záznamu, které se použije při vytvoření dalšího záznamu podle toho, kdy bylo volání rozhraní API spuštěno.

nextFieldId
nextFieldId integer

Přírůstkové ID pole, které se použije při vytvoření dalšího pole podle toho, kdy bylo volání rozhraní API spuštěno.

defaultSortFieldId
defaultSortFieldId integer

ID pole, které je nakonfigurováno pro výchozí řazení.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Konfigurace výchozího pořadí řazení v tabulce

keyFieldId
keyFieldId integer

ID pole, které je nakonfigurováno jako klíč v této tabulce, což je obvykle ID záznamu Quickbase.

singleRecordName
singleRecordName string

Konfigurované jednotné jméno tabulky.

pluralRecordName
pluralRecordName string

Konfigurované množné číslo tabulky v množném čísle.

sizeLimit
sizeLimit string

Omezení velikosti tabulky.

prostorové jednotky
spaceUsed string

Množství místa, které tabulka aktuálně používá.

spaceRemaining
spaceRemaining string

Velikost zbývajícího místa pro použití tabulkou.

DefaultSortOrder

Konfigurace výchozího pořadí řazení v tabulce

Konfigurace výchozího pořadí řazení v tabulce

DefaultSortOrder
string

getTableResponse

Name Cesta Typ Description
název
name string

Název tabulky.

identifikační číslo
id string

Jedinečný identifikátor (dbid) tabulky.

alias
alias string

Automaticky vytvořený alias tabulky pro tabulku.

popis
description string

Popis tabulky nakonfigurovaný správcem aplikace.

vytvořil
created string

Čas a datum vytvoření tabulky ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

aktualizovaný
updated string

Čas a datum poslední aktualizace schématu tabulky nebo dat ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

nextRecordId
nextRecordId integer

PŘÍRŮSTKOVÉ ID záznamu, které se použije při vytvoření dalšího záznamu podle toho, kdy bylo volání rozhraní API spuštěno.

nextFieldId
nextFieldId integer

Přírůstkové ID pole, které se použije při vytvoření dalšího pole podle toho, kdy bylo volání rozhraní API spuštěno.

defaultSortFieldId
defaultSortFieldId integer

ID pole, které je nakonfigurováno pro výchozí řazení.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Konfigurace výchozího pořadí řazení v tabulce

keyFieldId
keyFieldId integer

ID pole, které je nakonfigurováno jako klíč v této tabulce, což je obvykle ID záznamu Quickbase.

singleRecordName
singleRecordName string

Konfigurované jednotné jméno tabulky.

pluralRecordName
pluralRecordName string

Konfigurované množné číslo tabulky v množném čísle.

sizeLimit
sizeLimit string

Omezení velikosti tabulky.

prostorové jednotky
spaceUsed string

Množství místa, které tabulka aktuálně používá.

spaceRemaining
spaceRemaining string

Velikost zbývajícího místa pro použití tabulkou.

updateTableResponse

Name Cesta Typ Description
název
name string

Název tabulky.

identifikační číslo
id string

Jedinečný identifikátor (dbid) tabulky.

alias
alias string

Automaticky vytvořený alias tabulky pro tabulku.

popis
description string

Popis tabulky nakonfigurovaný správcem aplikace.

vytvořil
created string

Čas a datum vytvoření tabulky ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

aktualizovaný
updated string

Čas a datum poslední aktualizace schématu tabulky nebo dat ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

nextRecordId
nextRecordId integer

PŘÍRŮSTKOVÉ ID záznamu, které se použije při vytvoření dalšího záznamu podle toho, kdy bylo volání rozhraní API spuštěno.

nextFieldId
nextFieldId integer

Přírůstkové ID pole, které se použije při vytvoření dalšího pole podle toho, kdy bylo volání rozhraní API spuštěno.

defaultSortFieldId
defaultSortFieldId integer

ID pole, které je nakonfigurováno pro výchozí řazení.

DefaultSortOrder
defaultSortOrder DefaultSortOrder

Konfigurace výchozího pořadí řazení v tabulce

keyFieldId
keyFieldId integer

ID pole, které je nakonfigurováno jako klíč v této tabulce, což je obvykle ID záznamu Quickbase.

singleRecordName
singleRecordName string

Konfigurované jednotné jméno tabulky.

pluralRecordName
pluralRecordName string

Konfigurované množné číslo tabulky v množném čísle.

sizeLimit
sizeLimit string

Omezení velikosti tabulky.

prostorové jednotky
spaceUsed string

Množství místa, které tabulka aktuálně používá.

spaceRemaining
spaceRemaining string

Velikost zbývajícího místa pro použití tabulkou.

deleteTableResponse

Name Cesta Typ Description
deletedTableId
deletedTableId string

ID odstraněné tabulky.

getRelationshipsResponse

Name Cesta Typ Description
vztahy
relationships array of Relationship

Relace v tabulce.

Metadatové informace
metadata Metadata

Další informace o výsledcích, které mohou být užitečné.

Vztah

Name Cesta Typ Description
identifikační číslo
id integer

ID relace (ID pole cizího klíče).

parentTableId
parentTableId string

ID nadřazené tabulky relace.

childTableId
childTableId string

ID podřízené tabulky relace.

ForeignKeyField
foreignKeyField ForeignKeyField

Informace o poli cizího klíče.

isCrossApp
isCrossApp boolean

Určuje, jestli se jedná o relaci mezi aplikacemi.

vyhledávací pole
lookupFields array of LookupField

Pole vyhledávacích polí.

summaryFields
summaryFields array of SummaryField

Pole souhrnných polí.

ForeignKeyField

Informace o poli cizího klíče.

Name Cesta Typ Description
identifikační číslo
id integer

ID pole.

jmenovka
label string

Popisek pole

typ
type string

Typ pole.

Vyhledávací pole

Name Cesta Typ Description
identifikační číslo
id integer

ID pole.

jmenovka
label string

Popisek pole

typ
type string

Typ pole.

SummaryField

Name Cesta Typ Description
identifikační číslo
id integer

ID pole.

jmenovka
label string

Popisek pole

typ
type string

Typ pole.

Metadatové informace

Další informace o výsledcích, které mohou být užitečné.

Name Cesta Typ Description
přeskočit
skip integer

Počet relací, které se mají přeskočit.

totalRelationships
totalRelationships integer

Celkový počet relací.

numRelationships
numRelationships integer

Početrelacích

createRelationshipResponse

Name Cesta Typ Description
identifikační číslo
id integer

ID relace (ID pole cizího klíče).

parentTableId
parentTableId string

ID nadřazené tabulky relace.

childTableId
childTableId string

ID podřízené tabulky relace.

ForeignKeyField
foreignKeyField ForeignKeyField

Informace o poli cizího klíče.

isCrossApp
isCrossApp boolean

Určuje, jestli se jedná o relaci mezi aplikacemi.

vyhledávací pole
lookupFields array of LookupField

Pole vyhledávacích polí.

summaryFields
summaryFields array of SummaryField

Pole souhrnných polí.

updateRelationshipResponse

Name Cesta Typ Description
identifikační číslo
id integer

ID relace (ID pole cizího klíče).

parentTableId
parentTableId string

ID nadřazené tabulky relace.

childTableId
childTableId string

ID podřízené tabulky relace.

ForeignKeyField
foreignKeyField ForeignKeyField

Informace o poli cizího klíče.

isCrossApp
isCrossApp boolean

Určuje, jestli se jedná o relaci mezi aplikacemi.

vyhledávací pole
lookupFields array of LookupField

Pole vyhledávacích polí.

summaryFields
summaryFields array of SummaryField

Pole souhrnných polí.

deleteRelationshipResponse

Name Cesta Typ Description
relationshipId
relationshipId integer

ID relace.

Query

Definice dotazu nakonfigurovaná v QuickBase, která se spustí při spuštění sestavy.

Name Cesta Typ Description
tableId
tableId string

Identifikátor tabulky pro sestavu.

filtr
filter string

Filtr použitý k dotazování na data.

formulaFields
formulaFields array of FormulaField

Pole počítaných vzorců

FormulaField

Name Cesta Typ Description
identifikační číslo
id integer

Identifikátor pole vzorce

jmenovka
label string

Popisek pole vzorce

FieldType
fieldType FieldType

Výsledný typ hodnoty vzorce

vzorec
formula string

Text vzorce

decimalPrecision
decimalPrecision integer

Pro číselný vzorec přesnost čísel.

FieldType

Výsledný typ hodnoty vzorce

Výsledný typ hodnoty vzorce

FieldType
string

getReportResponse

Name Cesta Typ Description
identifikační číslo
id string

Identifikátor sestavy, jedinečný pro tabulku.

název
name string

Nakonfigurovaný název sestavy.

typ
type string

Typ sestavy v Quickbase (např. graf).

popis
description string

Nakonfigurovaný popis sestavy.

ID vlastníka
ownerId integer

Volitelné, zobrazuje se jenom pro osobní sestavy. ID uživatele vlastníka sestavy.

Query
query Query

Definice dotazu nakonfigurovaná v QuickBase, která se spustí při spuštění sestavy.

vlastnosti
properties object

Seznam vlastností specifických pro typ sestavy. Pokud chcete zobrazit podrobný popis vlastností pro každý typ sestavy, podívejte se na typy sestav.

usedLast
usedLast string

Okamžik, kdy byla sestava naposledy použita.

usedCount
usedCount integer

Kolikrát byla sestava použita.

runReportResponse

Name Cesta Typ Description
pole
fields array of Field

Pole objektů, které obsahují omezená metadata každého pole zobrazeného v sestavě. To pomáhá při vytváření logiky, která závisí na typech polí a ID.

data
data array of object

Pole objektů, které buď představují data záznamu, nebo souhrnné hodnoty v závislosti na typu sestavy.

items
data object
Metadata1
metadata Metadata1

Další informace o výsledcích, které mohou být užitečné. Stránkování může být potřeba, pokud zadáte menší počet výsledků, které se mají přeskočit, než je k dispozici, nebo pokud rozhraní API automaticky vrátí méně výsledků. numZáznamy lze porovnat s celkovýmizáznamy, abyste zjistili, jestli je potřeba další stránkování.

Obor

Name Cesta Typ Description
identifikační číslo
id integer

ID pole.

jmenovka
label string

Popisek pole

typ
type string

Typ pole.

labelOverride
labelOverride string

Přepsání popisku záhlaví sloupce pro pole v sestavě

Metadata1

Další informace o výsledcích, které mohou být užitečné. Stránkování může být potřeba, pokud zadáte menší počet výsledků, které se mají přeskočit, než je k dispozici, nebo pokud rozhraní API automaticky vrátí méně výsledků. numZáznamy lze porovnat s celkovýmizáznamy, abyste zjistili, jestli je potřeba další stránkování.

Name Cesta Typ Description
přeskočit
skip integer

Počet záznamů, které se mají přeskočit

numFields
numFields integer

Počet polí v každém záznamu v aktuálním objektu odpovědi

top
top integer

Pokud je k dispozici, maximální počet záznamů požadovaných volajícím

totalRecords
totalRecords integer

Celkový počet záznamů v sadě výsledků

numRecords
numRecords integer

Počet záznamů v aktuálním objektu odpovědi

Vlastnosti 1

Další vlastnosti pole Další podrobnosti o vlastnostech jednotlivých typů polí najdete na stránce podrobností o typu pole.

Name Cesta Typ Description
comments
comments string

Komentáře zadané ve vlastnostech pole správcem.

doTotal
doesTotal boolean

Určuje, jestli se toto pole součet v sestavách v rámci produktu.

automatické ukládání
autoSave boolean

Určuje, jestli se pole odkazu automaticky uloží.

defaultValueLuid
defaultValueLuid integer

Výchozí hodnota ID uživatele

maxVersions
maxVersions integer

Maximální počet verzí nakonfigurovaných pro přílohu souboru.

carryChoices
carryChoices boolean

Určuje, jestli má pole při kopírování obsahovat pole s více volbami.

format
format integer

Formát pro zobrazení času.

maximální délka
maxLength integer

Maximální početznakůch

linkText
linkText string

Nakonfigurovaná textová hodnota, která nahrazuje adresu URL, kterou uživatelé uvidí v rámci produktu.

parentFieldId
parentFieldId integer

ID nadřazeného složeného pole, pokud je to možné.

displayTimezone
displayTimezone boolean

Určuje, zda se má zobrazit časové pásmo v rámci produktu.

summaryTargetFieldId
summaryTargetFieldId integer

ID pole, které se používá k agregaci hodnot z podřízeného pole, pokud je to možné. Zobrazí se hodnota 0, pokud souhrnná funkce nevyžaduje výběr pole (například počet).

allowNewChoices
allowNewChoices boolean

Označuje, jestli uživatelé můžou do seznamu výběru přidat nové volby.

masterChoiceFieldId
masterChoiceFieldId integer

ID pole, které je odkazem v relaci.

defaultToday
defaultToday boolean

Určuje, jestli je hodnota pole pro nové záznamy výchozí.

jednotky
units string

Popisek jednotek.

lookupTargetFieldId
lookupTargetFieldId integer

ID pole, které je cílem hlavní tabulky pro toto vyhledávání.

SummaryFunction
summaryFunction SummaryFunction

Typ souhrnné akumulace funkce.

sourceFieldId
sourceFieldId integer

ID zdrojového pole.

masterTableTag
masterTableTag string

Alias tabulky pro hlavní tabulku v relaci je toto pole součástí.

doesAverage
doesAverage boolean

Určuje, jestli se toto pole průměruje v sestavách v rámci produktu.

vzorec
formula string

Vzorec pole nakonfigurovaný v quickbase.

decimalPlaces
decimalPlaces integer

Počet desetinných míst zobrazených v produktu pro toto pole

seeVersions
seeVersions boolean

Označuje, jestli uživatel uvidí jiné verze kromě nejnovější přílohy souboru v rámci produktu.

displayMonth
displayMonth string

Jak zobrazit měsíce

numLines
numLines integer

Počet řádků zobrazených v Rychlém základu pro toto textové pole

displayEmail
displayEmail string

Způsob zobrazení e-mailu

defaultKind
defaultKind string

Výchozí typ uživatele.

coverText
coverText string

Alternativní uživatelsky přívětivý text, který lze použít k zobrazení odkazu v prohlížeči.

currencySymbol
currencySymbol string

Aktuální symbol použitý při zobrazení hodnot polí v rámci produktu.

masterChoiceTableId
masterChoiceTableId integer

ID tabulky, která je hlavním objektem v této relaci.

targetFieldId
targetFieldId integer

ID cílového pole.

displayUser
displayUser string

Nakonfigurovaná možnost zobrazení uživatelů v rámci produktu.

blankIsZero
blankIsZero boolean

Zda je prázdná hodnota považována za stejnou jako 0 ve výpočtech v rámci produktu.

přesný
exact boolean

Určuje, jestli je pro odkaz na sestavu vyžadována přesná shoda.

startField
startField integer

ID počátečního pole.

defaultDomain
defaultDomain string

Výchozí e-mailová doména

defaultValue
defaultValue string

Výchozí hodnota nakonfigurovaná pro pole při přidání nového záznamu.

choicesLuid
choicesLuid array of object

Seznam uživatelských voleb

items
choicesLuid object
zkrátit
abbreviate boolean

Při zobrazení adresy URL nezobrazovat protokol URL.

xmlTag
xmlTag string

Značka XML pole.

targetTableName
targetTableName string

Název cílové tabulky pole.

formát čísla
numberFormat integer

Formát použitý pro zobrazení číselných hodnot v součinu (desetinné číslo, oddělovače, skupina číslic).

zobrazí se jako
appearsAs string

Text odkazu, pokud je prázdný, bude adresa URL použita jako text odkazu.

šířka
width integer

Šířka vstupu html pole v produktu.

Formát měny
currencyFormat CurrencyFormat

Formát měny použitý při zobrazení hodnot polí v rámci produktu.

displayImages
displayImages boolean

Určuje, jestli se obrázky budou zobrazovat pro přílohy souborů ve formulářích a sestavách v rámci produktu.

foreignKey
foreignKey boolean

Označuje, jestli je pole cizím klíčem (nebo referenčním polem) v relaci.

displayDayOfWeek
displayDayOfWeek boolean

Určuje, zda se má zobrazit den v týdnu v rámci produktu.

summaryReferenceFieldId
summaryReferenceFieldId integer

ID pole, které je odkazem v relaci pro tento souhrn.

ČárkaStart
commaStart integer

Počet číslic před čárkami zobrazenými v produktu, pokud je to možné.

choices
choices array of string

Pole položek, které existují pro pole, které nabízí možnosti pro uživatele.

targetTableId
targetTableId string

ID cílové tabulky.

displayRelative
displayRelative boolean

Zda se má zobrazit čas jako relativní.

compositeFields
compositeFields array of object

Pole polí, která tvoří složené pole (např. adresa).

items
compositeFields object
VersionMode
versionMode VersionMode

Režimy verzí pro soubory. Zachovat všechny verze vs. zachovat poslední verzi.

displayTime
displayTime boolean

Určuje, jestli se má kromě data zobrazit i čas.

durationField
durationField integer

ID pole doby trvání.

snapFieldId
snapFieldId integer

ID pole, ze kterého se hodnoty snímků používají, pokud je to možné.

hodiny 24
hours24 boolean

Určuje, zda se má zobrazit čas ve formátu 24 hodin v rámci produktu.

sortAlpha
sortAlpha boolean

Určuje, jestli se má řadit abecedně, výchozí řazení je podle ID záznamu.

sortAsGiven
sortAsGiven boolean

Určuje, jestli se položky uvedené v seznamu seřadí jako zadané v abecedním pořadí.

hasExtension
hasExtension boolean

Jestli má toto pole linku pro telefon.

workWeek
workWeek integer

Typ pracovního týdne.

useNewWindow
useNewWindow boolean

Označuje, jestli má adresa URL otevřít nové okno, když na ni uživatel klikne v rámci produktu.

appendOnly
appendOnly boolean

Zda je toto pole pouze připojeno.

displayAsLink
displayAsLink boolean

Určuje, jestli se má pole, které je součástí relace, zobrazit jako hypertextový odkaz na nadřazený záznam v rámci produktu.

allowHTML
allowHTML boolean

Určuje, zda toto pole umožňuje html.

lookupReferenceFieldId
lookupReferenceFieldId integer

ID pole, které je odkazem v relaci pro toto vyhledávání.

SummaryFunction

Typ souhrnné akumulace funkce.

Typ souhrnné akumulace funkce.

SummaryFunction
string

Formát měny

Formát měny použitý při zobrazení hodnot polí v rámci produktu.

Formát měny použitý při zobrazení hodnot polí v rámci produktu.

Formát měny
string

VersionMode

Režimy verzí pro soubory. Zachovat všechny verze vs. zachovat poslední verzi.

Režimy verzí pro soubory. Zachovat všechny verze vs. zachovat poslední verzi.

VersionMode
string

Povolení

Name Cesta Typ Description
role
role string

Role přidružená k danému oprávnění pro dané pole

permissionType
permissionType string

Oprávnění udělená roli pro toto pole

ID role
roleId integer

ID dané role

createFieldResponse

Name Cesta Typ Description
identifikační číslo
id integer

ID pole, které je jedinečné pro tuto tabulku.

typ pole
fieldType string

Typ pole, jak je popsáno zde.

mode
mode string

U odvozených polí to bude "vyhledávání", "souhrn" nebo "vzorec", aby bylo možné určit typ odvozeného pole. U jiných než odvozených polí bude toto pole prázdné.

jmenovka
label string

Popisek (název) pole

noWrap
noWrap boolean

Označuje, jestli je pole nakonfigurované tak, aby se při zobrazení v produktu nezabalila.

bold
bold boolean

Označuje, jestli je pole nakonfigurované tak, aby se v produktu zobrazovala tučně.

required
required boolean

Označuje, jestli je pole označené jako povinné.

zobrazeníByDefault
appearsByDefault boolean

Označuje, jestli je pole v sestavách označené jako výchozí.

findEnabled
findEnabled boolean

Označuje, jestli je pole označené jako prohledávatelné.

jedinečný
unique boolean

Označuje, jestli je pole označené jako jedinečné.

doesDataCopy
doesDataCopy boolean

Určuje, jestli se data pole zkopírují, když uživatel záznam zkopíruje.

fieldHelp
fieldHelp string

Nakonfigurovaný text nápovědy zobrazený uživatelům v rámci produktu.

Auditovány
audited boolean

Označuje, jestli je pole sledováno jako součást protokolů auditu Quickbase.

Vlastnosti 1
properties Properties1

Další vlastnosti pole Další podrobnosti o vlastnostech jednotlivých typů polí najdete na stránce podrobností o typu pole.

oprávnění
permissions array of Permission

Oprávnění polí pro různé role

deleteFieldsResponse

Name Cesta Typ Description
deletedFieldIds
deletedFieldIds array of integer

Seznam ID polí, které se mají odstranit.

chyby
errors array of string

Seznam nalezených chyb

getFieldResponse

Name Cesta Typ Description
identifikační číslo
id integer

ID pole, které je jedinečné pro tuto tabulku.

typ pole
fieldType string

Typ pole, jak je popsáno zde.

mode
mode string

U odvozených polí to bude "vyhledávání", "souhrn" nebo "vzorec", aby bylo možné určit typ odvozeného pole. U jiných než odvozených polí bude toto pole prázdné.

jmenovka
label string

Popisek (název) pole

noWrap
noWrap boolean

Označuje, jestli je pole nakonfigurované tak, aby se při zobrazení v produktu nezabalila.

bold
bold boolean

Označuje, jestli je pole nakonfigurované tak, aby se v produktu zobrazovala tučně.

required
required boolean

Označuje, jestli je pole označené jako povinné.

zobrazeníByDefault
appearsByDefault boolean

Označuje, jestli je pole v sestavách označené jako výchozí.

findEnabled
findEnabled boolean

Označuje, jestli je pole označené jako prohledávatelné.

jedinečný
unique boolean

Označuje, jestli je pole označené jako jedinečné.

doesDataCopy
doesDataCopy boolean

Určuje, jestli se data pole zkopírují, když uživatel záznam zkopíruje.

fieldHelp
fieldHelp string

Nakonfigurovaný text nápovědy zobrazený uživatelům v rámci produktu.

Auditovány
audited boolean

Označuje, jestli je pole sledováno jako součást protokolů auditu Quickbase.

Vlastnosti 1
properties Properties1

Další vlastnosti pole Další podrobnosti o vlastnostech jednotlivých typů polí najdete na stránce podrobností o typu pole.

oprávnění
permissions array of Permission

Oprávnění polí pro různé role

updateFieldResponse

Name Cesta Typ Description
identifikační číslo
id integer

ID pole, které je jedinečné pro tuto tabulku.

typ pole
fieldType string

Typ pole, jak je popsáno zde.

mode
mode string

U odvozených polí to bude "vyhledávání", "souhrn" nebo "vzorec", aby bylo možné určit typ odvozeného pole. U jiných než odvozených polí bude toto pole prázdné.

jmenovka
label string

Popisek (název) pole

noWrap
noWrap boolean

Označuje, jestli je pole nakonfigurované tak, aby se při zobrazení v produktu nezabalila.

bold
bold boolean

Označuje, jestli je pole nakonfigurované tak, aby se v produktu zobrazovala tučně.

required
required boolean

Označuje, jestli je pole označené jako povinné.

zobrazeníByDefault
appearsByDefault boolean

Označuje, jestli je pole v sestavách označené jako výchozí.

findEnabled
findEnabled boolean

Označuje, jestli je pole označené jako prohledávatelné.

jedinečný
unique boolean

Označuje, jestli je pole označené jako jedinečné.

doesDataCopy
doesDataCopy boolean

Určuje, jestli se data pole zkopírují, když uživatel záznam zkopíruje.

fieldHelp
fieldHelp string

Nakonfigurovaný text nápovědy zobrazený uživatelům v rámci produktu.

Auditovány
audited boolean

Označuje, jestli je pole sledováno jako součást protokolů auditu Quickbase.

Vlastnosti 1
properties Properties1

Další vlastnosti pole Další podrobnosti o vlastnostech jednotlivých typů polí najdete na stránce podrobností o typu pole.

oprávnění
permissions array of Permission

Oprávnění polí pro různé role

runFormulaResponse

Name Cesta Typ Description
výsledek
result string

Výsledek provádění vzorce.

upsertResponse

Úspěšná odpověď, která obsahuje podrobnosti o přidaných, aktualizovaných nebo nezměněných záznamech. V následujícím příkladu měla tabulka dříve deset záznamů s ID od 1 do 10. Uživatel publikuje upsert, který aktualizuje hodnotu záznamu 1 a přidá dva nové záznamy, všechny úspěšně.

Name Cesta Typ Description
Metadata2
metadata Metadata2

Informace o vytvořených záznamech, aktualizovaných záznamech, odkazovaných, ale nezměněných záznamech a záznamech, které mají při zpracování chyby.

data
data array of object

Očekává se vrácení dat.

items
data object

Metadata2

Informace o vytvořených záznamech, aktualizovaných záznamech, odkazovaných, ale nezměněných záznamech a záznamech, které mají při zpracování chyby.

Name Cesta Typ Description
createdRecordIds
createdRecordIds array of integer

Pole obsahující id vytvořených záznamů.

lineErrors
lineErrors object

Vrátí se pouze v případě neúspěšných záznamů. Jedná se o kolekci chyb, ke kterým došlo při zpracování příchozích dat, které způsobily, že se nezpracovávají záznamy. Každý objekt má klíč představující pořadové číslo záznamu v původní datové části (počínaje 1). Hodnota je seznam chyb, ke kterým došlo.

beze změnyZáznamy
unchangedRecordIds array of integer

Pole obsahující nezměněné ID záznamu.

updatedRecordIds
updatedRecordIds array of integer

Pole obsahující aktualizované ID záznamů.

totalNumberOfRecordsProcessed
totalNumberOfRecordsProcessed integer

Počet zpracovaných záznamů Zahrnuje úspěšné a neúspěšné aktualizace záznamů.

deleteRecordsResponse

Name Cesta Typ Description
numberDeleted
numberDeleted integer

Počet odstraněných záznamů.

runQueryResponse

Name Cesta Typ Description
pole
fields array of Fields2

Pole objektů, které obsahují omezená metadata každého pole zobrazeného v sestavě. To pomáhá při vytváření logiky, která závisí na typech polí a ID.

data
data array of object

Pole objektů, které buď představují data záznamu, nebo souhrnné hodnoty v závislosti na typu sestavy.

items
data object
Metadata1
metadata Metadata1

Další informace o výsledcích, které mohou být užitečné. Stránkování může být potřeba, pokud zadáte menší počet výsledků, které se mají přeskočit, než je k dispozici, nebo pokud rozhraní API automaticky vrátí méně výsledků. numZáznamy lze porovnat s celkovýmizáznamy, abyste zjistili, jestli je potřeba další stránkování.

Pole 2

Name Cesta Typ Description
identifikační číslo
id integer

ID pole.

jmenovka
label string

Popisek pole

typ
type string

Typ pole.

getTempTokenDBIDResponse

Name Cesta Typ Description
dočasná ověřování
temporaryAuthorization string

Dočasný autorizační token.

cloneUserTokenResponse

Name Cesta Typ Description
active
active boolean

Určuje, jestli je token uživatele aktivní.

apps
apps array of App

Seznam aplikací, ke kterým je tento token uživatele přiřazen.

lastUsed
lastUsed string

Datum posledního použití tohoto tokenu uživatele ve formátu ČASU ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (v časovém pásmu UTC).

popis
description string

Popis tokenu uživatele

identifikační číslo
id integer

ID tokenu uživatele.

název
name string

Název tokenu uživatele.

token
token string

Hodnota tokenu uživatele.

Aplikace

Name Cesta Typ Description
identifikační číslo
id string

Jedinečný identifikátor této aplikace.

název
name string

Název aplikace.

deleteUserTokenResponse

Name Cesta Typ Description
identifikační číslo
id integer

ID tokenu uživatele.

deleteFileResponse

Name Cesta Typ Description
versionNumber
versionNumber integer

Počet odstraněných verzí.

fileName
fileName string

Název souboru přidruženého k odstraněné verzi.

Nahrané
uploaded string

Časové razítko, kdy byla verze původně nahraná.

Tvůrce
creator Creator

Uživatel, který nahrál verzi.

Tvůrce

Uživatel, který nahrál verzi.

Name Cesta Typ Description
název
name string

Celé uživatelské jméno.

identifikační číslo
id string

ID uživatele.

e-mail
email string

E-mail uživatele.

userName
userName string

Uživatelské jméno aktualizované ve vlastnostech uživatele. Nepovinný, zobrazí se, pokud není stejný jako e-mail uživatele.

řetězec

Toto je základní datový typ String.