There is a WADL document available that describes the resources API.
name | path | methods | description |
---|---|---|---|
Authenticated User |
|
|
Get the User object representing the authenticated user. |
Binders |
|
|
|
Comments |
|
|
|
Files |
|
|
|
Folder Entries |
|
|
|
Folders |
|
|
|
My Files |
|
|
|
Net Folders |
|
|
|
Release Information |
|
|
Get information about the server. |
Root |
|
Entry point to the REST Interface. Returns an object containing related links to other resources. | |
Sharing |
|
|
|
Top Level Folders |
|
|
|
Users and Groups |
|
|
|
Workspaces |
|
|
|
Zone Configuration |
|
|
Get system settings. |
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 |
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. |
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 |
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. |