Preskočiť na obsah
Overené

Dopytovanie dát cez API

Úplná referencia data_module, tvary filtra a triedenia v dbs_read a čo vlastne dbs_delete a dbs_restore prepínajú.

Šesť metód v data_module pokrýva tabuľku od začiatku do konca: tých istých šesť volá mriežka tabuľky v Studiu aj na karte Dáta v dashboarde a tie isté volá bežiaca aplikácia cez xu.dbs_* (pozri JavaScript Framework). S API kľúčom účtu sú dosiahnuteľné priamo, pozrite si Query and write app data pre vypracovaný postup dbs_read / dbs_create s telami požiadaviek a odpovedí. Táto stránka je referenciou pre ostatné štyri a pre možnosti filtra, triedenia a archivácie, ktoré dbs_read prijíma.

Metódy

Každá z nich prijíma table_id, vlastné _id uzla tabuľky, nikdy nie jej zobrazovaný názov, a každý zápis prechádza tým istým pretypovaním podľa typu poľa, aké je popísané v časti Tabuľky a polia.

Aktualizácia riadka

POST/cpi/dbs_update
admin

DBS Update

Replaces the data of an existing record, identified by row_id, in the specified app table.

table_data sa zlúči do existujúcich dát riadka podľa id poľa, zmenia sa len polia, ktoré uvediete, všetky ostatné polia, ktoré už riadok má, zostanú také, aké boli. Pošlite len polia, ktoré chcete zmeniť, riadok nie je potrebné najprv čítať, aby sa zvyšok zachoval.

Mazanie a obnovovanie riadkov

POST/cpi/dbs_delete
admin

DBS Delete

Soft-deletes (or permanently deletes when 'permanent' is set) the listed record IDs from an app table.

POST/cpi/dbs_restore
admin

DBS Restore

Restores previously soft-deleted records, identified by their IDs, in the specified app table.

dbs_delete bez permanent riadok neodstráni, prepne ho na archivovaný, rovnaký stav, aký riadok dostane, keď ho niekto archivuje z mriežky. Archivovaný riadok sa v bežnom dbs_read prestane zobrazovať, ale stále existuje a stále sa započítava do archivovaného údaju get_table_counts a dbs_restore ho vráti priamo späť. permanent: true krok archivácie preskočí a riadok odstráni úplne, čo dbs_restore nedokáže vrátiť.

Archivácia riadka, nie tabuľky

Toto je vlastný stav riadka active/archived, nastavený cez dbs_delete a dbs_restore a čítaný späť cez príznak archived v dbs_read. S archiváciou celej tabuľky ako uzla Studia, ktorú popisuje časť Tabuľky a polia, nemá nič spoločné.

Počítanie riadkov

POST/cpi/get_table_counts
admin

Get Table Counts

Returns the number of records in a table: active records, or archived records when archived is true.

Vráti počty aktívnych a archivovaných riadkov jednej tabuľky, rovnaké údaje, ktoré dbs_read už pripája k vlastnej odpovedi ako total_table_count, užitočné samostatne, keď chcete počet bez listovania riadkami.

Filtrovanie čítania

Pole query v dbs_read je objekt s kľúčmi podľa id poľa, kde každá hodnota uvádza typ filtra a operátor:

json
{
  "query": {
    "STU_Campus": { "filterType": "text", "type": "equals", "filter": "Downtown" },
    "STU_Age": { "filterType": "number", "type": "greaterThanOrEqual", "filter": 18 }
  }
}

Každé pole uvedené v query sa s ostatnými spája operátorom AND. Jedno pole môže niesť aj vlastný zoznam conditions s operátorom OR alebo AND medzi nimi, pre "toto pole zodpovedá jednej z týchto hodnôt":

json
{
  "query": {
    "STU_Campus": {
      "operator": "OR",
      "conditions": [
        { "filterType": "text", "type": "equals", "filter": "Downtown" },
        { "filterType": "text", "type": "equals", "filter": "Uptown" }
      ]
    }
  }
}

Triedenie a stránkovanie

sortModel je zoznam dvojíc { colId, sort } (sort je asc alebo desc), použitých v zadanom poradí pri triedení podľa viacerých stĺpcov. from a to sú rozsah riadkov (from je posun, to - from veľkosť stránky), oba voliteľné. Ak ich vynecháte, dostanete predvolenú stránku tabuľky.

Chyby, ktoré stojí za to poznať

Platia pre všetkých šesť metód vyššie, nielen pre zápis: