Folder Entries Resource

GET /folder_entries

Get folder entries by ID.

Request Parameters
name type description default constraints multivalued
count query 100 int no
description_format query The desired format for the folder entry descriptions. Can be "html" or "text". text   no
first query 0 int no
id query The ID of a folder entry. Can be specified multiple times.   long yes
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of FolderEntryBrief objects.
application/xml searchResultList (XML)

DELETE /folder_entries/{id}

Delete the specified folder entry.

Entries in personal storage folders are moved to the trash by default. purge=true will delete the entry permanently instead. Entries in external storage folders (net folders, mirrored folders) are always deleted permanantly.

Request Parameters
name type description default constraints
id path The ID of the folder entry.   long
purge query Whether the folder entry will be deleted permanently (true) or moved to the trash (false). false boolean
version query Only delete the entry if the current version of the entry's primary file attachment matches this version.   int

GET /folder_entries/{id}

Get a folder entry.

Request Parameters
name type description default constraints
id path The ID of the folder entry.   long
description_format query The desired format for the folder entry description. Can be "html" or "text". text  
include_attachments query Whether to include file attachment metadata in the response. true boolean
Response Body
media type data type
application/json FolderEntry (JSON)
application/xml folderEntry (XML)

POST /folder_entries/{id}

Request that the server synchronize the file attachment metadata of the specified folder entry. This means the server will check the file content in the file's storage area and update the metadata if it is out of date.

The Content-Type must be application/x-www-form-urlencoded. The value of the file_name form parameter in the request body should be a UTF-8 string that has been URL encoded.

Request Parameters
name type description default constraints
description_format form The desired format for the folder entry description in the response. Can be "html" or "text". text  
synchronize form If true, the file attachment metadata will be synced with the file in the storage area.   boolean
id path The ID of the folder entry.   long
Response Body
media type data type description
application/json FolderEntry (JSON) The updated FolderEntry resource.
application/xml folderEntry (XML)

PUT /folder_entries/{id}

Update the folder entry.

Request Parameters
name type description default constraints
id path The ID of the folder entry.   long
description_format query The desired format for the folder entry description in the response. Can be "html" or "text". text  
Request Body
media type data type description
application/json FolderEntry (JSON) The updated FolderEntry object.
application/xml folderEntry (XML)
Response Body
media type data type description
application/json FolderEntry (JSON) The updated FolderEntry object.
application/xml folderEntry (XML)

GET /folder_entries/{id}/access

Get the access that the authenticated user has to the specified folder entry.

Request Parameters
name type description constraints
id path The ID of the file. long
Response Body
media type data type description
application/json Access (JSON) An Access resource.
application/xml access (XML)

GET /folder_entries/{id}/ancestry

Get all of the parent binders of the folder entry. The top workspace is the first item and the entry's parent binder is the last item.

For example, the ancestry of an entry in "/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A/B" is:

  • /Home Workspace
  • /Home Workspace/Personal Workspaces
  • /Home Workspace/Personal Workspaces/Bob Barker (bbarker)
  • /Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A
  • /Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A/B

Request Parameters
name type description constraints
id path The ID of the folder entry. long
Response Body
media type data type description
application/json array of BinderBrief (JSON) A list of BinderBrief objects.
application/xml list of binderBrief (XML)

GET /folder_entries/{id}/replies

List the first level of replies to the specified folder entry.

Request Parameters
name type description default constraints
id path The ID of the folder entry.   long
description_format query The desired format for the folder entry description in the response. Can be "html" or "text". text  
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of Reply objects.
application/xml searchResultList (XML)

POST /folder_entries/{id}/replies

Add a reply to the specified folder entry.

Request Parameters
name type description default constraints
id path The ID of the folder entry.   long
description_format query The desired format for the folder entry description in the response. Can be "html" or "text". text  
Request Body
media type data type description
application/json Reply (JSON) The reply to add. The description text must be specified in the Reply object. The title is optional.
application/xml reply (XML)
Response Body
media type data type description
application/json Reply (JSON) The new Reply object.
application/xml reply (XML)

GET /folder_entries/{id}/reply_tree

Get a tree structure with all of the replies to this folder entry.

Request Parameters
name type description default constraints
id path The ID of the folder entry.   long
description_format query The desired format for the reply descriptions in the response. Can be "html" or "text". text  
Response Body
media type data type description
application/json SearchResultTree (JSON) A SearchResultTree of Reply objects.
application/xml searchResultTree (XML)

GET /folder_entries/{id}/shares

Get information about the users and groups with whom the authenticated user has shared the folder entry.

Request Parameters
name type description constraints
id path The ID of the folder entry. long
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of Share resources.
application/xml searchResultList (XML)

POST /folder_entries/{id}/shares

Share the specified folder entry with another user or group. Minimally, you must specify the Share recipient and access role.

If the authenticated user has already shared the folder entry with the specified recipient, this will overwrite the previous share settings.

Request Parameters
name type description default constraints multivalued
id path The ID of the folder entry.   long no
notify query If true, the recipient will be notified by email. false boolean no
notify_address query An email address to notify, if the recipient type is public_link. May be specified multiple times.     yes
Request Body
media type data type description
application/json Share (JSON) The share object to create.
application/xml share (XML)
Response Body
media type data type description
application/json Share (JSON) The newly created Share resource.
application/xml share (XML)