Siirry sisältöön
Tarkistettu

Datan kysely API:n kautta

Täysi data_module-viite, dbs_read-kutsun suodatin- ja lajittelumuodot sekä mitä dbs_delete ja dbs_restore oikeasti vaihtavat.

Kuusi data_module-metodia kattaa taulun päästä päähän: samat kuusi, joita taulun ruudukko kutsuu Studiossa ja dashboardin Data-välilehdellä, ja samat, joita käynnissä oleva sovellus kutsuu xu.dbs_*-kutsujen kautta (katso JavaScript-kehys). Tilin API-avaimella ne ovat suoraan käytettävissä. Katso työstetty dbs_read- ja dbs_create-läpikäynti pyyntö- ja vastausrunkoineen sivulta Kysy ja kirjoita sovelluksen dataa. Tämä sivu on viite muille neljälle sekä suodatin-, lajittelu- ja arkistointivaihtoehdoille, jotka dbs_read hyväksyy.

Metodit

Jokainen niistä ottaa parametrin table_id, taulusolmun oman _id:n, ei koskaan sen näyttönimeä, ja jokainen kirjoitus kulkee samojen kenttätyyppimuunnosten kautta, jotka on kuvattu sivulla Taulut ja kentät.

Rivin päivittäminen

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 yhdistetään rivin olemassa olevaan dataan kenttätunnuksen mukaan: vain mukaan ottamasi kentät muuttuvat, kaikki muut rivillä jo olevat kentät jäävät ennalleen. Lähetä vain ne kentät, jotka haluat muuttaa. Riviä ei tarvitse lukea ensin muun säilyttämiseksi.

Rivien poistaminen ja palauttaminen

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 ilman permanent-parametria ei poista riviä, vaan muuttaa sen arkistoiduksi, samaan tilaan, johon rivi päätyy, kun joku arkistoi sen ruudukosta. Arkistoitu rivi ei näy tavallisessa dbs_read-kutsussa, mutta on yhä olemassa ja lasketaan edelleen get_table_counts-kutsun arkistoituun lukuun, ja dbs_restore palauttaa sen heti takaisin. permanent: true ohittaa arkistointivaiheen ja poistaa rivin kokonaan, mitä dbs_restore ei voi kumota.

Rivin arkistointi, ei taulun arkistointi

Tämä on rivin oma active/archived-tila, joka asetetaan dbs_delete- ja dbs_restore-kutsuilla ja luetaan takaisin dbs_read-kutsun archived-lipulla. Se ei liity siihen, että koko taulu arkistoidaan Studio-solmuna, mikä on kuvattu sivulla Taulut ja kentät.

Rivien laskeminen

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.

Palauttaa yhden taulun aktiivisten ja arkistoitujen rivien määrät, samat luvut, jotka dbs_read jo liittää omaan vastaukseensa nimellä total_table_count. Hyödyllinen sellaisenaan, kun haluat laskennan selaamatta rivejä läpi sen saamiseksi.

Luvun suodattaminen

dbs_read-kutsun query-kenttä on kenttätunnuksella avainnettu objekti, jonka jokainen arvo nimeää suodatintyypin ja operaattorin:

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

Jokainen query-kentässä mainittu kenttä yhdistetään muihin AND-operaattorilla. Yksittäisellä kentällä voi myös olla oma conditions-luettelonsa, jonka ehtojen välillä on OR- tai AND-operator, tilanteeseen "tämä kenttä vastaa jompaakumpaa näistä":

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

Lajittelu ja sivutus

sortModel on luettelo { colId, sort }-pareista (sort on asc tai desc), jotka sovelletaan annetussa järjestyksessä usean sarakkeen lajittelussa. from ja to ovat rivialue (from on siirtymä, to - from sivun koko), molemmat valinnaisia. Jos jätät ne pois, saat taulun oletussivun.

Tiedettäviä virheitä

Nämä koskevat kaikkia kuutta yllä olevaa metodia, ei vain kirjoitusta: