Retrieve database schema

GET /api/v1/schema/user/{[1-n]|HEAD|CURRENT}?token=<token>[&format=<format>]

Retrieve the user database schema for a specific version. When easydb is first started, this call will return 404 Not found for any version. The first user update will be the version 1. CURRENT points to the database version currently used and HEAD points to the version currently updated (but not yet commited).

Path parameters

Query String

Available formats:

• xml: database schema as XML document (this is the default format)
• json: database schema as JSON object
• svg: graphical representation of the database schema as SVG
• png: graphical representation of the database schema as PNG

Output

If the format is xmlor json, this call returns a schema. If the format is svg or png, this call returns a file.

Permissions

This call requires an authenticated session. Frontends can use the “system.datamodel.current” right to decide if they show the schema to the user.

HTTP status codes

Update database schema

POST /api/v1/schema/user/HEAD?token=<token>

Update the HEAD version of the user database schema.

Query String

Input

New schema as JSON.

Output

The new schema. Notice that several changes will be present in the output, such as auto-generated IDs.

Permissions

The user needs the “system.datamodel.development” right.

HTTP status codes

Commit database schema

POST /api/v1/schema/commit?token=<token>

Commit the HEAD schema version and make it the current version. This call changes the database according to the new schema. It adds, changes and drops tables, columns.

Query String

Permissions

The user needs the “system.datamodel.commit” right.

HTTP status codes