The workbench is almost totally surfaced by a REST API. This API is documented
using Swagger. The API documentation is available at
/api-docs on the server.
We also include supplemental documentation here.
This documentation was historically located in the baw-server Wiki. It will remain there for some time, until the migration to this repository is compelted.
The server is designed to allow public access to data that is marked to be public. Most actions a user can take are categorized into a few classes:
- reading of public data with requires no authentication
- writing data for things your create or own requires an authenticated session
- reading of some important public data requires an authenticated session
- reading or writing private data requires an authenticated and authorized session
If authentication is required the API will return a 401 Unauthorized response.
If authorization is required the API will return a 403 Not Authorized response.