My Files Resource

GET /self/my_files/library_changes

Get changes to files and folders that have occurred in My Files since the specified date.

Request Parameters
name type description default constraints
count query The maximum number of changes to return. 500 int
description_format query The desired format for descriptions. Can be "html" or "text". text  
recursive query Whether to return changes in the immediate folder only (false) or all subfolders (true). true boolean
since query UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z.    
Response Codes
code condition
409 The changes cannot be determined.
Response Body
media type data type description
application/json BinderChanges (JSON) A BinderChanges resource.
application/xml binderChanges (XML)

GET /self/my_files/library_children

List the children of My Files.

The title query parameter limits the results to those children with the specified name. Wildcards are not supported.

Request Parameters
name type description default constraints
allow_jits query Whether to trigger JITS, if applicable. true boolean
count query The maximum number of results to return. 100 int
description_format query The desired format for the children descriptions. Can be "html" or "text". text  
first query The index of the first result to return. 0 int
title query The name of the child to return,    
Response Body
media type data type description
application/json object (JSON) A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).
application/xml anyType (XML)

GET /self/my_files/library_entities

Search for entities by keyword.

Request Parameters
name type description default constraints
binders query Whether to include binders in the results. true boolean
count query The maximum number of results to return. 100 int
description_format query The desired format for the binder description. Can be "html" or "text". text  
files query Whether to include files in the results. true boolean
first query The index of the first result to return. 0 int
folder_entries query Whether to include folder entries in the results. true boolean
keyword query A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.    
parent_binder_paths query Whether to include the parent binder path with each entity. false boolean
recursive query Whether to search the immediate folder (false) or all subfolders (true). false boolean
replies query Whether to include replies in the results. true boolean
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).
application/xml searchResultList (XML)

GET /self/my_files/library_files

List the child files of My Files.

Request Parameters
name type description default constraints
count query The maximum number of results to return.   int
file_name query The name of the child to return,    
first query The index of the first result to return.   int
parent_binder_paths query If true, the path of the parent binder is included in each result. false boolean
recursive query Whether to search the binder and sub-binders for files. false boolean
Response Body
media type data type description
application/json object (JSON) A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).
application/xml anyType (XML)

POST /self/my_files/library_files

Add a file to the user's My Files top level folder. The request Content-Type can be anything except x-www-form-urlencoded. Supports multipart/form-data posts (see here). If another Content-Type is specified (application/octet-stream, for example), the raw bytes of the request body are read and stored as the file content.

Request Parameters
name type description default constraints
file_name query The name of the file to create.    
md5 query The MD5 checksum of the file. If specified, the REST interface returns an error if the MD5 checksum of the uploaded content does not match the expected value.    
mod_date query The desired last modified time for the new file.    
overwrite_existing query If a file already exists with the specified name, this specifies whether to overwrite the file (true) or fail with an error (false). false boolean
Response Codes
code condition
409 (FILE_EXISTS) A file with the specified name already exists in the target folder.
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /self/my_files/library_files

Copy a file into the user's My Files top level folder.

The Content-Type must be application/x-www-form-urlencoded. The parameter values in the form data should be URL-encoded UTF-8 strings. For example: source_id=09c1c3fb530f562401531070137b000e&file_name=H%C3%B6wdy

.

Request Parameters
name type description
file_name form The name of the new file.
source_id form The ID of the source file to copy.
Response Codes
code condition
404 (FILE_NOT_FOUND) The source file does not exist.
409 (FILE_EXISTS) A file with the specified name already exists in the target folder.
Response Body
media type data type description
application/json FileProperties (JSON) The new file metadata.
application/xml fileProperties (XML)

GET /self/my_files/library_folders

List the child folders of My Files.

The title query parameter limits the results to those folders with the specified name. Wildcards are not supported.

Request Parameters
name type description default constraints
count query The maximum number of results to return. 100 int
description_format query The desired format for the children descriptions. Can be "html" or "text". text  
first query The index of the first result to return. 0 int
title query The name of the child to return,    
Response Body
media type data type description
application/json object (JSON) A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).
application/xml anyType (XML)

POST /self/my_files/library_folders

Create a new folder in the authenticated user's My Files folder.

Request Parameters
name type description default
description_format query The desired format for the folder description in the response. Can be "html" or "text". text
Request Body
media type data type description
application/json BinderBrief (JSON) The BinderBrief object to be created. Minimally, you must specify the "title".
application/xml binderBrief (XML)
Response Body
media type data type description
application/json Folder (JSON) The new Folder object.
application/xml folder (XML)

POST /self/my_files/library_folders

Copy a folder into the user's My Files folder.

The Content-Type must be application/x-www-form-urlencoded. The title value in the form data should be a URL-encoded UTF-8 string. For example: source_id=48&title=H%C3%B6wdy.

Request Parameters
name type description default constraints
source_id form The ID of the source folder to copy.   long
title form The name of the new folder.    
description_format query text  
Response Body
media type data type description
application/json Folder (JSON) The new binder metadata.
application/xml folder (XML)

GET /self/my_files/library_tree

Get a tree structure representing the folder structure contained in My Files.

Request Parameters
name type description default
description_format query The desired format for the binder descriptions. Can be "html" or "text". text
Response Body
media type data type description
application/json BinderTree (JSON) A BinderTree
application/xml binderTree (XML)

GET /self/my_files/recent_activity

List recently changed folder entries in My Files.

Request Parameters
name type description default constraints
count query The maximum number of results to return. 20 int
description_format query The desired format for the folder entry description. Can be "html" or "text". text  
file_name query    
first query The index of the first result to return. 0 int
parent_binder_paths query Whether to include the parent binder path with each entry. false boolean
Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of RecentActivityEntry resources.
application/xml searchResultList (XML)