Folders
Folders are the organization structure for files in Workspaces. You can create, update, download, and delete folders. You can also list all items in a folder.
Workspaces contain a special folder which is referred to as the root folder, which you can read. This folder contains all items found in the root of a Workspace.
Create a Folder
POST
https://ws-api.onehub.com/workspaces/:workspace_id/folders/:folder_id/folders
Creates a folder nested within the folder specified via :folder_id
in the Workspace specified via :workspace_id
. To create a folder at the root-level of the Workspace you can either pass the root_folder_id
or post to the /folders
endpoint without specifying a :folder_id
.
Path Parameters
Name | Type | Description |
---|---|---|
:workspace_id | integer | The unique identifier of the Workspace you would like to create the folder in. |
:folder_id | integer | The unique identifier of the folder you would like to nest the folder within. If a |
Request Body
Name | Type | Description |
---|---|---|
filename | string | The name of the folder. |
If a folder name contains characters that would render it invalid, the name will be automatically changed to one that is valid. For example folder/name
would be changed to folder-name
.
Read a Root Folder
GET
https://ws-api.onehub.com/workspaces/:id/folders
Reads the root folder for the Workspace specified via :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the Workspace you would like to read the root folder from. |
List Folder Contents
GET
https://ws-api.onehub.com/folders/:id
Lists all folders/files in the folder specified via :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the folder you would like to list nested folders from. |
Query Parameters
Name | Type | Description |
---|---|---|
query | string | A portion of the folder name, filename, or extension you would like to scope your results to. Can be any concurrent string of supported characters. |
sort | string | The criteria you would like to sort the response by. Case sensitive. Can either be |
Download a Folder
GET
https://ws-api.onehub.com/folders/:id/archive
Downloads a zip archive of the folder specified by :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the folder you would like to download. |
Rename a Folder
PUT
https://ws-api.onehub.com/folders/:id
Renames the folder object specified via :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the folder you would like to update. |
Request Body
Name | Type | Description |
---|---|---|
filename | string | The new name for the folder. |
Delete a Folder
DELETE
https://ws-api.onehub.com/folders/:id
Deletes the folder object specified via :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the folder you would like to delete. |
Last updated