Zum Inhalt springen
Geprüft

Daten über die API abfragen

Die vollständige data_module-Referenz, die Filter- und Sortierformen von dbs_read und was dbs_delete und dbs_restore tatsächlich umschalten.

Sechs Methoden auf data_module decken eine Tabelle von Anfang bis Ende ab: dieselben sechs, die das Raster einer Tabelle aufruft, in Studio und im Tab Daten des Dashboards, und dieselben, die eine laufende App über xu.dbs_* aufruft (siehe JavaScript Framework). Mit einem API-Schlüssel des Kontos sind sie direkt erreichbar, siehe App-Daten abfragen und schreiben für eine durchgespielte Anleitung zu dbs_read / dbs_create mit Request- und Response-Bodys. Diese Seite ist die Referenz für die anderen vier und für die Filter-, Sortier- und Archivoptionen, die dbs_read akzeptiert.

Methoden

Jede davon nimmt table_id, die eigene _id des Tabellenknotens, nie seinen Anzeigenamen, und jeder Schreibvorgang durchläuft dieselben Feldtyp-Umwandlungen, die unter Tabellen und Felder beschrieben sind.

Eine Zeile aktualisieren

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 wird nach Feld-ID in die bestehenden Daten der Zeile gemergt, nur die Felder, die du angibst, werden geändert, jedes andere Feld, das schon in der Zeile ist, bleibt, wie es war. Sende nur die Felder, die du ändern willst, du musst die Zeile nicht erst lesen, um den Rest zu erhalten.

Zeilen löschen und wiederherstellen

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 ohne permanent entfernt die Zeile nicht, es schaltet sie auf archiviert, denselben Zustand, in den eine Zeile gerät, wenn jemand sie im Raster archiviert. Eine archivierte Zeile erscheint in einem normalen dbs_read nicht mehr, existiert aber weiterhin und zählt weiterhin zur archivierten Zahl von get_table_counts, und dbs_restore schaltet sie sofort zurück. permanent: true überspringt den Archivierungsschritt und löscht die Zeile endgültig, was dbs_restore nicht rückgängig machen kann.

Zeilen-Archiv, nicht Tabellen-Archiv

Das ist der eigene Zustand active/archived einer Zeile, gesetzt mit dbs_delete und dbs_restore und zurückgelesen mit dem archived-Flag von dbs_read. Er hat nichts damit zu tun, dass eine ganze Tabelle als Studio-Knoten archiviert wird, was unter Tabellen und Felder behandelt wird.

Zeilen zählen

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.

Gibt die Zahl aktiver und archivierter Zeilen für eine Tabelle zurück, dieselben Zahlen, die dbs_read seiner eigenen Antwort bereits als total_table_count anhängt, nützlich für sich allein, wenn du eine Zahl willst, ohne dich durch Zeilen zu blättern, um sie zu bekommen.

Ein Lesen filtern

Das Feld query von dbs_read ist ein Objekt, nach Feld-ID geschlüsselt, wobei jeder Wert einen Filtertyp und einen Operator nennt:

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

Jedes in query genannte Feld wird mit den anderen per AND verknüpft. Ein einzelnes Feld kann auch eine eigene Liste von conditions mit einem OR- oder AND-operator dazwischen tragen, für "dieses Feld passt auf eines von diesen":

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

Sortieren und Seiten

sortModel ist eine Liste von { colId, sort }-Paaren (sort ist asc oder desc), bei einer Sortierung nach mehreren Spalten in der angegebenen Reihenfolge angewendet. from und to sind ein Zeilenbereich (from der Offset, to - from die Seitengröße), beide optional; lässt du sie weg, bekommst du die Standardseite der Tabelle.

Fehler, die du kennen solltest

Diese gelten für alle sechs obigen Methoden, nicht nur für einen Schreibvorgang: