Hopp til innholdet
Bekreftet

Spørring av data over API-et

Hele data_module-referansen, filter- og sorteringsformene til dbs_read, og hva dbs_delete og dbs_restore faktisk bytter.

Seks metoder i data_module dekker en tabell fra ende til ende: de samme seks som en tabells rutenett kaller, i Studio og i dashbordets Data-fane, og de samme som en kjørende app kaller gjennom xu.dbs_* (se JavaScript-rammeverk). Med en API-nøkkel for kontoen kan de nås direkte. Se Spør etter og skriv appdata for en gjennomgang av dbs_read / dbs_create med forespørsels- og svartekster. Denne siden er referansen for de fire andre, og for filter-, sorterings- og arkivalternativene dbs_read godtar.

Metoder

Alle tar table_id, tabellnodens egen _id, aldri visningsnavnet, og hver skriving går gjennom de samme felttypekonverteringene som beskrives under Tabeller og felt.

Å oppdatere 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 flettes inn i radens eksisterende data etter felt-id. Bare feltene du tar med, endres, alle andre felt som allerede ligger på raden, beholdes som de var. Send bare feltene du vil endre, du trenger ikke lese raden først for å bevare resten.

Å slette og gjenopprette 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 uten permanent fjerner ikke raden, den bytter den til arkivert, den samme tilstanden en rad får når noen arkiverer den fra rutenettet. En arkivert rad vises ikke lenger i en vanlig dbs_read, men finnes fortsatt og teller fortsatt med i arkivtallet til get_table_counts, og dbs_restore bytter den rett tilbake. permanent: true hopper over arkivtrinnet og sletter raden helt, noe dbs_restore ikke kan angre.

Radarkiv, ikke tabellarkiv

Dette er en rads egen active/archived-tilstand, satt med dbs_delete og dbs_restore og lest tilbake med archived-flagget til dbs_read. Det har ingenting å gjøre med at en hel tabell arkiveres som en Studio-node, noe som beskrives under Tabeller og felt.

Å telle 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.

Returnerer antall aktive og arkiverte rader for én tabell, de samme tallene dbs_read allerede legger ved svaret sitt som total_table_count, nyttig i seg selv når du vil ha et antall uten å bla gjennom rader for å få det.

Å filtrere en lesing

Feltet query i dbs_read er et objekt med felt-id som nøkkel, der hver verdi angir en filtertype og en operator:

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

Hvert felt som er nevnt i query, kombineres med de andre med AND. Et enkelt felt kan også ha sin egen liste med conditions med en OR- eller AND-operator mellom dem, for "dette feltet samsvarer med en av disse":

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

Sortering og sideinndeling

sortModel er en liste med { colId, sort }-par (sort er asc eller desc), brukt i den oppgitte rekkefølgen for sortering på flere kolonner. from og to er et radområde (from er forskyvningen, to - from er sidestørrelsen), begge valgfrie. Utelater du dem, får du tabellens standardside.

Feil det er verdt å kjenne til

Disse gjelder for alle seks metodene ovenfor, ikke bare en skriving: