Workspaces
Workspaces are the top-level organizational structure for folders and files. Workspaces are also a root_folder
whose contents can be examined via the Folders endpoint.
Create a Workspace
POST
https://ws-api.onehub.com/workspaces
Creates a new Workspace owned by the user.
Request Body
workspace[name]
string
The name of the Workspace.
workspace[background_color]
string
A CSS hex color value that determines the background color for the Workspace.
workspace[data_room]
boolean
Activates Data Room mode for the Workspace. Defaults to false
. Availability of this feature is plan dependent.
workspace[default_view]
string
Determines whether first time visitors should see folders and files displayed as horizontal rows
or as a grid of large thumbnails
. Defaults to rows
.
{
"workspace": {
"id": 4137,
"name": "Testing the API",
"background_color": "#58b28d",
"updated_at": "2016-01-25T16:39:34-08:00",
"data_room": false,
"default_view": "rows",
"default_sort": "alphabetical",
"root_folder_id": 849927,
"owner_id": 481,
"audit_trail": true,
"is_owner": true,
"require_agreement": false,
"agreement_accepted": false,
"effective_role": "Administrator",
"errors": {}
}
}
Read a Workspace
GET
https://ws-api.onehub.com/workspaces/:id
Retrieve the Workspace specified via :id
.
Path Parameters
:id
integer
The unique identifier of the Workspace you would like to retrieve.
{
"workspace": {
"id": 4137,
"name": "Testing the API",
"background_color": "#58b28d",
"updated_at": "2016-01-25T16:39:34-08:00",
"data_room": false,
"default_view": "rows",
"default_sort": "alphabetical",
"root_folder_id": 849927,
"owner_id": 481,
"audit_trail": true,
"is_owner": true,
"require_agreement": false,
"agreement_accepted": false,
"effective_role": "Administrator",
"errors": {}
}
}
Update a Workspace
PUT
https://ws-api.onehub.com/workspaces/:id
Updates the Workspace specified via :id
.
Path Parameters
:id
integer
The unique identifier of the Workspace you would like to update.
Request Body
workspace[name]
string
The name of the Workspace.
workspace[background_color]
string
A CSS hex color value that determines the background color for the Workspace.
workspace[data_room]
boolean
Activates Data Room mode for the Workspace. Defaults to false
. Availability of this feature is plan dependent.
workspace[default_view]
string
Determines whether first time visitors should see folders and files displayed as horizontal rows
or as a grid of large thumbnails
. Defaults to rows
.
{
"workspace": {
"id": 4137,
"name": "Testing the API",
"background_color": "#58b28d",
"updated_at": "2016-01-25T16:39:34-08:00",
"data_room": false,
"default_view": "thumbnails",
"default_sort": "alphabetical",
"root_folder_id": 849927,
"owner_id": 481,
"audit_trail": true,
"is_owner": true,
"require_agreement": false,
"agreement_accepted": false,
"effective_role": "Administrator",
"errors": {}
}
}
Delete a Workspace
DELETE
https://ws-api.onehub.com/workspaces/:id
Delete the Workspace specified via :id
.
Path Parameters
:id
integer
The unique identifier of the Workspace you would like to delete.
//
List all Workspaces
GET
https://ws-api.onehub.com/workspaces
List all Workspaces that the user has been invited to.
{
"current_page": 1,
"total_entries": 1,
"total_pages": 1,
"offset": 0,
"previous_offset": null,
"next_offset": null,
"per_page": 30,
"items": [
{
"workspace": {
"id": 4137,
"name": "Testing the API",
"background_color": "#58b28d",
"updated_at": "2016-01-25T16:54:00-08:00",
"data_room": false,
"default_view": "thumbnails",
"default_sort": "alphabetical",
"root_folder_id": 849587,
"owner_id": 481,
"audit_trail": true,
"is_owner": true,
"require_agreement": false,
"agreement_accepted": false,
"effective_role": "Administrator",
"errors": {}
}
}
]
}
Last updated
Was this helpful?