Reference Documentation for the Filr Client REST Interface

Resources

There is a WADL document available that describes the resources API.

name path methods description
Authenticated User
  • /self
  • GET
Get the User object representing the authenticated user.
Binders
  • /binders
  • /binders/library_children
  • /binders/{id}
  • GET
  • GET
  • GET
 
Comments
  • /replies
  • /replies/{id}
  • /replies/{id}/reply_tree
  • GET
  • DELETE, GET, POST, PUT
  • GET
 
Files
  • /files
  • /files/{id}
  • /files/{id}/access
  • /files/{id}/metadata
  • /files/{id}/name
  • /files/{id}/parent_folder
  • /files/{id}/scaled
  • /files/{id}/thumbnail
  • GET
  • DELETE, GET, POST
  • GET
  • GET, POST
  • POST
  • POST
  • GET
  • GET
 
Folder Entries
  • /folder_entries
  • /folder_entries/{id}
  • /folder_entries/{id}/access
  • /folder_entries/{id}/ancestry
  • /folder_entries/{id}/replies
  • /folder_entries/{id}/reply_tree
  • /folder_entries/{id}/shares
  • GET
  • DELETE, GET, POST, PUT
  • GET
  • GET
  • GET, POST
  • GET
  • GET, POST
 
Folders
  • /folders
  • /folders/{id}
  • /folders/{id}/access
  • /folders/{id}/ancestry
  • /folders/{id}/library_changes
  • /folders/{id}/library_children
  • /folders/{id}/library_entities
  • /folders/{id}/library_files
  • /folders/{id}/library_folders
  • /folders/{id}/library_tree
  • /folders/{id}/parent_binder
  • /folders/{id}/recent_activity
  • /folders/{id}/shares
  • /folders/{id}/title
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET, POST
  • GET, POST
  • GET
  • POST
  • GET
  • GET, POST
  • POST
 
My Files
  • /self/my_files/library_changes
  • /self/my_files/library_children
  • /self/my_files/library_entities
  • /self/my_files/library_files
  • /self/my_files/library_folders
  • /self/my_files/library_tree
  • /self/my_files/recent_activity
  • GET
  • GET
  • GET
  • GET, POST
  • GET, POST
  • GET
  • GET
 
Net Folders
  • /net_folders
  • /net_folders/library_entities
  • /net_folders/recent_activity
  • GET
  • GET
  • GET
 
Release Information
  • /release_info
  • GET
Get information about the server.
Root
  • GET
Entry point to the REST Interface. Returns an object containing related links to other resources.
Sharing
  • /shares
  • /shares/by_user/{id}
  • /shares/by_user/{id}/library_changes
  • /shares/by_user/{id}/library_children
  • /shares/by_user/{id}/library_entities
  • /shares/by_user/{id}/library_files
  • /shares/by_user/{id}/library_folders
  • /shares/by_user/{id}/recent_activity
  • /shares/public
  • /shares/public/library_changes
  • /shares/public/library_children
  • /shares/public/library_entities
  • /shares/public/library_files
  • /shares/public/library_folders
  • /shares/public/library_tree
  • /shares/public/recent_activity
  • /shares/with_user/{id}
  • /shares/with_user/{id}/library_changes
  • /shares/with_user/{id}/library_children
  • /shares/with_user/{id}/library_entities
  • /shares/with_user/{id}/library_files
  • /shares/with_user/{id}/library_folders
  • /shares/with_user/{id}/library_tree
  • /shares/with_user/{id}/recent_activity
  • /shares/{id}
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE, GET, POST
 
Top Level Folders
  • /self/my_files
  • /self/net_folders
  • /self/public_shares
  • /self/roots
  • /self/shared_by_me
  • /self/shared_with_me
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
 
Users and Groups
  • /groups
  • /groups/{id}
  • /groups/{id}/members
  • /groups/{id}/members/{memberId}
  • /principals
  • /principals/{id}
  • /users/{id}
  • /users/{id}/groups
  • /users/{id}/password
  • GET
  • GET, PUT
  • GET, POST
  • DELETE
  • GET
  • GET
  • GET
  • GET
  • POST
 
Workspaces
  • /workspaces
  • /workspaces/{id}
  • /workspaces/{id}/access
  • /workspaces/{id}/ancestry
  • /workspaces/{id}/library_changes
  • /workspaces/{id}/library_children
  • /workspaces/{id}/library_entities
  • /workspaces/{id}/library_files
  • /workspaces/{id}/library_folders
  • /workspaces/{id}/library_tree
  • /workspaces/{id}/parent_binder
  • /workspaces/{id}/recent_activity
  • /workspaces/{id}/shares
  • /workspaces/{id}/title
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET, POST
  • GET
  • POST
  • GET
  • GET, POST
  • POST
 
Zone Configuration
  • /zone_config
  • GET
Get system settings.

Data Types

JSON

type description
Access The access a user or group has to a resource.
BaseBinderChange Base class representing a change that has occurred in a binder.
BaseFileProperties Base class for file objects.
BaseFolderEntry Base class for FolderEntries and Replies.
BaseFolderEntryBrief Base class for FolderEntryBriefs and ReplyBriefs. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
BaseRestObject A base class for many of the REST data types.
Binder A base class for containers such as folders and workspaces.
BinderBrief Minimal information about a binder. BinderBrief objects are typically returned in list results because they are more efficient to build than full Binder objects.
BinderChanges A list of BinderChange objects.
BinderChildren Information about a binder's children. Will contain either a list of children error information, but not both.
BinderQuotasConfig Global binder quota settings.
BinderTree Tree representation of all of the subbinders of a binder.
CustomField Custom fields of a definable entity.
DefinableEntity Base class for binders, folder entries, replies and principals (users and groups)
DefinableEntityBrief Base class for BinderBrief, FolderEntryBrief, ReplyBrief, UserBrief and GroupBrief objects. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
Description Description text with information about the formatting of the text.
DesktopAppConfig Desktop application configuration
DesktopAppProcessConfig Configuration of processes that are allowed to trigger on-demand file downloads on the desktop.
DiskQuotasConfig Global disk quota settings. The authenticated user might have different settings.

Disk quota only applies to personal storage.
EntityId An ID, type and HRef which references another resource object.
Entry Base class for folder entries and principals.
EntryBrief Base class for FolderEntryBriefs, ReplyBriefs and PrincipalBriefs. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
ErrorInfo Information about an error that occurred.
ExternalSharingRestrictions Restrictions for sharing with external users.
FileBrief Mininal information about a file.
FileProperties File metadata.
FileVersionProperties
Folder Folder metadata.
FolderEntry An entry in a folder.

In Filr, this is a wrapper around a file.
FolderEntryBrief Minimal information about a folder entry. FolderEntryBrief objects are typically returned in list results because they are more efficient to build than full FolderEntry objects
Group A group.
GroupBrief Minimal information about a group. GroupBrief objects are typically returned in list results because they are more efficient to build than full Group objects
GroupMember A member of a group.
HistoryStamp Represents a date and time when a user performed an action.
LibraryInfo Miscellaneous information and statistics of a Binder.
Link A link to a related resource.
Locale A locale, consisting of a language code and a country code ("en_US").
LongIdLinkPair An ID and HRef which references another resource object.
MobileAppConfig A user's effective mobile application settings.
MobileDevice
NameHrefPair An HRef with an associated name.
NetFolderBrief Minimal information about a Net Folder.
NotifyWarning Problem that occurred sending an email notification to a share recipient.
Operation
ParentBinder Information about the parent binder of an object.
Permission
Principal Base class for users and groups
PrincipalBrief Minimal information about a Principal (User or Group). Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
RecentActivityEntry A recently modified Folder Entry.
Recipient A reference to a user or group that is the recipient of a share or assigned permission.
ReleaseInfo Server version information.
Reply A reply or comment.
ReplyBrief Minimal information about a Reply. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
RootRestObject Root object of the REST API. Contains links to top level resources in the REST API.
SearchResultList A list of paged results.
SearchResultTree A tree structure.
SearchResultTreeNode Node in a SearchResultTree.
SearchableObject A base class for all objects that are indexed and can be included in search results.
Share Information about a file or folder that has been shared.
ShareRecipient Reference to the recipient of a shared item.

Type can be one of user, group. external_user, public. public_link. If type is public or public_link, ID and hrek are not applicable.

SharedBinderBrief Minimal information about a binder plus sharing information.
SharedFolderEntryBrief User: david Date: 7/25/12 Time: 2:00 PM
SharingPermission Sharing permissions
StringIdLinkPair An ID and HRef which references another resource object.
Tag
TeamBrief
TeamMember
User The metadata for a user
UserBrief Minimal information about a User. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
Workspace Workspace metadata.
ZoneConfig The system settings for the authenticated user.

XML

Default Namespace (schema)
type description
access The access a user or group has to a resource.
baseBinderChange Base class representing a change that has occurred in a binder.
baseFileProperties Base class for file objects.
baseFolderEntry Base class for FolderEntries and Replies.
baseFolderEntryBrief Base class for FolderEntryBriefs and ReplyBriefs. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
baseRestObject A base class for many of the REST data types.
binder A base class for containers such as folders and workspaces.
binderBrief Minimal information about a binder. BinderBrief objects are typically returned in list results because they are more efficient to build than full Binder objects.
binderChanges A list of BinderChange objects.
binderChildren Information about a binder's children. Will contain either a list of children error information, but not both.
binderQuotasConfig Global binder quota settings.
binderTree Tree representation of all of the subbinders of a binder.
customField Custom fields of a definable entity.
definableEntity Base class for binders, folder entries, replies and principals (users and groups)
definableEntityBrief Base class for BinderBrief, FolderEntryBrief, ReplyBrief, UserBrief and GroupBrief objects. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
description Description text with information about the formatting of the text.
desktopAppConfig Desktop application configuration
desktopAppProcessConfig Configuration of processes that are allowed to trigger on-demand file downloads on the desktop.
diskQuotasConfig Global disk quota settings. The authenticated user might have different settings.

Disk quota only applies to personal storage.
entityId An ID, type and HRef which references another resource object.
entry Base class for folder entries and principals.
entryBrief Base class for FolderEntryBriefs, ReplyBriefs and PrincipalBriefs. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
errorInfo Information about an error that occurred.
externalSharingRestrictions Restrictions for sharing with external users.
fileBrief Mininal information about a file.
fileProperties File metadata.
fileVersionProperties
folder Folder metadata.
folderEntry An entry in a folder.

In Filr, this is a wrapper around a file.
folderEntryBrief Minimal information about a folder entry. FolderEntryBrief objects are typically returned in list results because they are more efficient to build than full FolderEntry objects
group A group.
groupBrief Minimal information about a group. GroupBrief objects are typically returned in list results because they are more efficient to build than full Group objects
groupMember A member of a group.
historyStamp Represents a date and time when a user performed an action.
libraryInfo Miscellaneous information and statistics of a Binder.
link A link to a related resource.
locale A locale, consisting of a language code and a country code ("en_US").
longIdLinkPair An ID and HRef which references another resource object.
mobileAppConfig A user's effective mobile application settings.
mobileDevice
nameHrefPair An HRef with an associated name.
netFolderBrief Minimal information about a Net Folder.
notifyWarning Problem that occurred sending an email notification to a share recipient.
operation
parentBinder Information about the parent binder of an object.
permission
principal Base class for users and groups
principalBrief Minimal information about a Principal (User or Group). Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
recentActivityEntry A recently modified Folder Entry.
recipient A reference to a user or group that is the recipient of a share or assigned permission.
releaseInfo Server version information.
reply A reply or comment.
replyBrief Minimal information about a Reply. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
rootRestObject Root object of the REST API. Contains links to top level resources in the REST API.
searchResultList A list of paged results.
searchResultTree A tree structure.
searchResultTreeNode Node in a SearchResultTree.
searchableObject A base class for all objects that are indexed and can be included in search results.
share Information about a file or folder that has been shared.
shareRecipient Reference to the recipient of a shared item.

Type can be one of user, group. external_user, public. public_link. If type is public or public_link, ID and hrek are not applicable.

sharedBinderBrief Minimal information about a binder plus sharing information.
sharedFolderEntryBrief User: david Date: 7/25/12 Time: 2:00 PM
sharingPermission Sharing permissions
stringIdLinkPair An ID and HRef which references another resource object.
tag
teamBrief
teamMember
user The metadata for a user
userBrief Minimal information about a User. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.
workspace Workspace metadata.
zoneConfig The system settings for the authenticated user.