- Home
- Resources
- FolderResource
GET /folders
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
id |
query |
|
|
long |
POST /folders/legacy_query
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
GET /folders/operations
Returns a list of all access-control related operations that can be performed on a folder.
GET /folders/operations/{name}
Request Parameters
name |
type |
description |
name |
path |
|
Response Body
media type |
data type |
application/json |
Operation
(JSON) |
application/xml |
operation
(XML) |
GET /folders/operations/{name}/permissions
Tests whether the authenticated user has permission to perform the specified operation on one or more folders.
Request Parameters
name |
type |
description |
constraints |
name |
path |
The name of the operation |
|
folder |
query |
One or more folder IDs to test. |
long |
GET /folders/{id}/binders
Gets a list of child binders contained in the specified binder.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The id of the parent binder |
|
long |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
title |
query |
|
|
|
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
Returns a list of BinderBrief objects. |
application/xml |
anyType
(XML) |
GET /folders/{id}/children
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
allow_jits |
query |
|
true |
boolean |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
title |
query |
|
|
|
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /folders/{id}
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
title |
query |
|
|
|
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
POST /folders/{id}
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
template |
query |
|
|
long |
Request Body
media type |
data type |
application/json |
Binder
(JSON) |
application/xml |
binder
(XML) |
Response Body
media type |
data type |
application/json |
Binder
(JSON) |
application/xml |
binder
(XML) |
GET /folders/{id}/entries
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
file_name |
query |
|
|
|
first |
query |
|
|
int |
parent_binder_paths |
query |
|
false |
boolean |
POST /folders/{id}/entries
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
file_entry |
query |
|
false |
boolean |
GET /folders/{id}/library_entities
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
binders |
query |
|
true |
boolean |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
files |
query |
|
true |
boolean |
first |
query |
|
0 |
int |
folder_entries |
query |
|
true |
boolean |
keyword |
query |
|
|
|
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
replies |
query |
|
true |
boolean |
POST /folders/{id}/library_files
Request Parameters
name |
type |
description |
constraints |
file_name |
form |
|
|
source_id |
form |
|
|
id |
path |
|
long |
POST /folders/{id}/library_files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
file_name |
query |
|
|
|
md5 |
query |
|
|
|
mod_date |
query |
|
|
|
overwrite_existing |
query |
|
false |
boolean |
POST /folders/{id}/library_files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
file_name |
query |
|
|
|
md5 |
query |
|
|
|
mod_date |
query |
|
|
|
overwrite_existing |
query |
|
false |
boolean |
GET /folders/{id}
Returns the binder with the specified ID.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the binder to return. |
|
long |
description_format |
query |
|
text |
|
include_attachments |
query |
Configures whether attachments should be included in the returned binder object. |
true |
boolean |
library_info |
query |
|
false |
boolean |
Response Body
media type |
data type |
description |
application/json |
Binder
(JSON) |
Returns a subclass of Binder. |
application/xml |
binder
(XML) |
PUT /folders/{id}
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
include_attachments |
query |
|
true |
boolean |
Request Body
media type |
data type |
application/json |
Binder
(JSON) |
application/xml |
binder
(XML) |
Response Body
media type |
data type |
application/json |
Binder
(JSON) |
application/xml |
binder
(XML) |
DELETE /folders/{id}
Deletes the specifed binder object. The binder is moved into the Trash, not permanently deleted.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the binder to delete. |
|
long |
only_if_empty |
query |
|
false |
boolean |
purge |
query |
|
false |
boolean |
GET /folders/{id}/access
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Body
media type |
data type |
application/json |
Access
(JSON) |
application/xml |
access
(XML) |
POST /folders/{id}/title
Request Parameters
name |
type |
description |
default |
constraints |
title |
form |
|
|
|
id |
path |
|
|
long |
description_format |
query |
|
text |
|
include_attachments |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
Binder
(JSON) |
application/xml |
binder
(XML) |
POST /folders/{id}/parent_binder
Request Parameters
name |
type |
description |
default |
constraints |
binder_id |
form |
|
|
long |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
include_attachments |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
Binder
(JSON) |
application/xml |
binder
(XML) |
POST /folders/{id}/binders
Creates a new binder as a child of the specified binder.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The id of the binder where the new binder will be created. |
|
long |
description_format |
query |
|
text |
|
template |
query |
Optional template ID defining the type of binder to create. If no template is specified, the
new parent binder is used to determine the type of binder to create. |
|
long |
Request Body
media type |
data type |
description |
application/json |
Binder
(JSON) |
An object containing the information about the binder to be created. Requires the title
property to be set. All other binder properties are ignored. |
application/xml |
binder
(XML) |
Response Body
media type |
data type |
description |
application/json |
Binder
(JSON) |
Returns a Binder object representing the newly created binder. |
application/xml |
binder
(XML) |
GET /folders/{id}/binder_tree
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
Response Body
media type |
data type |
application/json |
BinderTree
(JSON) |
application/xml |
binderTree
(XML) |
GET /folders/{id}/library_tree
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
Response Body
media type |
data type |
application/json |
BinderTree
(JSON) |
application/xml |
binderTree
(XML) |
GET /folders/{id}/library_changes
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
500 |
int |
description_format |
query |
|
text |
|
recursive |
query |
|
true |
boolean |
since |
query |
|
|
|
GET /folders/{id}/library_children
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
allow_jits |
query |
|
true |
boolean |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
title |
query |
|
|
|
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /folders/{id}/library_folders
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
title |
query |
|
|
|
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
POST /folders/{id}/library_folders
Request Parameters
name |
type |
description |
default |
constraints |
source_id |
form |
|
|
long |
title |
form |
|
|
|
id |
path |
|
|
long |
description_format |
query |
|
text |
|
Response Body
media type |
data type |
application/json |
Folder
(JSON) |
application/xml |
folder
(XML) |
POST /folders/{id}/library_folders
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
Response Body
media type |
data type |
application/json |
Folder
(JSON) |
application/xml |
folder
(XML) |
GET /folders/{id}/library_files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
|
int |
file_name |
query |
|
|
|
first |
query |
|
|
int |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /folders/{id}/files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
100 |
int |
file_name |
query |
|
|
|
first |
query |
|
|
int |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /folders/{id}/library_info
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
GET /folders/{id}/recent_activity
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
20 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
parent_binder_paths |
query |
|
false |
boolean |
GET /folders/{id}/shares
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
POST /folders/{id}/shares
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
notify |
query |
|
false |
boolean |
Request Body
media type |
data type |
application/json |
Share
(JSON) |
application/xml |
share
(XML) |
Response Body
media type |
data type |
application/json |
Share
(JSON) |
application/xml |
share
(XML) |
GET /folders/{id}/team_members
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
expand_groups |
query |
|
false |
boolean |
POST /folders/{id}/team_members
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Body
media type |
data type |
application/json |
TeamMember
(JSON) |
application/xml |
teamMember
(XML) |
DELETE /folders/{id}/team_members
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
DELETE /folders/{id}/team_members/{memberId}
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
memberId |
path |
|
long |
POST /folders/{id}/tags
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Request Body
media type |
data type |
application/json |
Tag
(JSON) |
application/xml |
tag
(XML) |
GET /folders/{id}/tags/{tagId}
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
tagId |
path |
|
|
Response Body
media type |
data type |
application/json |
Tag
(JSON) |
application/xml |
tag
(XML) |
DELETE /folders/{id}/tags/{tagId}
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
tagId |
path |
|
|
GET /folders/{id}/ancestry
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Body
media type |
data type |
application/json |
array of BinderBrief
(JSON) |
application/xml |
list of binderBrief
(XML) |
GET /folders/{id}/attachments
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
POST /folders/{id}/attachments
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
data_name |
query |
|
|
file_name |
query |
|
|
md5 |
query |
|
|
mod_date |
query |
|
|
POST /folders/{id}/attachments
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
data_name |
query |
|
|
file_name |
query |
|
|
md5 |
query |
|
|
mod_date |
query |
|
|
POST /folders/{id}/attachments
Request Parameters
name |
type |
description |
id |
path |
|