Quickbase (niezależny wydawca)
Quickbase to platforma do tworzenia aplikacji, która łączy zespoły biznesowe i INFORMATYCZNE, umożliwiając rozwiązywanie problemów z dowolnymi doświadczeniami technicznymi, aby bezpiecznie i bezpiecznie tworzyć ekosystem aplikacji. Quickbase pomaga firmom przyspieszyć ciągłe innowacje unikatowych procesów, umożliwiając rozwój obywateli na dużą skalę na jednej wspólnej platformie.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Troy Taylor |
| adres URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadane łącznika | |
|---|---|
| Publisher | Troy Taylor, Firma Solutions |
| Witryna internetowa | https://www.quickbase.com/ |
| Zasady ochrony prywatności | https://www.quickbase.com/privacy |
| Kategorie | Produktywność;operacje IT |
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Nazwa hosta obszaru | ciąg | Określ nazwę hosta obszaru. | Prawda |
| Authorization | securestring | Token użytkownika dla w postaci "QB-USER-TOKEN yourToken". | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie aplikacji |
Aktualizuje główne właściwości i/lub zmienne aplikacji dla określonej aplikacji. Wszelkie właściwości aplikacji, które nie zostaną określone w treści żądania, pozostaną niezmienione. |
| Aktualizowanie pola |
Aktualizuje właściwości i uprawnienia niestandardowe pola. Próba zaktualizowania niektórych właściwości może spowodować, że istniejące dane nie będą już przestrzegać nowych właściwości pola i mogą zostać odrzucone. Zapoznaj się z opisami wymaganych, unikatowych i wybranych poniżej opcji, aby zapoznać się z konkretnymi sytuacjami. Wszystkie właściwości pola, które nie zostaną określone w treści żądania, pozostaną niezmienione. |
| Aktualizowanie relacji |
Ten punkt końcowy służy do dodawania pól odnośników i pól podsumowania do istniejącej relacji. Aktualizowanie relacji nie spowoduje usunięcia istniejących pól odnośnika/podsumowania. |
| Aktualizowanie tabeli |
Aktualizuje główne właściwości określonej tabeli. Wszystkie właściwości tabeli, które nie zostaną określone w treści żądania, pozostaną niezmienione. |
| Dezaktywowanie tokenu użytkownika |
Dezaktywuje uwierzytelniony token użytkownika. Po wykonaniu tej czynności token użytkownika musi zostać ponownie aktywowany w interfejsie użytkownika. |
| Klonowanie tokenu użytkownika |
Klonuje uwierzytelniony token użytkownika. Wszystkie aplikacje skojarzone z tym tokenem są automatycznie skojarzone z nowym tokenem. |
| Kopiowanie aplikacji |
Kopiuje określoną aplikację. Nowa aplikacja będzie mieć ten sam schemat co oryginalny. Zobacz poniżej, aby uzyskać dodatkowe opcje kopiowania. |
| Pobieranie aplikacji |
Zwraca główne właściwości aplikacji, w tym zmienne aplikacji. |
| Pobieranie pola |
Pobiera właściwości pojedynczego pola na podstawie identyfikatora pola. |
| Pobieranie pól dla tabeli |
Pobiera właściwości dla wszystkich pól w określonej tabeli. Właściwości dla każdego pola są takie same jak w polu Pobierz. |
| Pobieranie raportu |
Pobierz schemat (właściwości) pojedynczego raportu. |
| Pobieranie tabel dla aplikacji |
Pobiera listę wszystkich tabel, które istnieją w określonej aplikacji. Właściwości każdej tabeli są takie same jak właściwości zwracane w tabeli Get. |
| Pobieranie tabeli |
Pobiera właściwości pojedynczej tabeli będącej częścią aplikacji. |
| Pobieranie użycia dla wszystkich pól |
Pobierz wszystkie statystyki użycia pól dla tabeli. Jest to podsumowanie informacji, które można znaleźć w tabeli użycia właściwości pola. |
| Pobieranie użycia pola |
Pobieranie statystyk użycia z pojedynczymi polami. Jest to podsumowanie informacji, które można znaleźć w tabeli użycia właściwości pola. |
| Pobieranie wszystkich raportów tabeli |
Pobierz schemat (właściwości) wszystkich raportów dla tabeli. Jeśli użytkownik z uruchomionym interfejsem API jest administratorem aplikacji, interfejs API zwróci również wszystkie raporty osobiste z identyfikatorem użytkownika właściciela. |
| Pobieranie wszystkich relacji |
Pobierz listę wszystkich relacji i ich definicji dla określonej tabeli. Szczegóły są udostępniane zarówno dla stron nadrzędnych, jak i podrzędnych relacji w danej aplikacji. Ograniczone szczegóły są zwracane w przypadku relacji między aplikacjami. |
| Pobieranie załącznika |
Pobiera załącznik pliku z zawartością załącznika pliku zakodowaną w formacie base64. Odpowiedź interfejsu API zwraca nazwę pliku w nagłówku |
| Pobieranie zdarzeń aplikacji |
Pobierz listę zdarzeń, które mogą być wyzwalane na podstawie danych lub akcji użytkownika w tej aplikacji, obejmuje: powiadomienia e-mail, przypomnienia, subskrypcje, akcje QB, elementy webhook, wyzwalane zmiany rekordu (nie obejmuje zaplanowanych). |
| Tworzenie pola |
Tworzy pole w tabeli, w tym uprawnienia niestandardowe tego pola. |
| Tworzenie tabeli |
Tworzy tabelę w aplikacji. |
| Uruchamianie formuły |
Umożliwia uruchamianie formuły za pośrednictwem wywołania interfejsu API. Użyj tej metody w kodzie niestandardowym, aby uzyskać wartość z powrotem formuły bez dyskretnego pola w rekordzie. |
| Uruchamianie raportu |
Uruchamia raport na podstawie identyfikatora i zwraca skojarzone z nim dane bazowe. Format danych będzie się różnić w zależności od typu raportu. Raporty, które koncentrują się na danych na poziomie rekordu (tabela, kalendarz itp.) zwracają poszczególne rekordy. Zagregowane raporty (podsumowanie, wykres) będą zwracać podsumowane informacje zgodnie z konfiguracją w raporcie. Elementy specyficzne dla interfejsu użytkownika nie są zwracane, takie jak sumy, średnie i wizualizacje. Zwraca dane z inteligentną stronicacją na podstawie przybliżonego rozmiaru każdego rekordu. Obiekt metadanych będzie zawierać niezbędne informacje, aby iterować odpowiedź i zbierać więcej danych. |
| Usuwanie aplikacji |
Usuwa całą aplikację, w tym wszystkie tabele i dane. |
| Usuwanie pól |
Usuwa jedno lub wiele pól w tabeli na podstawie identyfikatora pola. Spowoduje to również trwałe usunięcie wszystkich danych lub obliczeń w tym polu. |
| Usuwanie rekordów |
Usuwa rekordy w tabeli na podstawie zapytania. Alternatywnie można usunąć wszystkie rekordy w tabeli. |
| Usuwanie relacji |
Użyj tego punktu końcowego, aby usunąć całą relację, w tym wszystkie pola odnośnika i podsumowania. Pole odwołania w relacji nie zostanie usunięte. |
| Usuwanie tokenu użytkownika |
Usuwa uwierzytelniony token użytkownika. Nie jest to odwracalne. |
| Usuwanie załącznika |
Usuwa jedną wersję załącznika pliku. Metadane dotyczące plików można pobrać z punktów końcowych /records i /reports, jeśli ma to zastosowanie. Użyj tych punktów końcowych, aby uzyskać informacje niezbędne do usunięcia wersji plików. |
| Usuń tabelę |
Usuwa określoną tabelę w aplikacji, w tym wszystkie zawarte w niej dane. |
| Utwórz aplikację |
Tworzy aplikację na koncie. Musisz mieć uprawnienia do tworzenia aplikacji na odpowiednim koncie. Główne właściwości i zmienne aplikacji można ustawić za pomocą tego interfejsu API. |
| Utwórz relację |
Tworzy relację w tabeli, a także pola odnośnika/podsumowania. Relacje można tworzyć tylko dla tabel w tej samej aplikacji. |
| Uzyskiwanie tokenu tymczasowego dla DBID |
Użyj tego punktu końcowego, aby uzyskać tymczasowy token autoryzacji, w zakresie aplikacji lub tabeli. Następnie możesz użyć tego tokenu, aby wykonać inne wywołania interfejsu API (zobacz autoryzację). Ten token wygaśnie za 5 minut. |
| Wstawianie rekordów aktualizacji andora |
Wstaw i/lub aktualizuj rekordy w tabeli. W tym wywołaniu pojedynczego interfejsu API można przesyłać wstawki i aktualizacje. Aktualizacja może używać pola klucza w tabeli lub innego obsługiwanego pola unikatowego. Aby uzyskać więcej informacji na temat formatowania poszczególnych typów pól, zapoznaj się ze stroną Typy pól . Ta operacja umożliwia przyrostowe przetwarzanie rekordów zakończonych powodzeniem, nawet jeśli niektóre rekordy kończą się niepowodzeniem. |
| Wykonywanie zapytań o dane |
Przekaż zapytanie w języku zapytań Quickbase. Zwraca dane rekordów z inteligentną stronicacją na podstawie przybliżonego rozmiaru każdego rekordu. Obiekt metadanych będzie zawierać niezbędne informacje, aby iterować odpowiedź i zbierać więcej danych. |
Aktualizowanie aplikacji
Aktualizuje główne właściwości i/lub zmienne aplikacji dla określonej aplikacji. Wszelkie właściwości aplikacji, które nie zostaną określone w treści żądania, pozostaną niezmienione.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
nazwa
|
name | True | string |
Nazwa zmiennej. |
|
value
|
value | True | string |
Wartość zmiennej. |
|
nazwa
|
name | string |
Nazwa aplikacji. |
|
|
opis
|
description | string |
Opis aplikacji. |
|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji. |
Zwraca
- Aktualizowanie odpowiedzi aplikacji
- updateAppResponse
Aktualizowanie pola
Aktualizuje właściwości i uprawnienia niestandardowe pola. Próba zaktualizowania niektórych właściwości może spowodować, że istniejące dane nie będą już przestrzegać nowych właściwości pola i mogą zostać odrzucone. Zapoznaj się z opisami wymaganych, unikatowych i wybranych poniżej opcji, aby zapoznać się z konkretnymi sytuacjami. Wszystkie właściwości pola, które nie zostaną określone w treści żądania, pozostaną niezmienione.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator tabeli. |
|
Inspekcji
|
audited | boolean |
Wskazuje, czy pole jest śledzone w ramach dzienników inspekcji quickbase. Tę właściwość można ustawić tylko na wartość "true", jeśli aplikacja ma włączone dzienniki inspekcji. Zobacz Włączanie dzienników zmian danych w obszarze Dzienniki inspekcji Quickbase. |
|
|
fieldHelp
|
fieldHelp | string |
Skonfigurowany tekst pomocy wyświetlany użytkownikom w produkcie. |
|
|
bold
|
bold | boolean |
Wskazuje, czy pole jest skonfigurowane do wyświetlania pogrubionego w produkcie. |
|
|
required
|
required | boolean |
Wskazuje, czy pole jest wymagane (tj. jeśli każdy rekord musi mieć wartość inną niż null w tym polu). Jeśli spróbujesz zmienić pole z niewymaganego do wymaganego, a tabela zawiera obecnie rekordy, które mają wartości null w tym polu, zostanie wyświetlony błąd wskazujący, że istnieją wartości null pola. W takim przypadku należy znaleźć i zaktualizować te rekordy przy użyciu wartości null pola przed zmianą pola na wymagane. |
|
|
comments
|
comments | string |
Komentarze wprowadzone we właściwościach pola przez administratora. |
|
|
doesTotal
|
doesTotal | boolean |
Określa, czy to pole sumuje się w raportach w produkcie. |
|
|
autozapis
|
autoSave | boolean |
Czy pole łącza zostanie automatycznie zapisane. |
|
|
defaultValueLuid
|
defaultValueLuid | integer |
Domyślna wartość identyfikatora użytkownika. |
|
|
maxVersions
|
maxVersions | integer |
Maksymalna liczba wersji skonfigurowanych dla załącznika pliku. |
|
|
format
|
format | integer |
Format wyświetlania czasu. |
|
|
carryChoices
|
carryChoices | boolean |
Czy pole powinno przenosić pola wielokrotnego wyboru podczas kopiowania. |
|
|
maksymalna długość
|
maxLength | integer |
Maksymalna liczba znaków dozwolona dla wpisu w quickbase dla tego pola. |
|
|
linkTekst
|
linkText | string |
Skonfigurowana wartość tekstowa, która zastępuje adres URL widoczny dla użytkowników w produkcie. |
|
|
parentFieldId
|
parentFieldId | integer |
Identyfikator nadrzędnego pola złożonego, jeśli ma to zastosowanie. |
|
|
displayTimezone
|
displayTimezone | boolean |
Wskazuje, czy ma być wyświetlana strefa czasowa w produkcie. |
|
|
summaryTargetFieldId
|
summaryTargetFieldId | integer |
Identyfikator pola używanego do agregowania wartości z elementu podrzędnego, jeśli ma to zastosowanie. Spowoduje to wyświetlenie wartości 0, jeśli funkcja podsumowania nie wymaga zaznaczenia pola (na przykład liczba). |
|
|
allowNewChoices
|
allowNewChoices | boolean |
Wskazuje, czy użytkownicy mogą dodawać nowe opcje do listy wyboru. |
|
|
defaultToday
|
defaultToday | boolean |
Wskazuje, czy wartość pola jest obecnie domyślna dla nowych rekordów. |
|
|
Jednostek
|
units | string |
Etykieta jednostek. |
|
|
lookupTargetFieldId
|
lookupTargetFieldId | integer |
Identyfikator pola, które jest elementem docelowym w tabeli nadrzędnej dla tego odnośnika. |
|
|
SummaryFunction3
|
summaryFunction | string |
Typ akumulacja dla pola podsumowania. |
|
|
sourceFieldId
|
sourceFieldId | integer |
Identyfikator pola źródłowego. |
|
|
doesAverage
|
doesAverage | boolean |
Określa, czy to pole jest średnie w raportach w produkcie. |
|
|
formuła
|
formula | string |
Formuła pola skonfigurowana w programie Quickbase. |
|
|
liczba miejsc dziesiętnych
|
decimalPlaces | integer |
Liczba miejsc dziesiętnych wyświetlanych w produkcie dla tego pola. |
|
|
displayMonth
|
displayMonth | string |
Jak wyświetlać miesiące. |
|
|
seeVersions
|
seeVersions | boolean |
Wskazuje, czy użytkownik może zobaczyć inne wersje, oprócz najnowszych, załącznika pliku w produkcie. |
|
|
numLines
|
numLines | integer |
Liczba wierszy wyświetlanych w przewodniku Quickbase dla tego pola tekstowego. |
|
|
defaultKind
|
defaultKind | string |
Domyślny typ użytkownika. |
|
|
displayEmail
|
displayEmail | string |
Jak jest wyświetlana wiadomość e-mail. |
|
|
coverText
|
coverText | string |
Alternatywny tekst przyjazny dla użytkownika, który może służyć do wyświetlania linku w przeglądarce. |
|
|
currencySymbol
|
currencySymbol | string |
Bieżący symbol używany podczas wyświetlania wartości pól w produkcie. |
|
|
summaryQuery
|
summaryQuery | string |
Zapytanie sumaryczne. |
|
|
targetFieldId
|
targetFieldId | integer |
Identyfikator pola docelowego. |
|
|
displayUser
|
displayUser | string |
Skonfigurowana opcja sposobu wyświetlania użytkowników w produkcie. |
|
|
blankIsZero
|
blankIsZero | boolean |
Czy wartość pusta jest traktowana tak samo jak 0 w obliczeniach w produkcie. |
|
|
dokładny
|
exact | boolean |
Czy dokładne dopasowanie jest wymagane dla linku raportu. |
|
|
defaultDomain
|
defaultDomain | string |
Domyślna domena poczty e-mail. |
|
|
defaultValue (wartość domyślna)
|
defaultValue | string |
Wartość domyślna skonfigurowana dla pola po dodaniu nowego rekordu. |
|
|
skracać
|
abbreviate | boolean |
Nie pokazuj protokołu URL podczas wyświetlania adresu URL. |
|
|
numberFormat
|
numberFormat | integer |
Format używany do wyświetlania wartości liczbowych w produkcie (dziesiętne, separatory, grupa cyfr). |
|
|
targetTableName
|
targetTableName | string |
Nazwa tabeli docelowej pola. |
|
|
pojawia się Jako
|
appearsAs | string |
Tekst linku, jeśli jest pusty, adres URL będzie używany jako tekst linku. |
|
|
width
|
width | integer |
Szerokość danych wejściowych HTML pola w produkcie. |
|
|
Format waluty
|
currencyFormat | string |
Format waluty używany podczas wyświetlania wartości pól w produkcie. |
|
|
displayImages
|
displayImages | boolean |
Wskazuje, czy obrazy będą wyświetlane dla załączników plików w formularzach i raportach w produkcie. |
|
|
displayDayOfWeek
|
displayDayOfWeek | boolean |
Wskazuje, czy ma być wyświetlany dzień tygodnia w produkcie. |
|
|
summaryReferenceFieldId
|
summaryReferenceFieldId | integer |
Identyfikator pola, które jest odwołaniem w relacji dla tego podsumowania. |
|
|
przecinekStart
|
commaStart | integer |
Liczba cyfr przed przecinkami wyświetlana w produkcie, jeśli ma to zastosowanie. |
|
|
choices
|
choices | array of string |
Tablica wpisów, które istnieją dla pola, które oferuje użytkownikowi opcje wyboru. Należy pamiętać, że te opcje odwołują się do prawidłowych wartości wszystkich rekordów dodanych w przyszłości. Możesz usunąć wartości z listy opcji, nawet jeśli w tym polu istnieją rekordy z tymi wartościami. Będą one wyświetlane na czerwono, gdy użytkownicy patrzą na dane w przeglądarce, ale nie ma innego efektu. Podczas aktualizowania pola za pomocą tej właściwości stare opcje zostaną usunięte i zastąpione nowymi opcjami. |
|
|
targetTableId
|
targetTableId | string |
Identyfikator tabeli docelowej. |
|
|
displayRelative
|
displayRelative | boolean |
Określa, czy czas ma być wyświetlany jako względny. |
|
|
compositeFields
|
compositeFields | object | ||
|
summaryTableId
|
summaryTableId | string |
W tabeli pole podsumowania odwołuje się do pól. |
|
|
displayTime
|
displayTime | boolean |
Wskazuje, czy ma być wyświetlana godzina, oprócz daty. |
|
|
VersionMode
|
versionMode | string |
Tryby wersji dla plików. Zachowaj wszystkie wersje i zachowaj ostatnią wersję. |
|
|
snapFieldId
|
snapFieldId | integer |
Identyfikator pola używanego do tworzenia migawek wartości z , jeśli ma to zastosowanie. |
|
|
godz. 24
|
hours24 | boolean |
Wskazuje, czy czas ma być wyświetlany w formacie 24-godzinnym w produkcie. |
|
|
sortAlpha
|
sortAlpha | boolean |
Czy sortować alfabetycznie, sortowanie domyślne jest według identyfikatora rekordu. |
|
|
sortAsGiven
|
sortAsGiven | boolean |
Wskazuje, czy wymienione wpisy są sortowane zgodnie z wprowadzonymi w kolejności alfabetycznej. |
|
|
hasExtension
|
hasExtension | boolean |
Czy to pole ma rozszerzenie telefonu. |
|
|
useNewWindow
|
useNewWindow | boolean |
Wskazuje, czy adres URL powinien otworzyć nowe okno, gdy użytkownik kliknie go w produkcie. |
|
|
appendOnly
|
appendOnly | boolean |
Czy to pole jest dołączane tylko. |
|
|
displayAsLink
|
displayAsLink | boolean |
Wskazuje, czy pole będące częścią relacji powinno być wyświetlane jako hiperlink do rekordu nadrzędnego w produkcie. |
|
|
lookupReferenceFieldId
|
lookupReferenceFieldId | integer |
Identyfikator pola, które jest odwołaniem w relacji dla tego odnośnika. |
|
|
pojawia sięByDefault
|
appearsByDefault | boolean |
Wskazuje, czy pole jest oznaczone jako domyślne w raportach. |
|
|
niepowtarzalny
|
unique | boolean |
Wskazuje, czy każdy rekord w tabeli musi zawierać unikatową wartość tego pola. Jeśli spróbujesz zmienić pole z nieu unikatowego na unikatowe, a tabela zawiera obecnie rekordy o tej samej wartości tego pola, zostanie wyświetlony błąd. W takim przypadku należy znaleźć i zaktualizować te rekordy z zduplikowanymi wartościami pola przed zmianą pola na unikatową. |
|
|
rola
|
role | string |
Rola skojarzona z danym uprawnieniem dla pola |
|
|
permissionType
|
permissionType | string |
Uprawnienie przydzielone roli dla tego pola |
|
|
roleId (identyfikator roli)
|
roleId | integer |
Identyfikator danej roli |
|
|
addToForms
|
addToForms | boolean |
Określa, czy dodawane pole powinno być wyświetlane w formularzach. |
|
|
etykieta
|
label | string |
Etykieta (nazwa) pola. |
|
|
findEnabled
|
findEnabled | boolean |
Wskazuje, czy pole jest oznaczone jako możliwe do wyszukiwania. |
|
|
noWrap
|
noWrap | boolean |
Wskazuje, czy pole jest skonfigurowane tak, aby nie opakowować w przypadku wyświetlania w produkcie. |
|
|
Identyfikator pola
|
fieldId | True | integer |
Unikatowy identyfikator (FID) pola. |
Zwraca
- Aktualizowanie odpowiedzi na pole
- updateFieldResponse
Aktualizowanie relacji
Ten punkt końcowy służy do dodawania pól odnośników i pól podsumowania do istniejącej relacji. Aktualizowanie relacji nie spowoduje usunięcia istniejących pól odnośnika/podsumowania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
summaryFid
|
summaryFid | double |
Identyfikator pola do podsumowania. |
|
|
etykieta
|
label | string |
Etykieta pola podsumowania. |
|
|
Typ akumulacja
|
accumulationType | True | string |
Typ akumulacja dla pola podsumowania. |
|
where
|
where | string |
Filtr, używając języka zapytań Quickbase, który określa rekordy do zwrócenia. |
|
|
lookupFieldIds
|
lookupFieldIds | array of integer |
Tablica identyfikatorów pól w tabeli nadrzędnej, która stanie się polami odnośników w tabeli podrzędnej. |
|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. Będzie to tabela podrzędna. |
|
Identyfikator relacji
|
relationshipId | True | double |
Identyfikator relacji. Jest to identyfikator pola odwołania w tabeli podrzędnej. |
Zwraca
- Aktualizowanie odpowiedzi relacji
- updateRelationshipResponse
Aktualizowanie tabeli
Aktualizuje główne właściwości określonej tabeli. Wszystkie właściwości tabeli, które nie zostaną określone w treści żądania, pozostaną niezmienione.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji |
|
nazwa
|
name | string |
Nazwa tabeli. |
|
|
pluralRecordName
|
pluralRecordName | string |
Rzeczownik w liczbie mnogiej dla rekordów w tabeli. Jeśli ta wartość nie zostanie przekazana, wartość domyślna to "Rekordy". |
|
|
singleRecordName
|
singleRecordName | string |
Pojedyncza rzeczownik dla rekordów w tabeli. Jeśli ta wartość nie zostanie przekazana, wartość domyślna to "Rekord". |
|
|
opis
|
description | string |
Opis tabeli. Jeśli ta wartość nie zostanie przekazana, wartość domyślna jest pusta. |
|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
Zwraca
- Aktualizowanie odpowiedzi tabeli
- updateTableResponse
Dezaktywowanie tokenu użytkownika
Dezaktywuje uwierzytelniony token użytkownika. Po wykonaniu tej czynności token użytkownika musi zostać ponownie aktywowany w interfejsie użytkownika.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
id |
Klonowanie tokenu użytkownika
Klonuje uwierzytelniony token użytkownika. Wszystkie aplikacje skojarzone z tym tokenem są automatycznie skojarzone z nowym tokenem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
nazwa
|
name | string |
Nowa nazwa sklonowanego tokenu użytkownika. |
|
|
opis
|
description | string |
Opis sklonowanego tokenu użytkownika. |
Zwraca
- Klonowanie odpowiedzi tokenu użytkownika
- cloneUserTokenResponse
Kopiowanie aplikacji
Kopiuje określoną aplikację. Nowa aplikacja będzie mieć ten sam schemat co oryginalny. Zobacz poniżej, aby uzyskać dodatkowe opcje kopiowania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
nazwa
|
name | True | string |
Nazwa nowo skopiowanej aplikacji |
|
opis
|
description | string |
Opis nowo skopiowanej aplikacji |
|
|
assignUserToken
|
assignUserToken | boolean |
Czy dodać token użytkownika użyty do wykonania tego żądania do nowej aplikacji |
|
|
excludeFiles
|
excludeFiles | boolean |
Jeśli wartość keepData ma wartość true, czy skopiować również załączniki plików. Jeśli właściwość keepData ma wartość false, ta właściwość jest ignorowana |
|
|
keepData
|
keepData | boolean |
Czy skopiować dane aplikacji wraz ze schematem |
|
|
usersAndRoles
|
usersAndRoles | boolean |
Jeśli to prawda, użytkownicy zostaną skopiowani wraz z przypisanymi rolami. Jeśli wartość false, użytkownicy i role zostaną skopiowane, ale role nie zostaną przypisane |
|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji. |
Zwraca
- Kopiowanie odpowiedzi aplikacji
- copyAppResponse
Pobieranie aplikacji
Zwraca główne właściwości aplikacji, w tym zmienne aplikacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji. |
Zwraca
- Uzyskiwanie odpowiedzi na aplikację
- getAppResponse
Pobieranie pola
Pobiera właściwości pojedynczego pola na podstawie identyfikatora pola.
Właściwości obecne we wszystkich typach pól są zwracane na najwyższym poziomie. Właściwości unikatowe dla określonego typu pola są zwracane w ramach atrybutu "properties". Aby uzyskać więcej informacji na temat właściwości poszczególnych typów pól, zobacz stronę Typy pól .
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
|
Uwzględnij uprawnienia pola
|
includeFieldPerms | boolean |
Ustaw wartość "true", jeśli chcesz odzyskać uprawnienia niestandardowe dla pól. |
|
|
Identyfikator pola
|
fieldId | True | integer |
Unikatowy identyfikator (FID) pola. |
Zwraca
- Uzyskiwanie odpowiedzi na pole
- getFieldResponse
Pobieranie pól dla tabeli
Pobiera właściwości dla wszystkich pól w określonej tabeli. Właściwości dla każdego pola są takie same jak w polu Pobierz.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
|
Uwzględnij uprawnienia pola
|
includeFieldPerms | boolean |
Ustaw wartość "true", jeśli chcesz odzyskać uprawnienia niestandardowe dla pól. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
identyfikator
|
id | integer |
Identyfikator. |
|
Etykieta
|
label | string |
Etykieta. |
|
Typ pola
|
fieldType | string |
Typ pola. |
|
Bez zawijania
|
noWrap | boolean |
Czy nie ma zawijania. |
|
Pogrubiona
|
bold | boolean |
Czy jest pogrubiona. |
|
Wymagane
|
required | boolean |
Czy jest to wymagane. |
|
Pojawia się domyślnie
|
appearsByDefault | boolean |
Określa, czy jest wyświetlana domyślnie. |
|
Znajdź włączone
|
findEnabled | boolean |
Określa, czy funkcja znajdowania jest włączona. |
|
Unikatowe
|
unique | boolean |
Czy jest to unikatowe. |
|
Czy kopiowanie danych
|
doesDataCopy | boolean |
Czy kopiowanie danych. |
|
Pomoc dotycząca pól
|
fieldHelp | string |
Pomoc pola. |
|
Inspekcji
|
audited | boolean |
Czy inspekcja. |
|
Klucz podstawowy
|
properties.primaryKey | boolean |
Czy klucz podstawowy. |
|
Klucz obcy
|
properties.foreignKey | boolean |
Czy klucz obcy. |
|
Wiersze numeryczne
|
properties.numLines | integer |
Liczba wierszy. |
|
Maksymalna długość
|
properties.maxLength | integer |
Maksymalna długość. |
|
Tylko dołączanie
|
properties.appendOnly | boolean |
Czy dołączać tylko. |
|
allowHTML
|
properties.allowHTML | boolean |
Czy zezwalać na kod HTML. |
|
Sortuj jako podane
|
properties.sortAsGiven | boolean |
Czy sortuj jako podane. |
|
Przewoż wybory
|
properties.carryChoices | boolean |
Czy nosić wybory. |
|
Zezwalaj na nowe wybory
|
properties.allowNewChoices | boolean |
Czy zezwolić na nowe wybory. |
|
Formula
|
properties.formula | string |
Formuła. |
|
Wartość domyślna
|
properties.defaultValue | string |
Wartość domyślna. |
|
Format liczb
|
properties.numberFormat | integer |
Format liczbowy. |
|
Miejsca dziesiętne
|
properties.decimalPlaces | integer |
Miejsca dziesiętne. |
|
Czy średnia
|
properties.doesAverage | boolean |
Czy średnia. |
|
Całkowita liczba
|
properties.doesTotal | boolean |
Czy suma jest całkowita. |
|
Puste jest zero
|
properties.blankIsZero | boolean |
Czy wartość pusta to zero. |
|
Permissions
|
permissions | array of object | |
|
Typ uprawnień
|
permissions.permissionType | string |
Typ uprawnień. |
|
Role
|
permissions.role | string |
Rola. |
|
Identyfikator roli
|
permissions.roleId | integer |
Identyfikator roli. |
|
Dodawanie do formularzy
|
addToForms | boolean |
Czy dodać do formularzy. |
Pobieranie raportu
Pobierz schemat (właściwości) pojedynczego raportu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator tabeli. |
|
Identyfikator raportu
|
reportId | True | string |
Identyfikator raportu, unikatowy dla tabeli. |
Zwraca
- Uzyskiwanie odpowiedzi na raport
- getReportResponse
Pobieranie tabel dla aplikacji
Pobiera listę wszystkich tabel, które istnieją w określonej aplikacji. Właściwości każdej tabeli są takie same jak właściwości zwracane w tabeli Get.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
Name
|
name | string |
Nazwa. |
|
Created
|
created | string |
Po utworzeniu. |
|
Updated
|
updated | string |
Po zaktualizowaniu. |
|
Pseudonim
|
alias | string |
Alias. |
|
Description
|
description | string |
Opis. |
|
identyfikator
|
id | string |
Identyfikator. |
|
Następny identyfikator rekordu
|
nextRecordId | integer |
Identyfikator następnego rekordu. |
|
Następny identyfikator pola
|
nextFieldId | integer |
Identyfikator następnego pola. |
|
Domyślny identyfikator pola sortowania
|
defaultSortFieldId | integer |
Identyfikator domyślnego pola sortowania. |
|
Domyślna kolejność sortowania
|
defaultSortOrder | string |
Domyślna kolejność sortowania. |
|
Identyfikator pola klucza
|
keyFieldId | integer |
Identyfikator pola klucza. |
|
Nazwa pojedynczego rekordu
|
singleRecordName | string |
Nazwa pojedynczego rekordu. |
|
Nazwa rekordu w liczbie mnogiej
|
pluralRecordName | string |
Nazwa rekordu w liczbie mnogiej. |
|
Limit rozmiaru
|
sizeLimit | string |
Limit rozmiaru. |
|
Używane miejsce
|
spaceUsed | string |
Używane miejsce. |
|
Spacja pozostała
|
spaceRemaining | string |
Pozostałe miejsce. |
Pobieranie tabeli
Pobiera właściwości pojedynczej tabeli będącej częścią aplikacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji |
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
Zwraca
- Uzyskiwanie odpowiedzi na tabelę
- getTableResponse
Pobieranie użycia dla wszystkich pól
Pobierz wszystkie statystyki użycia pól dla tabeli. Jest to podsumowanie informacji, które można znaleźć w tabeli użycia właściwości pola.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
|
Pomiń
|
skip | integer |
Liczba pól do pominięcia z listy. |
|
|
Do góry
|
top | integer |
Maksymalna liczba pól do zwrócenia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
identyfikator
|
field.id | integer |
Identyfikator. |
|
Name
|
field.name | string |
Nazwa. |
|
Typ
|
field.type | string |
Typ. |
|
Liczba
|
usage.actions.count | integer |
Liczba. |
|
Liczba
|
usage.appHomePages.count | integer |
Liczba. |
|
Liczba
|
usage.defaultReports.count | integer |
Liczba. |
|
Liczba
|
usage.exactForms.count | integer |
Liczba. |
|
Liczba
|
usage.fields.count | integer |
Liczba. |
|
Liczba
|
usage.forms.count | integer |
Liczba. |
|
Liczba
|
usage.notifications.count | integer |
Liczba. |
|
Liczba
|
usage.personalReports.count | integer |
Liczba. |
|
Liczba
|
usage.relationships.count | integer |
Liczba. |
|
Liczba
|
usage.reminders.count | integer |
Liczba. |
|
Liczba
|
usage.reports.count | integer |
Liczba. |
|
Liczba
|
usage.roles.count | integer |
Liczba. |
|
Liczba
|
usage.webhooks.count | integer |
Liczba. |
Pobieranie użycia pola
Pobieranie statystyk użycia z pojedynczymi polami. Jest to podsumowanie informacji, które można znaleźć w tabeli użycia właściwości pola.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
|
Identyfikator pola
|
fieldId | True | integer |
Unikatowy identyfikator (FID) pola. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
identyfikator
|
field.id | integer |
Identyfikator. |
|
Name
|
field.name | string |
Nazwa. |
|
Typ
|
field.type | string |
Typ. |
|
Liczba
|
usage.actions.count | integer |
Liczba. |
|
Liczba
|
usage.appHomePages.count | integer |
Liczba. |
|
Liczba
|
usage.defaultReports.count | integer |
Liczba. |
|
Liczba
|
usage.exactForms.count | integer |
Liczba. |
|
Liczba
|
usage.fields.count | integer |
Liczba. |
|
Liczba
|
usage.forms.count | integer |
Liczba. |
|
Liczba
|
usage.notifications.count | integer |
Liczba. |
|
Liczba
|
usage.personalReports.count | integer |
Liczba. |
|
Liczba
|
usage.relationships.count | integer |
Liczba. |
|
Liczba
|
usage.reminders.count | integer |
Liczba. |
|
Liczba
|
usage.reports.count | integer |
Liczba. |
|
Liczba
|
usage.roles.count | integer |
Liczba. |
|
Liczba
|
usage.webhooks.count | integer |
Liczba. |
Pobieranie wszystkich raportów tabeli
Pobierz schemat (właściwości) wszystkich raportów dla tabeli. Jeśli użytkownik z uruchomionym interfejsem API jest administratorem aplikacji, interfejs API zwróci również wszystkie raporty osobiste z identyfikatorem użytkownika właściciela.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator tabeli. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
identyfikator
|
id | string |
Identyfikator. |
|
Name
|
name | string |
Nazwa. |
|
Typ
|
type | string |
Typ. |
|
Description
|
description | string |
Opis. |
|
Identyfikator właściciela
|
ownerId | string |
Identyfikator właściciela. |
|
Ostatnio używany
|
usedLast | string |
Kiedy ostatnio użyto. |
|
Liczba użytych
|
usedCount | integer |
Użyta liczba. |
Pobieranie wszystkich relacji
Pobierz listę wszystkich relacji i ich definicji dla określonej tabeli. Szczegóły są udostępniane zarówno dla stron nadrzędnych, jak i podrzędnych relacji w danej aplikacji. Ograniczone szczegóły są zwracane w przypadku relacji między aplikacjami.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pomiń
|
skip | integer |
Liczba relacji do pominięcia. |
|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
Zwraca
- Uzyskiwanie odpowiedzi na relacje
- getRelationshipsResponse
Pobieranie załącznika
Pobiera załącznik pliku z zawartością załącznika pliku zakodowaną w formacie base64. Odpowiedź interfejsu API zwraca nazwę pliku w nagłówku Content-Disposition . Metadane dotyczące plików można pobrać z punktów końcowych /records i /reports, jeśli ma to zastosowanie. Użyj tych punktów końcowych, aby uzyskać niezbędne informacje do pobrania plików.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator tabeli. |
|
Identyfikator rekordu
|
recordId | True | integer |
Unikatowy identyfikator rekordu. |
|
Identyfikator pola
|
fieldId | True | integer |
Unikatowy identyfikator pola. |
|
Numer wersji
|
versionNumber | True | integer |
Numer wersji załącznika pliku. |
Zwraca
- response
- string
Pobieranie zdarzeń aplikacji
Pobierz listę zdarzeń, które mogą być wyzwalane na podstawie danych lub akcji użytkownika w tej aplikacji, obejmuje: powiadomienia e-mail, przypomnienia, subskrypcje, akcje QB, elementy webhook, wyzwalane zmiany rekordu (nie obejmuje zaplanowanych).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
Typ
|
type | string |
Typ. |
|
Email
|
owner.email | string |
Adres e-mail właściciela. |
|
identyfikator
|
owner.id | string |
Identyfikator właściciela. |
|
Name
|
owner.name | string |
Nazwa właściciela. |
|
Nazwa użytkownika
|
owner.userName | string |
Nazwa użytkownika właściciela. |
|
Jest aktywny
|
isActive | boolean |
Czy jest aktywny. |
|
Identyfikator tabeli
|
tableId | string |
Identyfikator tabeli. |
|
Name
|
name | string |
Nazwa. |
|
adres URL
|
url | string |
Adres URL. |
Tworzenie pola
Tworzy pole w tabeli, w tym uprawnienia niestandardowe tego pola.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator tabeli. |
|
Inspekcji
|
audited | boolean |
Wskazuje, czy pole jest śledzone w ramach dzienników inspekcji quickbase. Tę właściwość można ustawić tylko na wartość "true", jeśli aplikacja ma włączone dzienniki inspekcji. Zobacz Włączanie dzienników zmian danych w obszarze Dzienniki inspekcji Quickbase. |
|
|
fieldHelp
|
fieldHelp | string |
Skonfigurowany tekst pomocy wyświetlany użytkownikom w produkcie. |
|
|
bold
|
bold | boolean |
Wskazuje, czy pole jest skonfigurowane do wyświetlania pogrubionego w produkcie. |
|
|
comments
|
comments | string |
Komentarze wprowadzone we właściwościach pola przez administratora. |
|
|
doesTotal
|
doesTotal | boolean |
Określa, czy to pole sumuje się w raportach w produkcie. |
|
|
autozapis
|
autoSave | boolean |
Czy pole łącza zostanie automatycznie zapisane. |
|
|
defaultValueLuid
|
defaultValueLuid | integer |
Domyślna wartość identyfikatora użytkownika. |
|
|
maxVersions
|
maxVersions | integer |
Maksymalna liczba wersji skonfigurowanych dla załącznika pliku. |
|
|
format
|
format | integer |
Format wyświetlania czasu. |
|
|
carryChoices
|
carryChoices | boolean |
Czy pole powinno przenosić pola wielokrotnego wyboru podczas kopiowania. |
|
|
maksymalna długość
|
maxLength | integer |
Maksymalna liczba znaków dozwolona dla wpisu w quickbase dla tego pola. |
|
|
linkTekst
|
linkText | string |
Skonfigurowana wartość tekstowa, która zastępuje adres URL widoczny dla użytkowników w produkcie. |
|
|
parentFieldId
|
parentFieldId | integer |
Identyfikator nadrzędnego pola złożonego, jeśli ma to zastosowanie. |
|
|
displayTimezone
|
displayTimezone | boolean |
Wskazuje, czy ma być wyświetlana strefa czasowa w produkcie. |
|
|
allowNewChoices
|
allowNewChoices | boolean |
Wskazuje, czy użytkownicy mogą dodawać nowe opcje do listy wyboru. |
|
|
defaultToday
|
defaultToday | boolean |
Wskazuje, czy wartość pola jest obecnie domyślna dla nowych rekordów. |
|
|
Jednostek
|
units | string |
Etykieta jednostek. |
|
|
sourceFieldId
|
sourceFieldId | integer |
Identyfikator pola źródłowego. |
|
|
doesAverage
|
doesAverage | boolean |
Określa, czy to pole jest średnie w raportach w produkcie. |
|
|
formuła
|
formula | string |
Formuła pola skonfigurowana w programie Quickbase. |
|
|
liczba miejsc dziesiętnych
|
decimalPlaces | integer |
Liczba miejsc dziesiętnych wyświetlanych w produkcie dla tego pola. |
|
|
displayMonth
|
displayMonth | string |
Jak wyświetlać miesiące. |
|
|
seeVersions
|
seeVersions | boolean |
Wskazuje, czy użytkownik może zobaczyć inne wersje, oprócz najnowszych, załącznika pliku w produkcie. |
|
|
numLines
|
numLines | integer |
Liczba wierszy wyświetlanych w przewodniku Quickbase dla tego pola tekstowego. |
|
|
defaultKind
|
defaultKind | string |
Domyślny typ użytkownika. |
|
|
displayEmail
|
displayEmail | string |
Jak jest wyświetlana wiadomość e-mail. |
|
|
coverText
|
coverText | string |
Alternatywny tekst przyjazny dla użytkownika, który może służyć do wyświetlania linku w przeglądarce. |
|
|
currencySymbol
|
currencySymbol | string |
Bieżący symbol używany podczas wyświetlania wartości pól w produkcie. |
|
|
targetFieldId
|
targetFieldId | integer |
Identyfikator pola docelowego. |
|
|
displayUser
|
displayUser | string |
Skonfigurowana opcja sposobu wyświetlania użytkowników w produkcie. |
|
|
blankIsZero
|
blankIsZero | boolean |
Czy wartość pusta jest traktowana tak samo jak 0 w obliczeniach w produkcie. |
|
|
dokładny
|
exact | boolean |
Czy dokładne dopasowanie jest wymagane dla linku raportu. |
|
|
defaultDomain
|
defaultDomain | string |
Domyślna domena poczty e-mail. |
|
|
defaultValue (wartość domyślna)
|
defaultValue | string |
Wartość domyślna skonfigurowana dla pola po dodaniu nowego rekordu. |
|
|
skracać
|
abbreviate | boolean |
Nie pokazuj protokołu URL podczas wyświetlania adresu URL. |
|
|
numberFormat
|
numberFormat | integer |
Format używany do wyświetlania wartości liczbowych w produkcie (dziesiętne, separatory, grupa cyfr). |
|
|
targetTableName
|
targetTableName | string |
Nazwa tabeli docelowej pola. |
|
|
pojawia się Jako
|
appearsAs | string |
Tekst linku, jeśli jest pusty, adres URL będzie używany jako tekst linku. |
|
|
width
|
width | integer |
Szerokość danych wejściowych HTML pola w produkcie. |
|
|
Format waluty
|
currencyFormat | string |
Format waluty używany podczas wyświetlania wartości pól w produkcie. |
|
|
displayImages
|
displayImages | boolean |
Wskazuje, czy obrazy będą wyświetlane dla załączników plików w formularzach i raportach w produkcie. |
|
|
displayDayOfWeek
|
displayDayOfWeek | boolean |
Wskazuje, czy ma być wyświetlany dzień tygodnia w produkcie. |
|
|
przecinekStart
|
commaStart | integer |
Liczba cyfr przed przecinkami wyświetlana w produkcie, jeśli ma to zastosowanie. |
|
|
choices
|
choices | array of string |
Tablica wpisów, które istnieją dla pola, które oferuje użytkownikowi opcje wyboru. Należy pamiętać, że te opcje odwołują się do prawidłowych wartości wszystkich rekordów dodanych w przyszłości. Możesz usunąć wartości z listy opcji, nawet jeśli w tym polu istnieją rekordy z tymi wartościami. Będą one wyświetlane na czerwono, gdy użytkownicy patrzą na dane w przeglądarce, ale nie ma innego efektu. Podczas aktualizowania pola za pomocą tej właściwości stare opcje zostaną usunięte i zastąpione nowymi opcjami. |
|
|
targetTableId
|
targetTableId | string |
Identyfikator tabeli docelowej. |
|
|
displayRelative
|
displayRelative | boolean |
Określa, czy czas ma być wyświetlany jako względny. |
|
|
compositeFields
|
compositeFields | object | ||
|
displayTime
|
displayTime | boolean |
Wskazuje, czy ma być wyświetlana godzina, oprócz daty. |
|
|
VersionMode
|
versionMode | string |
Tryby wersji dla plików. Zachowaj wszystkie wersje i zachowaj ostatnią wersję. |
|
|
snapFieldId
|
snapFieldId | integer |
Identyfikator pola używanego do tworzenia migawek wartości z , jeśli ma to zastosowanie. |
|
|
godz. 24
|
hours24 | boolean |
Wskazuje, czy czas ma być wyświetlany w formacie 24-godzinnym w produkcie. |
|
|
sortAlpha
|
sortAlpha | boolean |
Czy sortować alfabetycznie, sortowanie domyślne jest według identyfikatora rekordu. |
|
|
sortAsGiven
|
sortAsGiven | boolean |
Wskazuje, czy wymienione wpisy są sortowane zgodnie z wprowadzonymi w kolejności alfabetycznej. |
|
|
hasExtension
|
hasExtension | boolean |
Czy to pole ma rozszerzenie telefonu. |
|
|
useNewWindow
|
useNewWindow | boolean |
Wskazuje, czy adres URL powinien otworzyć nowe okno, gdy użytkownik kliknie go w produkcie. |
|
|
appendOnly
|
appendOnly | boolean |
Czy to pole jest dołączane tylko. |
|
|
displayAsLink
|
displayAsLink | boolean |
Wskazuje, czy pole będące częścią relacji powinno być wyświetlane jako hiperlink do rekordu nadrzędnego w produkcie. |
|
|
pojawia sięByDefault
|
appearsByDefault | boolean |
Wskazuje, czy pole jest oznaczone jako domyślne w raportach. |
|
|
FieldType2
|
fieldType | True | string |
Typy pól, kliknij dowolne linki typu pola, aby uzyskać więcej informacji. |
|
rola
|
role | string |
Rola skojarzona z danym uprawnieniem dla pola |
|
|
permissionType
|
permissionType | string |
Uprawnienie przydzielone roli dla tego pola |
|
|
roleId (identyfikator roli)
|
roleId | integer |
Identyfikator danej roli |
|
|
addToForms
|
addToForms | boolean |
Określa, czy dodawane pole powinno być wyświetlane w formularzach. |
|
|
etykieta
|
label | True | string |
Etykieta (nazwa) pola. |
|
findEnabled
|
findEnabled | boolean |
Wskazuje, czy pole jest oznaczone jako możliwe do wyszukiwania. |
|
|
noWrap
|
noWrap | boolean |
Wskazuje, czy pole jest skonfigurowane tak, aby nie opakowować w przypadku wyświetlania w produkcie. |
Zwraca
- Tworzenie odpowiedzi na pole
- createFieldResponse
Tworzenie tabeli
Tworzy tabelę w aplikacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji |
|
nazwa
|
name | True | string |
Nazwa tabeli. |
|
pluralRecordName
|
pluralRecordName | string |
Rzeczownik w liczbie mnogiej dla rekordów w tabeli. Jeśli ta wartość nie zostanie przekazana, wartość domyślna to "Rekordy". |
|
|
singleRecordName
|
singleRecordName | string |
Pojedyncza rzeczownik dla rekordów w tabeli. Jeśli ta wartość nie zostanie przekazana, wartość domyślna to "Rekord". |
|
|
opis
|
description | string |
Opis tabeli. Jeśli ta wartość nie zostanie przekazana, wartość domyślna jest pusta. |
Zwraca
- Tworzenie odpowiedzi na tabelę
- createTableResponse
Uruchamianie formuły
Umożliwia uruchamianie formuły za pośrednictwem wywołania interfejsu API. Użyj tej metody w kodzie niestandardowym, aby uzyskać wartość z powrotem formuły bez dyskretnego pola w rekordzie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
formuła
|
formula | True | string |
Formuła do uruchomienia. Musi to być prawidłowa formuła quickbase. |
|
Rid
|
rid | integer |
Identyfikator rekordu do uruchomienia formuły. Tylko te formuły, które są uruchamiane w kontekście rekordu. Na przykład formuła User() nie potrzebuje identyfikatora rekordu. |
|
|
z
|
from | True | string |
Unikatowy identyfikator (dbid) tabeli. |
Zwraca
- Uruchom odpowiedź formuły
- runFormulaResponse
Uruchamianie raportu
Uruchamia raport na podstawie identyfikatora i zwraca skojarzone z nim dane bazowe. Format danych będzie się różnić w zależności od typu raportu. Raporty, które koncentrują się na danych na poziomie rekordu (tabela, kalendarz itp.) zwracają poszczególne rekordy. Zagregowane raporty (podsumowanie, wykres) będą zwracać podsumowane informacje zgodnie z konfiguracją w raporcie. Elementy specyficzne dla interfejsu użytkownika nie są zwracane, takie jak sumy, średnie i wizualizacje. Zwraca dane z inteligentną stronicacją na podstawie przybliżonego rozmiaru każdego rekordu. Obiekt metadanych będzie zawierać niezbędne informacje, aby iterować odpowiedź i zbierać więcej danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Identyfikator tabeli dla raportu. |
|
Pomiń
|
skip | integer |
Liczba rekordów do pominięcia. Tę wartość można ustawić podczas stronicowania za pomocą zestawu wyników. |
|
|
Do góry
|
top | integer |
Maksymalna liczba rekordów do zwrócenia. Możesz zastąpić domyślną stronicowanie quickbase, aby uzyskać więcej lub mniej wyników. Jeśli żądana wartość przekracza wartości dynamiczne, zwrócimy podzbiór wyników, a reszta może zostać zebrana w kolejnych wywołaniach interfejsu API. |
|
|
|
object | |||
|
Identyfikator raportu
|
reportId | True | string |
Identyfikator raportu, unikatowy dla tabeli. |
Zwraca
- Uruchamianie odpowiedzi raportu
- runReportResponse
Usuwanie aplikacji
Usuwa całą aplikację, w tym wszystkie tabele i dane.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
nazwa
|
name | True | string |
Aby potwierdzić usunięcie aplikacji, prosimy o podanie nazwy aplikacji. |
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji. |
Zwraca
- Usuń odpowiedź aplikacji
- deleteAppResponse
Usuwanie pól
Usuwa jedno lub wiele pól w tabeli na podstawie identyfikatora pola. Spowoduje to również trwałe usunięcie wszystkich danych lub obliczeń w tym polu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator tabeli. |
|
fieldIds
|
fieldIds | True | array of integer |
Lista identyfikatorów pól do usunięcia. |
Zwraca
- Usuń odpowiedź na pola
- deleteFieldsResponse
Usuwanie rekordów
Usuwa rekordy w tabeli na podstawie zapytania. Alternatywnie można usunąć wszystkie rekordy w tabeli.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
z
|
from | True | string |
Unikatowy identyfikator tabeli. |
|
where
|
where | True | string |
Filtr do usuwania rekordów. Aby usunąć wszystkie rekordy, określ filtr, który będzie zawierać wszystkie rekordy, na przykład {3.GT.0}, gdzie 3 jest identyfikatorem pola Identyfikator rekordu. |
Zwraca
- Usuwanie odpowiedzi na rekordy
- deleteRecordsResponse
Usuwanie relacji
Użyj tego punktu końcowego, aby usunąć całą relację, w tym wszystkie pola odnośnika i podsumowania. Pole odwołania w relacji nie zostanie usunięte.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. Będzie to tabela podrzędna. |
|
Identyfikator relacji
|
relationshipId | True | double |
Identyfikator relacji. Jest to identyfikator pola odwołania w tabeli podrzędnej. |
Zwraca
- Usuń odpowiedź na relację
- deleteRelationshipResponse
Usuwanie tokenu użytkownika
Usuwa uwierzytelniony token użytkownika. Nie jest to odwracalne.
Zwraca
- Usuwanie odpowiedzi tokenu użytkownika
- deleteUserTokenResponse
Usuwanie załącznika
Usuwa jedną wersję załącznika pliku. Metadane dotyczące plików można pobrać z punktów końcowych /records i /reports, jeśli ma to zastosowanie. Użyj tych punktów końcowych, aby uzyskać informacje niezbędne do usunięcia wersji plików.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator tabeli. |
|
Identyfikator rekordu
|
recordId | True | integer |
Unikatowy identyfikator rekordu. |
|
Identyfikator pola
|
fieldId | True | integer |
Unikatowy identyfikator pola. |
|
Numer wersji
|
versionNumber | True | integer |
Numer wersji załącznika pliku. |
Zwraca
- Usuń odpowiedź na plik
- deleteFileResponse
Usuń tabelę
Usuwa określoną tabelę w aplikacji, w tym wszystkie zawarte w niej dane.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
appId | True | string |
Unikatowy identyfikator aplikacji |
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. |
Zwraca
- Usuń odpowiedź na tabelę
- deleteTableResponse
Utwórz aplikację
Tworzy aplikację na koncie. Musisz mieć uprawnienia do tworzenia aplikacji na odpowiednim koncie. Główne właściwości i zmienne aplikacji można ustawić za pomocą tego interfejsu API.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
assignToken
|
assignToken | boolean |
Ustaw wartość true, jeśli chcesz przypisać aplikację do tokenu użytkownika użytego do utworzenia aplikacji. Wartość domyślna to false. |
|
|
nazwa
|
name | True | string |
Nazwa zmiennej. |
|
value
|
value | True | string |
Wartość zmiennej. |
|
nazwa
|
name | True | string |
Nazwa aplikacji. Możesz utworzyć wiele aplikacji o tej samej nazwie, w tym samym obszarze, ponieważ będą miały różne wartości dbid. Zachęcamy, aby zachować ostrożność w tym celu. |
|
opis
|
description | string |
Opis aplikacji. Jeśli ta właściwość zostanie pominięta, opis aplikacji będzie pusty. |
Zwraca
- Tworzenie odpowiedzi aplikacji
- createAppResponse
Utwórz relację
Tworzy relację w tabeli, a także pola odnośnika/podsumowania. Relacje można tworzyć tylko dla tabel w tej samej aplikacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
summaryFid
|
summaryFid | double |
Identyfikator pola do podsumowania. |
|
|
etykieta
|
label | string |
Etykieta pola podsumowania. |
|
|
Typ akumulacja
|
accumulationType | True | string |
Typ akumulacja dla pola podsumowania. |
|
where
|
where | string |
Filtr, używając języka zapytań Quickbase, który określa rekordy do zwrócenia. |
|
|
lookupFieldIds
|
lookupFieldIds | array of integer |
Tablica identyfikatorów pól w tabeli nadrzędnej, która stanie się polami odnośników w tabeli podrzędnej. |
|
|
parentTableId
|
parentTableId | True | string |
Identyfikator tabeli nadrzędnej dla relacji. |
|
etykieta
|
label | string |
Etykieta pola klucza obcego. |
|
|
Identyfikator tabeli
|
tableId | True | string |
Unikatowy identyfikator (DBID) tabeli. Będzie to tabela podrzędna. |
Zwraca
- Tworzenie odpowiedzi na relację
- createRelationshipResponse
Uzyskiwanie tokenu tymczasowego dla DBID
Użyj tego punktu końcowego, aby uzyskać tymczasowy token autoryzacji, w zakresie aplikacji lub tabeli. Następnie możesz użyć tego tokenu, aby wykonać inne wywołania interfejsu API (zobacz autoryzację). Ten token wygaśnie za 5 minut.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Token aplikacji
|
QB-App-Token | string |
Token aplikacji Quickbase |
|
|
DBID
|
dbid | True | string |
Unikatowy identyfikator aplikacji lub tabeli. |
Zwraca
- getTempTokenDBIDResponse
- getTempTokenDBIDResponse
Wstawianie rekordów aktualizacji andora
Wstaw i/lub aktualizuj rekordy w tabeli. W tym wywołaniu pojedynczego interfejsu API można przesyłać wstawki i aktualizacje. Aktualizacja może używać pola klucza w tabeli lub innego obsługiwanego pola unikatowego. Aby uzyskać więcej informacji na temat formatowania poszczególnych typów pól, zapoznaj się ze stroną Typy pól . Ta operacja umożliwia przyrostowe przetwarzanie rekordów zakończonych powodzeniem, nawet jeśli niektóre rekordy kończą się niepowodzeniem.
Nuta: Ten punkt końcowy obsługuje maksymalny rozmiar ładunku wynoszący 10 MB.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
na
|
to | True | string |
Identyfikator tabeli. |
|
dane
|
data | object | ||
|
mergeFieldId
|
mergeFieldId | integer |
Identyfikator pola scalania. |
|
|
fieldsToReturn
|
fieldsToReturn | array of integer |
Określ tablicę identyfikatorów pól, które będą zwracać dane dla wszystkich aktualizacji lub dodanych rekordów. Identyfikator rekordu (FID 3) jest zawsze zwracany, jeśli zażądano dowolnego identyfikatora pola. |
Zwraca
Pomyślna odpowiedź zawierająca szczegóły dotyczące dodanych, zaktualizowanych lub niezmienionych rekordów. W poniższym przykładzie tabela miała wcześniej dziesięć rekordów z identyfikatorami z zakresu od 1 do 10. Użytkownik publikuje element upsert, który aktualizuje wartość rekordu 1 i dodaje dwa nowe rekordy— wszystkie pomyślnie.
- Odpowiedź upsert
- upsertResponse
Wykonywanie zapytań o dane
Przekaż zapytanie w języku zapytań Quickbase. Zwraca dane rekordów z inteligentną stronicacją na podstawie przybliżonego rozmiaru każdego rekordu. Obiekt metadanych będzie zawierać niezbędne informacje, aby iterować odpowiedź i zbierać więcej danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
pominąć
|
skip | integer |
Liczba rekordów do pominięcia. |
|
|
compareWithAppLocalTime
|
compareWithAppLocalTime | boolean |
Czy należy uruchomić zapytanie względem pola daty i godziny w odniesieniu do czasu lokalnego aplikacji. Zapytanie jest domyślnie uruchamiane z czasem UTC. |
|
|
top
|
top | integer |
Maksymalna liczba rekordów do wyświetlenia. |
|
|
where
|
where | string |
Filtr, używając języka zapytań Quickbase, który określa rekordy do zwrócenia. Jeśli ten parametr zostanie pominięty, zapytanie zwróci wszystkie rekordy. |
|
|
fieldId
|
fieldId | integer |
Unikatowy identyfikator pola w tabeli. |
|
|
Grupowanie
|
grouping | string |
Grupuj według według kolejności rosnącej (ASC), kolejności malejącej (DESC) lub równych wartości (równe wartości) |
|
|
sortBy
|
sortBy | object |
Domyślnie zapytania będą sortowane według podanych pól sortowania lub sortowania domyślnego, jeśli zapytanie nie udostępnia żadnych. Ustaw wartość false, aby uniknąć sortowania, gdy zwracana kolejność danych nie jest ważna. Zwracanie danych bez sortowania może zwiększyć wydajność. |
|
|
select
|
select | object | ||
|
z
|
from | True | string |
Identyfikator tabeli. |
Zwraca
- Uruchamianie odpowiedzi na zapytanie
- runQueryResponse
Definicje
createAppResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa aplikacji. Możesz utworzyć wiele aplikacji o tej samej nazwie, w tym samym obszarze, ponieważ będą miały różne wartości dbid. Zachęcamy, aby zachować ostrożność w tym celu. |
|
opis
|
description | string |
Opis aplikacji. Jeśli ta właściwość zostanie pominięta, opis aplikacji będzie pusty. |
|
utworzone
|
created | string |
Godzina i data utworzenia aplikacji w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
aktualizowano
|
updated | string |
Godzina i data ostatniej aktualizacji aplikacji w formacie godziny ISO 8601 RRRR-MM-DDThh:mm:ssssZ (w strefie czasowej UTC). |
|
dateFormat
|
dateFormat | string |
Opis formatu używanego podczas wyświetlania wartości daty w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w przewodniku interfejsu API, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz About Localizing Dates (Informacje o lokalizowaniu dat), aby ustawić format daty aplikacji. |
|
strefa czasowa
|
timeZone | string |
Opis strefy czasowej używanej podczas wyświetlania wartości czasu w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w portalu, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz Ustawianie strefy czasowej dla aplikacji i konta , aby ustawić strefę czasową aplikacji. |
|
id
|
id | string |
Unikatowy identyfikator tej aplikacji. |
|
hasEveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
Wskazuje, czy aplikacja zawiera dostęp wszyscy w Internecie. Zobacz Udostępnianie aplikacji wszystkim w Internecie (EOTI). |
|
variables
|
variables | array of Variable1 |
Zmienne aplikacji. Zobacz About Application Variables (Informacje o zmiennych aplikacji) |
|
dataClassification
|
dataClassification | string |
Etykieta Klasyfikacja danych przypisana do aplikacji. Jeśli funkcja klasyfikacji danych nie jest włączona, nie zostanie ona zwrócona. Jeśli funkcja klasyfikacji danych jest włączona, ale aplikacja nie jest oznaczona etykietą, zwracamy wartość "Brak". Etykiety klasyfikacji danych można dodać w konsoli administracyjnej przez administratora obszaru dla planów platformy+. |
Zmienna1
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa zmiennej. |
|
value
|
value | string |
Wartość zmiennej. |
getAppResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa aplikacji. Możesz utworzyć wiele aplikacji o tej samej nazwie, w tym samym obszarze, ponieważ będą miały różne wartości dbid. Zachęcamy, aby zachować ostrożność w tym celu. |
|
opis
|
description | string |
Opis aplikacji. Jeśli ta właściwość zostanie pominięta, opis aplikacji będzie pusty. |
|
utworzone
|
created | string |
Godzina i data utworzenia aplikacji w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
aktualizowano
|
updated | string |
Godzina i data ostatniej aktualizacji aplikacji w formacie godziny ISO 8601 RRRR-MM-DDThh:mm:ssssZ (w strefie czasowej UTC). |
|
dateFormat
|
dateFormat | string |
Opis formatu używanego podczas wyświetlania wartości daty w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w przewodniku interfejsu API, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz About Localizing Dates (Informacje o lokalizowaniu dat), aby ustawić format daty aplikacji. |
|
strefa czasowa
|
timeZone | string |
Opis strefy czasowej używanej podczas wyświetlania wartości czasu w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w portalu, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz Ustawianie strefy czasowej dla aplikacji i konta , aby ustawić strefę czasową aplikacji. |
|
id
|
id | string |
Unikatowy identyfikator tej aplikacji. |
|
hasEveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
Wskazuje, czy aplikacja zawiera dostęp wszyscy w Internecie. Zobacz Udostępnianie aplikacji wszystkim w Internecie (EOTI). |
|
variables
|
variables | array of Variable1 |
Zmienne aplikacji. Zobacz About Application Variables (Informacje o zmiennych aplikacji) |
|
dataClassification
|
dataClassification | string |
Etykieta Klasyfikacja danych przypisana do aplikacji. Jeśli funkcja klasyfikacji danych nie jest włączona, nie zostanie ona zwrócona. Jeśli funkcja klasyfikacji danych jest włączona, ale aplikacja nie jest oznaczona etykietą, zwracamy wartość "Brak". Etykiety klasyfikacji danych można dodać w konsoli administracyjnej przez administratora obszaru dla planów platformy+. |
updateAppResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa aplikacji. Możesz utworzyć wiele aplikacji o tej samej nazwie, w tym samym obszarze, ponieważ będą miały różne wartości dbid. Zachęcamy, aby zachować ostrożność w tym celu. |
|
opis
|
description | string |
Opis aplikacji. Jeśli ta właściwość zostanie pominięta, opis aplikacji będzie pusty. |
|
utworzone
|
created | string |
Godzina i data utworzenia aplikacji w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
aktualizowano
|
updated | string |
Godzina i data ostatniej aktualizacji aplikacji w formacie godziny ISO 8601 RRRR-MM-DDThh:mm:ssssZ (w strefie czasowej UTC). |
|
dateFormat
|
dateFormat | string |
Opis formatu używanego podczas wyświetlania wartości daty w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w przewodniku interfejsu API, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz About Localizing Dates (Informacje o lokalizowaniu dat), aby ustawić format daty aplikacji. |
|
strefa czasowa
|
timeZone | string |
Opis strefy czasowej używanej podczas wyświetlania wartości czasu w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w portalu, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz Ustawianie strefy czasowej dla aplikacji i konta , aby ustawić strefę czasową aplikacji. |
|
id
|
id | string |
Unikatowy identyfikator tej aplikacji. |
|
hasEveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
Wskazuje, czy aplikacja zawiera dostęp wszyscy w Internecie. Zobacz Udostępnianie aplikacji wszystkim w Internecie (EOTI). |
|
variables
|
variables | array of Variable1 |
Zmienne aplikacji. Zobacz About Application Variables (Informacje o zmiennych aplikacji) |
|
dataClassification
|
dataClassification | string |
Etykieta Klasyfikacja danych przypisana do aplikacji. Jeśli funkcja klasyfikacji danych nie jest włączona, nie zostanie ona zwrócona. Jeśli funkcja klasyfikacji danych jest włączona, ale aplikacja nie jest oznaczona etykietą, zwracamy wartość "Brak". Etykiety klasyfikacji danych można dodać w konsoli administracyjnej przez administratora obszaru dla planów platformy+. |
deleteAppResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
deletedAppId
|
deletedAppId | string |
Identyfikator usuniętej aplikacji. |
copyAppResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa aplikacji. Możesz utworzyć wiele aplikacji o tej samej nazwie, w tym samym obszarze, ponieważ będą miały różne wartości dbid. Zachęcamy, aby zachować ostrożność w tym celu. |
|
opis
|
description | string |
Opis aplikacji |
|
utworzone
|
created | string |
Godzina i data utworzenia aplikacji w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
aktualizowano
|
updated | string |
Godzina i data ostatniej aktualizacji aplikacji w formacie godziny ISO 8601 RRRR-MM-DDThh:mm:ssssZ (w strefie czasowej UTC). |
|
dateFormat
|
dateFormat | string |
Opis formatu używanego podczas wyświetlania wartości daty w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w przewodniku interfejsu API, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz About Localizing Dates (Informacje o lokalizowaniu dat), aby ustawić format daty aplikacji. |
|
strefa czasowa
|
timeZone | string |
Opis strefy czasowej używanej podczas wyświetlania wartości czasu w tej aplikacji. Należy pamiętać, że jest to parametr tylko dla przeglądarki — zobacz stronę Szczegóły typu pola w portalu, aby dowiedzieć się, jak wartości czasu są zwracane w wywołaniach interfejsu API. Zobacz Ustawianie strefy czasowej dla aplikacji i konta , aby ustawić strefę czasową aplikacji. |
|
id
|
id | string |
Unikatowy identyfikator tej aplikacji. |
|
hasEveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
Wskazuje, czy aplikacja zawiera dostęp wszyscy w Internecie. Zobacz Udostępnianie aplikacji wszystkim w Internecie (EOTI). |
|
variables
|
variables | array of Variable1 |
Zmienne aplikacji. Zobacz About Application Variables (Informacje o zmiennych aplikacji) |
|
ancestorId
|
ancestorId | string |
Identyfikator aplikacji, z której została skopiowana ta aplikacja |
|
dataClassification
|
dataClassification | string |
Etykieta Klasyfikacja danych przypisana do aplikacji. Jeśli funkcja klasyfikacji danych nie jest włączona, nie zostanie ona zwrócona. Jeśli funkcja klasyfikacji danych jest włączona, ale aplikacja nie jest oznaczona etykietą, zwracamy wartość "Brak". Etykiety klasyfikacji danych można dodać w konsoli administracyjnej przez administratora obszaru dla planów platformy+. |
createTableResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa tabeli. |
|
id
|
id | string |
Unikatowy identyfikator (dbid) tabeli. |
|
alias
|
alias | string |
Automatycznie utworzony alias tabeli dla tabeli. |
|
opis
|
description | string |
Opis tabeli zgodnie z konfiguracją administratora aplikacji. |
|
utworzone
|
created | string |
Godzina i data utworzenia tabeli w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
aktualizowano
|
updated | string |
Godzina i data ostatniej aktualizacji schematu tabeli lub danych w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
nextRecordId
|
nextRecordId | integer |
Identyfikator rekordu przyrostowego, który będzie używany podczas tworzenia następnego rekordu określonego podczas uruchamiania wywołania interfejsu API. |
|
nextFieldId
|
nextFieldId | integer |
Przyrostowy identyfikator pola, który będzie używany podczas tworzenia następnego pola, zgodnie z ustaleniem, kiedy zostało uruchomione wywołanie interfejsu API. |
|
defaultSortFieldId
|
defaultSortFieldId | integer |
Identyfikator pola skonfigurowanego do sortowania domyślnego. |
|
DefaultSortOrder
|
defaultSortOrder | DefaultSortOrder |
Konfiguracja domyślnej kolejności sortowania w tabeli. |
|
keyFieldId
|
keyFieldId | integer |
Identyfikator pola skonfigurowanego jako klucz w tej tabeli, który jest zwykle identyfikatorem rekordu Quickbase. |
|
singleRecordName
|
singleRecordName | string |
Skonfigurowana przez konstruktora pojedyncza nazwa tabeli. |
|
pluralRecordName
|
pluralRecordName | string |
Liczba mnoga skonfigurowana przez konstruktora w tabeli. |
|
sizeLimit
|
sizeLimit | string |
Limit rozmiaru tabeli. |
|
spaceUsed
|
spaceUsed | string |
Ilość miejsca aktualnie używanego przez tabelę. |
|
spaceRemaining
|
spaceRemaining | string |
Ilość miejsca pozostałego do użycia przez tabelę. |
DefaultSortOrder
Konfiguracja domyślnej kolejności sortowania w tabeli.
Konfiguracja domyślnej kolejności sortowania w tabeli.
- DefaultSortOrder
- string
getTableResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa tabeli. |
|
id
|
id | string |
Unikatowy identyfikator (dbid) tabeli. |
|
alias
|
alias | string |
Automatycznie utworzony alias tabeli dla tabeli. |
|
opis
|
description | string |
Opis tabeli zgodnie z konfiguracją administratora aplikacji. |
|
utworzone
|
created | string |
Godzina i data utworzenia tabeli w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
aktualizowano
|
updated | string |
Godzina i data ostatniej aktualizacji schematu tabeli lub danych w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
nextRecordId
|
nextRecordId | integer |
Identyfikator rekordu przyrostowego, który będzie używany podczas tworzenia następnego rekordu określonego podczas uruchamiania wywołania interfejsu API. |
|
nextFieldId
|
nextFieldId | integer |
Przyrostowy identyfikator pola, który będzie używany podczas tworzenia następnego pola, zgodnie z ustaleniem, kiedy zostało uruchomione wywołanie interfejsu API. |
|
defaultSortFieldId
|
defaultSortFieldId | integer |
Identyfikator pola skonfigurowanego do sortowania domyślnego. |
|
DefaultSortOrder
|
defaultSortOrder | DefaultSortOrder |
Konfiguracja domyślnej kolejności sortowania w tabeli. |
|
keyFieldId
|
keyFieldId | integer |
Identyfikator pola skonfigurowanego jako klucz w tej tabeli, który jest zwykle identyfikatorem rekordu Quickbase. |
|
singleRecordName
|
singleRecordName | string |
Skonfigurowana przez konstruktora pojedyncza nazwa tabeli. |
|
pluralRecordName
|
pluralRecordName | string |
Liczba mnoga skonfigurowana przez konstruktora w tabeli. |
|
sizeLimit
|
sizeLimit | string |
Limit rozmiaru tabeli. |
|
spaceUsed
|
spaceUsed | string |
Ilość miejsca aktualnie używanego przez tabelę. |
|
spaceRemaining
|
spaceRemaining | string |
Ilość miejsca pozostałego do użycia przez tabelę. |
updateTableResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa tabeli. |
|
id
|
id | string |
Unikatowy identyfikator (dbid) tabeli. |
|
alias
|
alias | string |
Automatycznie utworzony alias tabeli dla tabeli. |
|
opis
|
description | string |
Opis tabeli zgodnie z konfiguracją administratora aplikacji. |
|
utworzone
|
created | string |
Godzina i data utworzenia tabeli w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
aktualizowano
|
updated | string |
Godzina i data ostatniej aktualizacji schematu tabeli lub danych w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
nextRecordId
|
nextRecordId | integer |
Identyfikator rekordu przyrostowego, który będzie używany podczas tworzenia następnego rekordu określonego podczas uruchamiania wywołania interfejsu API. |
|
nextFieldId
|
nextFieldId | integer |
Przyrostowy identyfikator pola, który będzie używany podczas tworzenia następnego pola, zgodnie z ustaleniem, kiedy zostało uruchomione wywołanie interfejsu API. |
|
defaultSortFieldId
|
defaultSortFieldId | integer |
Identyfikator pola skonfigurowanego do sortowania domyślnego. |
|
DefaultSortOrder
|
defaultSortOrder | DefaultSortOrder |
Konfiguracja domyślnej kolejności sortowania w tabeli. |
|
keyFieldId
|
keyFieldId | integer |
Identyfikator pola skonfigurowanego jako klucz w tej tabeli, który jest zwykle identyfikatorem rekordu Quickbase. |
|
singleRecordName
|
singleRecordName | string |
Skonfigurowana przez konstruktora pojedyncza nazwa tabeli. |
|
pluralRecordName
|
pluralRecordName | string |
Liczba mnoga skonfigurowana przez konstruktora w tabeli. |
|
sizeLimit
|
sizeLimit | string |
Limit rozmiaru tabeli. |
|
spaceUsed
|
spaceUsed | string |
Ilość miejsca aktualnie używanego przez tabelę. |
|
spaceRemaining
|
spaceRemaining | string |
Ilość miejsca pozostałego do użycia przez tabelę. |
deleteTableResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
deletedTableId
|
deletedTableId | string |
Usunięty identyfikator tabeli. |
getRelationshipsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Relacje
|
relationships | array of Relationship |
Relacje w tabeli. |
|
Metadane
|
metadata | Metadata |
Dodatkowe informacje o wynikach, które mogą być przydatne. |
Relacja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator relacji (identyfikator pola klucza obcego). |
|
parentTableId
|
parentTableId | string |
Identyfikator tabeli nadrzędnej relacji. |
|
childTableId
|
childTableId | string |
Identyfikator tabeli podrzędnej relacji. |
|
ForeignKeyField
|
foreignKeyField | ForeignKeyField |
Informacje o polu klucza obcego. |
|
isCrossApp
|
isCrossApp | boolean |
Czy jest to relacja między aplikacjami. |
|
lookupFields
|
lookupFields | array of LookupField |
Tablica pól odnośników. |
|
summaryFields
|
summaryFields | array of SummaryField |
Tablica pól podsumowania. |
ForeignKeyField
Informacje o polu klucza obcego.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola. |
|
etykieta
|
label | string |
Etykieta pola. |
|
typ
|
type | string |
Typ pola. |
Pole odnośnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola. |
|
etykieta
|
label | string |
Etykieta pola. |
|
typ
|
type | string |
Typ pola. |
Pole podsumowania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola. |
|
etykieta
|
label | string |
Etykieta pola. |
|
typ
|
type | string |
Typ pola. |
Metadane
Dodatkowe informacje o wynikach, które mogą być przydatne.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pominąć
|
skip | integer |
Liczba relacji do pominięcia. |
|
totalRelationships
|
totalRelationships | integer |
Łączna liczba relacji. |
|
numRelationships
|
numRelationships | integer |
Liczba relacji w bieżącym obiekcie odpowiedzi. |
createRelationshipResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator relacji (identyfikator pola klucza obcego). |
|
parentTableId
|
parentTableId | string |
Identyfikator tabeli nadrzędnej relacji. |
|
childTableId
|
childTableId | string |
Identyfikator tabeli podrzędnej relacji. |
|
ForeignKeyField
|
foreignKeyField | ForeignKeyField |
Informacje o polu klucza obcego. |
|
isCrossApp
|
isCrossApp | boolean |
Czy jest to relacja między aplikacjami. |
|
lookupFields
|
lookupFields | array of LookupField |
Tablica pól odnośników. |
|
summaryFields
|
summaryFields | array of SummaryField |
Tablica pól podsumowania. |
updateRelationshipResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator relacji (identyfikator pola klucza obcego). |
|
parentTableId
|
parentTableId | string |
Identyfikator tabeli nadrzędnej relacji. |
|
childTableId
|
childTableId | string |
Identyfikator tabeli podrzędnej relacji. |
|
ForeignKeyField
|
foreignKeyField | ForeignKeyField |
Informacje o polu klucza obcego. |
|
isCrossApp
|
isCrossApp | boolean |
Czy jest to relacja między aplikacjami. |
|
lookupFields
|
lookupFields | array of LookupField |
Tablica pól odnośników. |
|
summaryFields
|
summaryFields | array of SummaryField |
Tablica pól podsumowania. |
deleteRelationshipResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
relationshipId
|
relationshipId | integer |
Identyfikator relacji. |
Query
Definicja zapytania skonfigurowana w programie Quickbase, która jest wykonywana po uruchomieniu raportu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
tableId
|
tableId | string |
Identyfikator tabeli raportu. |
|
filtr
|
filter | string |
Filtr używany do wykonywania zapytań dotyczących danych. |
|
formulaFields
|
formulaFields | array of FormulaField |
Pola formuły obliczeniowej. |
Pole formuły
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola formuły. |
|
etykieta
|
label | string |
Etykieta pola formuły. |
|
Typ pola
|
fieldType | FieldType |
Wynikowy typ wartości formuły. |
|
formuła
|
formula | string |
Tekst formuły. |
|
liczba dziesiętnaPrzecision
|
decimalPrecision | integer |
W przypadku formuły liczbowej precyzja liczbowa. |
Typ pola
getReportResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator raportu, unikatowy dla tabeli. |
|
nazwa
|
name | string |
Skonfigurowana nazwa raportu. |
|
typ
|
type | string |
Typ raportu w quickbase (np. wykres). |
|
opis
|
description | string |
Skonfigurowany opis raportu. |
|
Identyfikator właściciela
|
ownerId | integer |
Opcjonalne, wyświetlane tylko w przypadku raportów osobistych. Identyfikator użytkownika właściciela raportu. |
|
Query
|
query | Query |
Definicja zapytania skonfigurowana w programie Quickbase, która jest wykonywana po uruchomieniu raportu. |
|
properties
|
properties | object |
Lista właściwości specyficznych dla typu raportu. Aby wyświetlić szczegółowy opis właściwości każdego typu raportu, zobacz Typy raportów. |
|
usedLast
|
usedLast | string |
Moment ostatniego użycia raportu. |
|
usedCount
|
usedCount | integer |
Liczba przypadków użycia raportu. |
runReportResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pola
|
fields | array of Field |
Tablica obiektów, która zawiera ograniczone metadane każdego pola wyświetlanego w raporcie. Pomaga to w tworzeniu logiki, która zależy od typów pól i identyfikatorów. |
|
dane
|
data | array of object |
Tablica obiektów, które reprezentują dane rekordu lub podsumowane wartości, w zależności od typu raportu. |
|
items
|
data | object | |
|
Metadane1
|
metadata | Metadata1 |
Dodatkowe informacje o wynikach, które mogą być przydatne. Jeśli określisz mniejszą liczbę wyników do pominięcia niż jest dostępna, może być konieczne stronicowanie lub jeśli interfejs API automatycznie zwraca mniej wyników. LiczbaRekordów można porównać do wartości totalRecords, aby określić, czy jest potrzebna dalsza stronicowanie. |
(No changes needed)
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola. |
|
etykieta
|
label | string |
Etykieta pola. |
|
typ
|
type | string |
Typ pola. |
|
labelOverride
|
labelOverride | string |
Etykieta nagłówka kolumny zastępuje pole w raporcie. |
Metadane1
Dodatkowe informacje o wynikach, które mogą być przydatne. Jeśli określisz mniejszą liczbę wyników do pominięcia niż jest dostępna, może być konieczne stronicowanie lub jeśli interfejs API automatycznie zwraca mniej wyników. LiczbaRekordów można porównać do wartości totalRecords, aby określić, czy jest potrzebna dalsza stronicowanie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pominąć
|
skip | integer |
Liczba rekordów do pominięcia |
|
numFields
|
numFields | integer |
Liczba pól w każdym rekordzie w bieżącym obiekcie odpowiedzi |
|
top
|
top | integer |
Jeśli istnieje, maksymalna liczba rekordów żądanych przez obiekt wywołujący |
|
totalRecords
|
totalRecords | integer |
Całkowita liczba rekordów w zestawie wyników |
|
numRecords
|
numRecords | integer |
Liczba rekordów w bieżącym obiekcie odpowiedzi |
Właściwości1
Dodatkowe właściwości pola. Aby uzyskać więcej informacji na temat właściwości dla każdego typu pola, zobacz stronę Szczegóły typu pola.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
comments
|
comments | string |
Komentarze wprowadzone we właściwościach pola przez administratora. |
|
doesTotal
|
doesTotal | boolean |
Określa, czy to pole sumuje się w raportach w produkcie. |
|
autozapis
|
autoSave | boolean |
Czy pole łącza zostanie automatycznie zapisane. |
|
defaultValueLuid
|
defaultValueLuid | integer |
Domyślna wartość identyfikatora użytkownika. |
|
maxVersions
|
maxVersions | integer |
Maksymalna liczba wersji skonfigurowanych dla załącznika pliku. |
|
carryChoices
|
carryChoices | boolean |
Czy pole powinno przenosić pola wielokrotnego wyboru podczas kopiowania. |
|
format
|
format | integer |
Format wyświetlania czasu. |
|
maksymalna długość
|
maxLength | integer |
Maksymalna liczba znaków dozwolona dla wpisu w quickbase dla tego pola. |
|
linkTekst
|
linkText | string |
Skonfigurowana wartość tekstowa, która zastępuje adres URL widoczny dla użytkowników w produkcie. |
|
parentFieldId
|
parentFieldId | integer |
Identyfikator nadrzędnego pola złożonego, jeśli ma to zastosowanie. |
|
displayTimezone
|
displayTimezone | boolean |
Wskazuje, czy ma być wyświetlana strefa czasowa w produkcie. |
|
summaryTargetFieldId
|
summaryTargetFieldId | integer |
Identyfikator pola używanego do agregowania wartości z elementu podrzędnego, jeśli ma to zastosowanie. Spowoduje to wyświetlenie wartości 0, jeśli funkcja podsumowania nie wymaga zaznaczenia pola (na przykład liczba). |
|
allowNewChoices
|
allowNewChoices | boolean |
Wskazuje, czy użytkownicy mogą dodawać nowe opcje do listy wyboru. |
|
masterChoiceFieldId
|
masterChoiceFieldId | integer |
Identyfikator pola, które jest odwołaniem w relacji. |
|
defaultToday
|
defaultToday | boolean |
Wskazuje, czy wartość pola jest obecnie domyślna dla nowych rekordów. |
|
Jednostek
|
units | string |
Etykieta jednostek. |
|
lookupTargetFieldId
|
lookupTargetFieldId | integer |
Identyfikator pola, które jest elementem docelowym w tabeli głównej dla tego odnośnika. |
|
SummaryFunction
|
summaryFunction | SummaryFunction |
Typ funkcji akumulacyjnych podsumowania. |
|
sourceFieldId
|
sourceFieldId | integer |
Identyfikator pola źródłowego. |
|
masterTableTag
|
masterTableTag | string |
Alias tabeli dla tabeli głównej w relacji jest częścią tego pola. |
|
doesAverage
|
doesAverage | boolean |
Określa, czy to pole jest średnie w raportach w produkcie. |
|
formuła
|
formula | string |
Formuła pola skonfigurowana w programie Quickbase. |
|
liczba miejsc dziesiętnych
|
decimalPlaces | integer |
Liczba miejsc dziesiętnych wyświetlanych w produkcie dla tego pola. |
|
seeVersions
|
seeVersions | boolean |
Wskazuje, czy użytkownik może zobaczyć inne wersje, oprócz najnowszych, załącznika pliku w produkcie. |
|
displayMonth
|
displayMonth | string |
Jak wyświetlać miesiące. |
|
numLines
|
numLines | integer |
Liczba wierszy wyświetlanych w przewodniku Quickbase dla tego pola tekstowego. |
|
displayEmail
|
displayEmail | string |
Jak jest wyświetlana wiadomość e-mail. |
|
defaultKind
|
defaultKind | string |
Domyślny typ użytkownika. |
|
coverText
|
coverText | string |
Alternatywny tekst przyjazny dla użytkownika, który może służyć do wyświetlania linku w przeglądarce. |
|
currencySymbol
|
currencySymbol | string |
Bieżący symbol używany podczas wyświetlania wartości pól w produkcie. |
|
masterChoiceTableId
|
masterChoiceTableId | integer |
Identyfikator tabeli, która jest wzorcem w tej relacji. |
|
targetFieldId
|
targetFieldId | integer |
Identyfikator pola docelowego. |
|
displayUser
|
displayUser | string |
Skonfigurowana opcja sposobu wyświetlania użytkowników w produkcie. |
|
blankIsZero
|
blankIsZero | boolean |
Czy wartość pusta jest traktowana tak samo jak 0 w obliczeniach w produkcie. |
|
dokładny
|
exact | boolean |
Czy dokładne dopasowanie jest wymagane dla linku raportu. |
|
startField
|
startField | integer |
Identyfikator pola początkowego. |
|
defaultDomain
|
defaultDomain | string |
Domyślna domena poczty e-mail. |
|
defaultValue (wartość domyślna)
|
defaultValue | string |
Wartość domyślna skonfigurowana dla pola po dodaniu nowego rekordu. |
|
choicesLuid
|
choicesLuid | array of object |
Lista opcji użytkownika. |
|
items
|
choicesLuid | object | |
|
skracać
|
abbreviate | boolean |
Nie pokazuj protokołu URL podczas wyświetlania adresu URL. |
|
xmlTag
|
xmlTag | string |
Tag XML pola. |
|
targetTableName
|
targetTableName | string |
Nazwa tabeli docelowej pola. |
|
numberFormat
|
numberFormat | integer |
Format używany do wyświetlania wartości liczbowych w produkcie (dziesiętne, separatory, grupa cyfr). |
|
pojawia się Jako
|
appearsAs | string |
Tekst linku, jeśli jest pusty, adres URL będzie używany jako tekst linku. |
|
width
|
width | integer |
Szerokość danych wejściowych HTML pola w produkcie. |
|
Format waluty
|
currencyFormat | CurrencyFormat |
Format waluty używany podczas wyświetlania wartości pól w produkcie. |
|
displayImages
|
displayImages | boolean |
Wskazuje, czy obrazy będą wyświetlane dla załączników plików w formularzach i raportach w produkcie. |
|
foreignKey
|
foreignKey | boolean |
Wskazuje, czy pole jest kluczem obcym (lub polem odwołania) w relacji. |
|
displayDayOfWeek
|
displayDayOfWeek | boolean |
Wskazuje, czy ma być wyświetlany dzień tygodnia w produkcie. |
|
summaryReferenceFieldId
|
summaryReferenceFieldId | integer |
Identyfikator pola, które jest odwołaniem w relacji dla tego podsumowania. |
|
przecinekStart
|
commaStart | integer |
Liczba cyfr przed przecinkami wyświetlana w produkcie, jeśli ma to zastosowanie. |
|
choices
|
choices | array of string |
Tablica wpisów, które istnieją dla pola, które oferuje użytkownikowi opcje wyboru. |
|
targetTableId
|
targetTableId | string |
Identyfikator tabeli docelowej. |
|
displayRelative
|
displayRelative | boolean |
Określa, czy czas ma być wyświetlany jako względny. |
|
compositeFields
|
compositeFields | array of object |
Tablica pól tworzących pole złożone (np. adres). |
|
items
|
compositeFields | object | |
|
VersionMode
|
versionMode | VersionMode |
Tryby wersji dla plików. Zachowaj wszystkie wersje i zachowaj ostatnią wersję. |
|
displayTime
|
displayTime | boolean |
Wskazuje, czy ma być wyświetlana godzina, oprócz daty. |
|
durationField
|
durationField | integer |
Identyfikator pola czasu trwania. |
|
snapFieldId
|
snapFieldId | integer |
Identyfikator pola używanego do tworzenia migawek wartości z , jeśli ma to zastosowanie. |
|
godz. 24
|
hours24 | boolean |
Wskazuje, czy czas ma być wyświetlany w formacie 24-godzinnym w produkcie. |
|
sortAlpha
|
sortAlpha | boolean |
Czy sortować alfabetycznie, sortowanie domyślne jest według identyfikatora rekordu. |
|
sortAsGiven
|
sortAsGiven | boolean |
Wskazuje, czy wymienione wpisy są sortowane zgodnie z wprowadzonymi w kolejności alfabetycznej. |
|
hasExtension
|
hasExtension | boolean |
Czy to pole ma rozszerzenie telefonu. |
|
Workweek
|
workWeek | integer |
Typ tygodnia roboczego. |
|
useNewWindow
|
useNewWindow | boolean |
Wskazuje, czy adres URL powinien otworzyć nowe okno, gdy użytkownik kliknie go w produkcie. |
|
appendOnly
|
appendOnly | boolean |
Czy to pole jest dołączane tylko. |
|
displayAsLink
|
displayAsLink | boolean |
Wskazuje, czy pole będące częścią relacji powinno być wyświetlane jako hiperlink do rekordu nadrzędnego w produkcie. |
|
allowHTML
|
allowHTML | boolean |
Czy to pole zezwala na kod HTML. |
|
lookupReferenceFieldId
|
lookupReferenceFieldId | integer |
Identyfikator pola, które jest odwołaniem w relacji dla tego odnośnika. |
SummaryFunction
Typ funkcji akumulacyjnych podsumowania.
Typ funkcji akumulacyjnych podsumowania.
- SummaryFunction
- string
Format waluty
Format waluty używany podczas wyświetlania wartości pól w produkcie.
Format waluty używany podczas wyświetlania wartości pól w produkcie.
- Format waluty
- string
VersionMode
Tryby wersji dla plików. Zachowaj wszystkie wersje i zachowaj ostatnią wersję.
Tryby wersji dla plików. Zachowaj wszystkie wersje i zachowaj ostatnią wersję.
- VersionMode
- string
Pozwolenie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
rola
|
role | string |
Rola skojarzona z danym uprawnieniem dla pola |
|
permissionType
|
permissionType | string |
Uprawnienie przydzielone roli dla tego pola |
|
roleId (identyfikator roli)
|
roleId | integer |
Identyfikator danej roli |
createFieldResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola unikatowego dla tej tabeli. |
|
fieldType (typ_pola)
|
fieldType | string |
Typ pola, zgodnie z opisem w tym miejscu. |
|
mode
|
mode | string |
W przypadku pól pochodnych będzie to "wyszukiwanie", "podsumowanie" lub "formuła", aby wskazać typ pola pochodnego. W przypadku pól innych niż pochodne będzie to puste. |
|
etykieta
|
label | string |
Etykieta (nazwa) pola. |
|
noWrap
|
noWrap | boolean |
Wskazuje, czy pole jest skonfigurowane tak, aby nie opakowować w przypadku wyświetlania w produkcie. |
|
bold
|
bold | boolean |
Wskazuje, czy pole jest skonfigurowane do wyświetlania pogrubionego w produkcie. |
|
required
|
required | boolean |
Wskazuje, czy pole jest oznaczone jako wymagane. |
|
pojawia sięByDefault
|
appearsByDefault | boolean |
Wskazuje, czy pole jest oznaczone jako domyślne w raportach. |
|
findEnabled
|
findEnabled | boolean |
Wskazuje, czy pole jest oznaczone jako możliwe do wyszukiwania. |
|
niepowtarzalny
|
unique | boolean |
Wskazuje, czy pole jest oznaczone jako unikatowe. |
|
doesDataCopy
|
doesDataCopy | boolean |
Wskazuje, czy dane pola będą kopiowały, gdy użytkownik kopiuje rekord. |
|
fieldHelp
|
fieldHelp | string |
Skonfigurowany tekst pomocy wyświetlany użytkownikom w produkcie. |
|
Inspekcji
|
audited | boolean |
Wskazuje, czy pole jest śledzone w ramach dzienników inspekcji quickbase. |
|
Właściwości1
|
properties | Properties1 |
Dodatkowe właściwości pola. Aby uzyskać więcej informacji na temat właściwości dla każdego typu pola, zobacz stronę Szczegóły typu pola. |
|
uprawnienia
|
permissions | array of Permission |
Uprawnienia pola dla różnych ról. |
deleteFieldsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
deletedFieldIds
|
deletedFieldIds | array of integer |
Lista identyfikatorów pól do usunięcia. |
|
Błędy
|
errors | array of string |
Lista znalezionych błędów. |
getFieldResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola unikatowego dla tej tabeli. |
|
fieldType (typ_pola)
|
fieldType | string |
Typ pola, zgodnie z opisem w tym miejscu. |
|
mode
|
mode | string |
W przypadku pól pochodnych będzie to "wyszukiwanie", "podsumowanie" lub "formuła", aby wskazać typ pola pochodnego. W przypadku pól innych niż pochodne będzie to puste. |
|
etykieta
|
label | string |
Etykieta (nazwa) pola. |
|
noWrap
|
noWrap | boolean |
Wskazuje, czy pole jest skonfigurowane tak, aby nie opakowować w przypadku wyświetlania w produkcie. |
|
bold
|
bold | boolean |
Wskazuje, czy pole jest skonfigurowane do wyświetlania pogrubionego w produkcie. |
|
required
|
required | boolean |
Wskazuje, czy pole jest oznaczone jako wymagane. |
|
pojawia sięByDefault
|
appearsByDefault | boolean |
Wskazuje, czy pole jest oznaczone jako domyślne w raportach. |
|
findEnabled
|
findEnabled | boolean |
Wskazuje, czy pole jest oznaczone jako możliwe do wyszukiwania. |
|
niepowtarzalny
|
unique | boolean |
Wskazuje, czy pole jest oznaczone jako unikatowe. |
|
doesDataCopy
|
doesDataCopy | boolean |
Wskazuje, czy dane pola będą kopiowały, gdy użytkownik kopiuje rekord. |
|
fieldHelp
|
fieldHelp | string |
Skonfigurowany tekst pomocy wyświetlany użytkownikom w produkcie. |
|
Inspekcji
|
audited | boolean |
Wskazuje, czy pole jest śledzone w ramach dzienników inspekcji quickbase. |
|
Właściwości1
|
properties | Properties1 |
Dodatkowe właściwości pola. Aby uzyskać więcej informacji na temat właściwości dla każdego typu pola, zobacz stronę Szczegóły typu pola. |
|
uprawnienia
|
permissions | array of Permission |
Uprawnienia pola dla różnych ról. |
updateFieldResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola unikatowego dla tej tabeli. |
|
fieldType (typ_pola)
|
fieldType | string |
Typ pola, zgodnie z opisem w tym miejscu. |
|
mode
|
mode | string |
W przypadku pól pochodnych będzie to "wyszukiwanie", "podsumowanie" lub "formuła", aby wskazać typ pola pochodnego. W przypadku pól innych niż pochodne będzie to puste. |
|
etykieta
|
label | string |
Etykieta (nazwa) pola. |
|
noWrap
|
noWrap | boolean |
Wskazuje, czy pole jest skonfigurowane tak, aby nie opakowować w przypadku wyświetlania w produkcie. |
|
bold
|
bold | boolean |
Wskazuje, czy pole jest skonfigurowane do wyświetlania pogrubionego w produkcie. |
|
required
|
required | boolean |
Wskazuje, czy pole jest oznaczone jako wymagane. |
|
pojawia sięByDefault
|
appearsByDefault | boolean |
Wskazuje, czy pole jest oznaczone jako domyślne w raportach. |
|
findEnabled
|
findEnabled | boolean |
Wskazuje, czy pole jest oznaczone jako możliwe do wyszukiwania. |
|
niepowtarzalny
|
unique | boolean |
Wskazuje, czy pole jest oznaczone jako unikatowe. |
|
doesDataCopy
|
doesDataCopy | boolean |
Wskazuje, czy dane pola będą kopiowały, gdy użytkownik kopiuje rekord. |
|
fieldHelp
|
fieldHelp | string |
Skonfigurowany tekst pomocy wyświetlany użytkownikom w produkcie. |
|
Inspekcji
|
audited | boolean |
Wskazuje, czy pole jest śledzone w ramach dzienników inspekcji quickbase. |
|
Właściwości1
|
properties | Properties1 |
Dodatkowe właściwości pola. Aby uzyskać więcej informacji na temat właściwości dla każdego typu pola, zobacz stronę Szczegóły typu pola. |
|
uprawnienia
|
permissions | array of Permission |
Uprawnienia pola dla różnych ról. |
runFormulaResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wynik
|
result | string |
Wynik wykonania formuły. |
upsertResponse
Pomyślna odpowiedź zawierająca szczegóły dotyczące dodanych, zaktualizowanych lub niezmienionych rekordów. W poniższym przykładzie tabela miała wcześniej dziesięć rekordów z identyfikatorami z zakresu od 1 do 10. Użytkownik publikuje element upsert, który aktualizuje wartość rekordu 1 i dodaje dwa nowe rekordy— wszystkie pomyślnie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Metadane 2
|
metadata | Metadata2 |
Informacje o utworzonych rekordach, zaktualizowanych rekordach, przywoływane, ale niezmienione rekordy oraz rekordy o błędach podczas przetwarzania. |
|
dane
|
data | array of object |
Dane, które mają zostać zwrócone. |
|
items
|
data | object |
Metadane 2
Informacje o utworzonych rekordach, zaktualizowanych rekordach, przywoływane, ale niezmienione rekordy oraz rekordy o błędach podczas przetwarzania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
createdRecordIds
|
createdRecordIds | array of integer |
Tablica zawierająca utworzone identyfikatory rekordów. |
|
lineErrors
|
lineErrors | object |
Zostanie to zwrócone tylko w przypadku rekordów, które zakończyły się niepowodzeniem. Jest to zbiór błędów, które wystąpiły podczas przetwarzania danych przychodzących, które spowodowały, że rekordy nie były przetwarzane. Każdy obiekt ma klucz reprezentujący numer sekwencji rekordu w oryginalnym ładunku (począwszy od 1). Wartość to lista błędów, które wystąpiły. |
|
niezmienione IdentyfikatoryRekordu
|
unchangedRecordIds | array of integer |
Tablica zawierająca niezmienione identyfikatory rekordów. |
|
updatedRecordIds
|
updatedRecordIds | array of integer |
Tablica zawierająca zaktualizowane identyfikatory rekordów. |
|
totalNumberOfRecordsProcessed
|
totalNumberOfRecordsProcessed | integer |
Liczba przetworzonych rekordów. Obejmuje pomyślne i nieudane aktualizacje rekordów. |
deleteRecordsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
numberDeleted
|
numberDeleted | integer |
Liczba usuniętych rekordów. |
runQueryResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pola
|
fields | array of Fields2 |
Tablica obiektów, która zawiera ograniczone metadane każdego pola wyświetlanego w raporcie. Pomaga to w tworzeniu logiki, która zależy od typów pól i identyfikatorów. |
|
dane
|
data | array of object |
Tablica obiektów, które reprezentują dane rekordu lub podsumowane wartości, w zależności od typu raportu. |
|
items
|
data | object | |
|
Metadane1
|
metadata | Metadata1 |
Dodatkowe informacje o wynikach, które mogą być przydatne. Jeśli określisz mniejszą liczbę wyników do pominięcia niż jest dostępna, może być konieczne stronicowanie lub jeśli interfejs API automatycznie zwraca mniej wyników. LiczbaRekordów można porównać do wartości totalRecords, aby określić, czy jest potrzebna dalsza stronicowanie. |
Pola2
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator pola. |
|
etykieta
|
label | string |
Etykieta pola. |
|
typ
|
type | string |
Typ pola. |
getTempTokenDBIDResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
temporaryAuthorization
|
temporaryAuthorization | string |
Tymczasowy token autoryzacji. |
cloneUserTokenResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
aktywny
|
active | boolean |
Czy token użytkownika jest aktywny. |
|
apps
|
apps | array of App |
Lista aplikacji, do których jest przypisany ten token użytkownika. |
|
lastUsed
|
lastUsed | string |
Ostatnia data użycia tego tokenu użytkownika w formacie czasu ISO 8601 RRRR-MM-DDThh:mm:ss.sssZ (w strefie czasowej UTC). |
|
opis
|
description | string |
Opis tokenu użytkownika. |
|
id
|
id | integer |
Identyfikator tokenu użytkownika. |
|
nazwa
|
name | string |
Nazwa tokenu użytkownika. |
|
kod przedpłaty
|
token | string |
Wartość tokenu użytkownika. |
Aplikacja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator tej aplikacji. |
|
nazwa
|
name | string |
Nazwa aplikacji. |
deleteUserTokenResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator tokenu użytkownika. |
deleteFileResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
versionNumber
|
versionNumber | integer |
Liczba usuniętych wersji. |
|
fileName
|
fileName | string |
Nazwa pliku skojarzonego z usuniętą wersją. |
|
Przesłane
|
uploaded | string |
Sygnatura czasowa, kiedy wersja została pierwotnie przekazana. |
|
Kreator
|
creator | Creator |
Użytkownik, który przesłał wersję. |
Kreator
Użytkownik, który przesłał wersję.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Pełna nazwa użytkownika. |
|
id
|
id | string |
Identyfikator użytkownika. |
|
e-mail
|
string |
Adres e-mail użytkownika. |
|
|
userName
|
userName | string |
Nazwa użytkownika zaktualizowana we właściwościach użytkownika. Opcjonalnie jest wyświetlana, jeśli nie jest taka sama jak adres e-mail użytkownika. |
ciąg
Jest to podstawowy typ danych "string".