Workspaces¶
A workspace is a grouping of data stores. Similar to a namespace, it is used to group data that is related in some way.
/workspaces[.<format>]¶
Controls all workspaces.
Method | Action | Status code | Formats | Default Format |
---|---|---|---|---|
GET | List all workspaces | 200 | HTML, XML, JSON | HTML |
POST | Create a new workspace | 201 with Location header | XML, JSON | |
PUT | 405 | |||
DELETE | 405 |
/workspaces/<ws>[.<format>]¶
Controls a specific workspace.
Method | Action | Status code | Formats | Default Format | Parameters |
---|---|---|---|---|---|
GET | Return workspace ws | 200 | HTML, XML, JSON | HTML | |
POST | 405 | ||||
PUT | 200 | Modify workspace ws | XML, JSON | ||
DELETE | 200 | Delete workspace ws | XML, JSON | recurse |
Exceptions¶
Exception | Status code |
---|---|
GET for a workspace that does not exist | 404 |
PUT that changes name of workspace | 403 |
DELETE against a workspace that is non-empty | 403 |
/workspaces/default[.<format>]¶
Controls the default workspace.
Method | Action | Status code | Formats | Default Format |
---|---|---|---|---|
GET | Returns default workspace | 200 | HTML, XML, JSON | HTML |
POST | 405 | |||
PUT | 200 | Set default workspace | XML, JSON | |
DELETE | 405 |
/workspaces/<ws>/settings[.<format>]¶
Controls settings on a specific workspace.
Method | Action | Status code | Formats | Default Format |
---|---|---|---|---|
GET | Returns workspace settings | 200 | HTML, XML, JSON | HTML |
POST | 405 | |||
PUT | Creates or updates workspace settings | 200 | XML, JSON | |
DELETE | Deletes workspace settings | 200 | XML, JSON |