Vai al contenuto
Verificata

Interrogare i dati tramite API

Il riferimento completo di data_module, le forme di filtro e ordinamento di dbs_read e cosa cambiano davvero dbs_delete e dbs_restore.

Sei metodi di data_module coprono una tabella da un capo all'altro: gli stessi sei che chiama la griglia di una tabella, in Studio e nella scheda Dati della dashboard, e gli stessi che un'app in esecuzione chiama tramite xu.dbs_* (vedi JavaScript Framework). Con una chiave API dell'account sono raggiungibili direttamente, vedi Interrogare e scrivere i dati di un'app per una guida pratica a dbs_read / dbs_create con corpi di richiesta e risposta. Questa pagina è il riferimento per gli altri quattro e per le opzioni di filtro, ordinamento e archiviazione che dbs_read accetta.

Metodi

Ognuno di essi accetta table_id, l'_id del nodo tabella, mai il suo nome visualizzato, e ogni scrittura passa attraverso le stesse conversioni dei tipi di campo descritte in Tabelle e campi.

Aggiornare una riga

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 viene unito ai dati esistenti della riga per id di campo, vengono modificati solo i campi che includi, ogni altro campo già presente nella riga resta com'era. Invia solo i campi che intendi cambiare, non serve leggere prima la riga per conservare il resto.

Eliminare e ripristinare righe

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 senza permanent non rimuove la riga, la porta allo stato archiviato, lo stesso stato in cui finisce una riga quando qualcuno la archivia dalla griglia. Una riga archiviata smette di comparire in un normale dbs_read, ma esiste ancora e conta ancora nella cifra degli archiviati di get_table_counts, e dbs_restore la riporta subito indietro. permanent: true salta il passaggio di archiviazione ed elimina la riga definitivamente, cosa che dbs_restore non può annullare.

Archiviazione di riga, non di tabella

Questo è lo stato active/archived di una singola riga, impostato con dbs_delete e dbs_restore e riletto con il flag archived di dbs_read. Non ha alcun legame con l'archiviazione di un'intera tabella come nodo di Studio, trattata in Tabelle e campi.

Contare le righe

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.

Restituisce il numero di righe attive e archiviate di una tabella, le stesse cifre che dbs_read allega già alla propria risposta come total_table_count, utile da solo quando vuoi un conteggio senza scorrere le righe per ottenerlo.

Filtrare una lettura

Il campo query di dbs_read è un oggetto con chiave l'id del campo, ogni valore indica un tipo di filtro e un operatore:

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

Ogni campo indicato in query viene combinato con gli altri con AND. Un singolo campo può anche avere un proprio elenco di conditions con un operator OR o AND tra di esse, per "questo campo corrisponde a uno di questi":

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

Ordinare e paginare

sortModel è un elenco di coppie { colId, sort } (sort è asc o desc), applicate nell'ordine indicato per un ordinamento su più colonne. from e to sono un intervallo di righe (from l'offset, to - from la dimensione della pagina), entrambi facoltativi; se li ometti ottieni la pagina predefinita della tabella.

Errori da conoscere

Valgono per tutti e sei i metodi qui sopra, non solo per una scrittura: