Gå til indhold
Bekræftet

Forespørgsler på data via API'et

Den fulde data_module-reference, dbs_reads filter- og sorteringsformer og hvad dbs_delete og dbs_restore faktisk skifter.

Seks metoder på data_module dækker en tabel fra ende til anden: de samme seks, som en tabels gitter kalder, i Studio og på dashboardets fane Data, og de samme, som en kørende app kalder via xu.dbs_* (se JavaScript Framework). Med en API-nøgle til kontoen kan de nås direkte. Se Forespørg og skriv appdata for en gennemgang af dbs_read / dbs_create med forespørgsels- og svartekster. Denne side er referencen for de øvrige fire og for de filter-, sorterings- og arkiveringsvalg, dbs_read accepterer.

Metoder

Hver af dem tager table_id, tabelnodens eget _id, aldrig dens visningsnavn, og hver skrivning går gennem de samme felttype-konverteringer, som er beskrevet i Tabeller og felter.

Opdatering af en række

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 ind i rækkens eksisterende data efter felt-id: kun de felter, du medtager, ændres, alle andre felter, der allerede er på rækken, forbliver, som de var. Send kun de felter, du vil ændre, du behøver ikke først læse rækken for at bevare resten.

Sletning og gendannelse af rækker

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 uden permanent fjerner ikke rækken, men skifter den til arkiveret, den samme tilstand, en række får, når nogen arkiverer den fra gitteret. En arkiveret række vises ikke længere i en almindelig dbs_read, men findes stadig og tæller stadig med i get_table_counts' arkiverede tal, og dbs_restore skifter den direkte tilbage. permanent: true springer arkiveringstrinnet over og sletter rækken helt, hvilket dbs_restore ikke kan fortryde.

Rækkearkivering, ikke tabelarkivering

Dette er en rækkes egen active/archived-tilstand, sat med dbs_delete og dbs_restore og læst tilbage med dbs_reads archived-flag. Den har intet at gøre med, at en hel tabel arkiveres som en Studio-node, beskrevet i Tabeller og felter.

Optælling af rækker

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 antallet af aktive og arkiverede rækker for én tabel, de samme tal, som dbs_read allerede vedhæfter sit eget svar som total_table_count, nyttigt for sig selv, når du vil have et antal uden at bladre gennem rækker for at få det.

Filtrering af en læsning

dbs_reads felt query er et objekt med felt-id som nøgle, hvor hver værdi angiver 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, der er nævnt i query, kombineres med de andre med AND. Et enkelt felt kan også have sin egen liste af conditions med en OR- eller AND-operator imellem, til "dette felt matcher en af disse":

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

Sortering og sideinddeling

sortModel er en liste af { colId, sort }-par (sort er asc eller desc), anvendt i den givne rækkefølge ved sortering på flere kolonner. from og to er et rækkeinterval (from er forskydningen, to - from er sidestørrelsen), begge valgfrie. Udelad dem, og du får tabellens standardside.

Fejl, det er værd at kende

Disse gælder for alle seks metoder ovenfor, ikke kun en skrivning: