Inhaltsverzeichnis

1.1 REST Endpoints

Overview of all available REST1) endpoints.

Architecture

The API follows REST principles2) and uses HTTP3) methods for CRUD operations.

Tables

Method Route Description
GET /tables List all tables
GET /tables/{name} Read data
POST /tables/{name} Insert record
PUT /tables/{name} Update record
DELETE /tables/{name} Delete record
PATCH /tables/{name} Batch changes

Views

Method Route Description
GET /views List all views
GET /views/{name} Read view data

Stored Procedures

Method Route Description
GET /procedures List all procedures
POST /procedures/{name}/execute Execute procedure

Ad-Hoc Queries

Method Route Description
POST /query Execute SQL query

HTTP Status Codes

The API uses standard HTTP Status Codes4):

Code Meaning Usage
200 OK Successful GET/PUT/PATCH
201 Created Successful POST
204 No Content Successful DELETE
400 Bad Request Invalid request
401 Unauthorized Authentication required
403 Forbidden No permission
404 Not Found Resource not found
500 Server Error Internal error

Further Reading

Sources

1)
Representational State Transfer: https://en.wikipedia.org/wiki/Representational_state_transfer
2)
REST Constraints: https://restfulapi.net/rest-architectural-constraints/
3)
Hypertext Transfer Protocol: https://datatracker.ietf.org/doc/html/rfc7231
4)
HTTP Status Codes: https://datatracker.ietf.org/doc/html/rfc7231#section-6