1.1 REST Endpunkte
Übersicht aller verfügbaren REST1)-Endpunkte.
Architektur
Die API folgt REST-Prinzipien2) und verwendet HTTP3) Methoden für CRUD-Operationen.
Tabellen
| Methode | Route | Beschreibung |
| GET | /tables | Liste aller Tabellen |
| GET | /tables/{name} | Daten lesen |
| POST | /tables/{name} | Datensatz einfügen |
| PUT | /tables/{name} | Datensatz aktualisieren |
| DELETE | /tables/{name} | Datensatz löschen |
| PATCH | /tables/{name} | Batch-Änderungen |
Views
| Methode | Route | Beschreibung |
| GET | /views | Liste aller Views |
| GET | /views/{name} | View-Daten lesen |
Stored Procedures
| Methode | Route | Beschreibung |
| GET | /procedures | Liste aller Prozeduren |
| POST | /procedures/{name}/execute | Prozedur ausführen |
Ad-Hoc Queries
| Methode | Route | Beschreibung |
| POST | /query | SQL-Query ausführen |
HTTP Status Codes
Die API verwendet Standard HTTP Status Codes4):
| Code | Bedeutung | Verwendung |
| 200 | OK | Erfolgreiche GET/PUT/PATCH |
| 201 | Created | Erfolgreicher POST |
| 204 | No Content | Erfolgreicher DELETE |
| 400 | Bad Request | Ungültige Anfrage |
| 401 | Unauthorized | Authentifizierung erforderlich |
| 403 | Forbidden | Keine Berechtigung |
| 404 | Not Found | Ressource nicht gefunden |
| 500 | Server Error | Interner Fehler |
Weiterführend
Quellen