Naar de inhoud springen
Geverifieerd

Gegevens opvragen via de API

De volledige referentie van data_module, de filter- en sorteervormen van dbs_read, en wat dbs_delete en dbs_restore echt omzetten.

Zes methoden op data_module dekken een tabel van begin tot eind: dezelfde zes die het raster van een tabel aanroept, in Studio en op het tabblad Gegevens van het dashboard, en dezelfde die een draaiende app aanroept via xu.dbs_* (zie JavaScript Framework). Met een API-sleutel van een account zijn ze direct bereikbaar, zie App-gegevens opvragen en schrijven voor een uitgewerkt voorbeeld van dbs_read / dbs_create met request- en responsebodies. Deze pagina is de referentie voor de andere vier, en voor de filter-, sorteer- en archiefopties die dbs_read accepteert.

Methoden

Elk ervan neemt table_id, de eigen _id van de tabelnode, nooit de weergavenaam, en elke schrijfactie gaat door dezelfde veldtype-omzettingen die worden beschreven in Tabellen en velden.

Een rij bijwerken

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 wordt per veld-id samengevoegd met de bestaande gegevens van de rij: alleen de velden die je meestuurt veranderen, elk ander veld dat al op de rij staat blijft zoals het was. Stuur alleen de velden die je wilt wijzigen, je hoeft de rij niet eerst te lezen om de rest te behouden.

Rijen verwijderen en herstellen

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 zonder permanent verwijdert de rij niet, maar zet hem op gearchiveerd, dezelfde toestand die een rij krijgt als iemand hem vanuit het raster archiveert. Een gearchiveerde rij verschijnt niet meer in een gewone dbs_read, maar bestaat nog en telt nog mee in het gearchiveerde aantal van get_table_counts, en dbs_restore zet hem meteen terug. permanent: true slaat de archiveerstap over en verwijdert de rij definitief, wat dbs_restore niet kan terugdraaien.

Rij archiveren, niet tabel archiveren

Dit is de eigen status active/archived van een rij, ingesteld met dbs_delete en dbs_restore en teruggelezen met de vlag archived van dbs_read. Het staat los van het archiveren van een hele tabel als Studio-node, zoals beschreven in Tabellen en velden.

Rijen tellen

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.

Geeft het aantal actieve en gearchiveerde rijen van één tabel terug, dezelfde aantallen die dbs_read al als total_table_count aan zijn eigen respons toevoegt. Handig op zichzelf als je een aantal wilt zonder door rijen te bladeren om het te krijgen.

Een leesactie filteren

Het veld query van dbs_read is een object met veld-id's als sleutels, waarbij elke waarde een filtertype en een operator noemt:

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

Elk veld dat in query wordt genoemd, wordt met de andere gecombineerd met AND. Een enkel veld kan ook een eigen lijst conditions hebben met een operator OR of AND ertussen, voor "dit veld komt overeen met een van deze":

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

Sorteren en pagineren

sortModel is een lijst paren { colId, sort } (sort is asc of desc), toegepast in de opgegeven volgorde voor sorteren op meerdere kolommen. from en to zijn een rijbereik (from is de offset, to - from de paginagrootte), allebei optioneel. Laat je ze weg, dan krijg je de standaardpagina van de tabel.

Fouten die je moet kennen

Deze gelden voor alle zes methoden hierboven, niet alleen voor een schrijfactie: