Hoppa till innehållet
Verifierad

Fråga data via API:et

Hela data_module-referensen, filter- och sorteringsformerna i dbs_read, och vad dbs_delete och dbs_restore faktiskt växlar.

Sex metoder i data_module täcker en tabell från början till slut: samma sex som en tabells rutnät anropar, i Studio och på dashboardens Data tab, och samma som en körande app anropar via xu.dbs_* (se JavaScript Framework). Med en API-nyckel för kontot går de att nå direkt, se Query and write app data för en genomgång av dbs_read / dbs_create med förfrågnings- och svarskroppar. Den här sidan är referensen för de övriga fyra, och för de filter-, sorterings- och arkivalternativ som dbs_read accepterar.

Metoder

Varje metod tar table_id, tabellnodens egen _id, aldrig dess visningsnamn, och varje skrivning går genom samma fälttypskonverteringar som beskrivs i Tables and fields.

Uppdatera en rad

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 slås ihop med radens befintliga data per fält-id, bara de fält du tar med ändras och alla andra fält som redan finns på raden lämnas som de var. Skicka bara de fält du vill ändra, du behöver inte läsa raden först för att bevara resten.

Ta bort och återställa rader

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 utan permanent tar inte bort raden, utan växlar den till arkiverad, samma läge som en rad hamnar i när någon arkiverar den från rutnätet. En arkiverad rad slutar visas i en vanlig dbs_read, men finns kvar och räknas fortfarande in i get_table_counts arkiverade värde, och dbs_restore växlar tillbaka den direkt. permanent: true hoppar över arkivsteget och raderar raden helt, vilket dbs_restore inte kan ångra.

Radarkiv, inte tabellarkiv

Det här är en rads eget läge active/archived, som sätts med dbs_delete och dbs_restore och läses tillbaka med dbs_read och dess flagga archived. Det har inget att göra med att en hel tabell arkiveras som en Studio-nod, vilket beskrivs i Tables and fields.

Räkna rader

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.

Returnerar antalet aktiva och arkiverade rader för en tabell, samma siffror som dbs_read redan lägger till i sitt eget svar som total_table_count. Det är användbart för sig när du vill ha ett antal utan att bläddra igenom rader för att få fram det.

Filtrera en läsning

Fältet query i dbs_read är ett objekt med fält-id som nycklar, där varje värde anger en filtertyp och en operator:

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

Alla fält som nämns i query kombineras med de andra med AND. Ett enskilt fält kan också ha sin egen lista conditions med en operator av typen OR eller AND mellan dem, för "det här fältet matchar något av dessa":

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

Sortering och sidindelning

sortModel är en lista med { colId, sort }-par (sort är asc eller desc), tillämpade i den angivna ordningen för en sortering på flera kolumner. from och to är ett radintervall (from är förskjutningen, to - from är sidstorleken), båda valfria. Utelämnar du dem får du tabellens standardsida.

Fel värda att känna till

Dessa gäller för alla sex metoder ovan, inte bara en skrivning: