Přeskočit na obsah
Ověřeno

Dotazování na data přes API

Úplný popis data_module, tvary filtrů a řazení v dbs_read a co ve skutečnosti přepínají dbs_delete a dbs_restore.

Šest metod data_module pokrývá tabulku od začátku do konce: stejných šest volá mřížka tabulky ve Studiu i na kartě Data v dashboardu a stejné volá běžící aplikace přes xu.dbs_* (viz Framework JavaScript). S klíčem API účtu jsou dostupné přímo, probraný příklad dbs_read / dbs_create s těly požadavků a odpovědí najdete v části Dotazování na data aplikace a zápis do nich. Tato stránka je popisem ostatních čtyř metod a voleb filtru, řazení a archivace, které dbs_read přijímá.

Metody

Každá z nich bere table_id, vlastní _id uzlu tabulky, nikdy ne její zobrazovaný název, a každý zápis prochází stejným přetypováním podle typu pole, jaké popisuje část Tabulky a pole.

Aktualizace řádku

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 se do stávajících dat řádku slučuje podle id pole, mění se jen pole, která uvedete, každé další pole, které už na řádku je, zůstane, jak bylo. Pošlete jen pole, která chcete změnit, řádek není potřeba nejdřív číst, aby se zbytek zachoval.

Mazání a obnovování řádků

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 řádek neodstraní, přepne ho do stavu archivováno, stejného, v jakém skončí řádek, který někdo archivuje z mřížky. Archivovaný řádek se přestane zobrazovat v běžném dbs_read, ale stále existuje a stále se počítá do archivovaného údaje v get_table_counts, a dbs_restore ho přepne rovnou zpět. permanent: true krok archivace přeskočí a řádek smaže úplně, což dbs_restore vrátit nedokáže.

Archivace řádku, ne tabulky

Jde o vlastní stav active/archived řádku, nastavovaný pomocí dbs_delete a dbs_restore a čtený zpět příznakem archived v dbs_read. Nesouvisí s archivací celé tabulky jako uzlu Studia, o které se píše v části Tabulky a pole.

Počítání řádků

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.

Vrací počty aktivních a archivovaných řádků jedné tabulky, stejné údaje, které dbs_read už přikládá k vlastní odpovědi jako total_table_count, užitečné samostatně, když chcete počet bez procházení řádků po stránkách.

Filtrování čtení

Pole query v dbs_read je objekt s klíči podle id pole, kde každá hodnota uvádí typ filtru a operátor:

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

Všechna pole uvedená v query se navzájem spojují pomocí AND. Jedno pole může také nést vlastní seznam conditions s operator OR nebo AND mezi nimi, pro případ "toto pole odpovídá jedné z těchto hodnot":

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

Řazení a stránkování

sortModel je seznam dvojic { colId, sort } (sort je asc nebo desc), použitých v zadaném pořadí pro řazení podle více sloupců. from a to jsou rozsah řádků (from je posun, to - from velikost stránky), obojí nepovinné. Vynecháte-li je, dostanete výchozí stránku tabulky.

Chyby, které stojí za znalost

Platí pro všech šest uvedených metod, ne jen pro zápis: