<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?enunciate-assumed-base-uri ./?> <wadl:application xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <wadl:doc xmlns:enunciate="http://enunciate.webcohesion.com/" enunciate:generatedBy="Enunciate-2.0"/> <wadl:grammars> <wadl:include href="ns0.xsd"/> </wadl:grammars> <wadl:resources base="./"> <wadl:resource path=""> <wadl:method name="GET"> <wadl:doc><![CDATA[Entry point to the REST Interface. Returns an object containing related links to other resources.]]></wadl:doc> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="rest_api_root"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="binders"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get binders by ID. <p>This resource supports top level folder IDs, such as -100 (My Files)</p> <p>Example: <code>GET /rest/binders?id=-100&id=46&id=48</code></p>]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[The ID of a binder. Can be specified multiple times.]]></wadl:doc> </wadl:param> <wadl:param name="library_info" style="query"> <wadl:doc><![CDATA[Whether to calculate and return additional folder statistics for the binders. These calculations can be very expensive.]]></wadl:doc> </wadl:param> <wadl:param name="library_mod_times" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of BinderBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="binders/library_children"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the children of the specified binders. <p><code>count</code> specifies the total number of children to return. For example, <code>id=-100&id=48&id=49&count=10</code> might return all 6 children of folder 48, the first 4 children of folder 49 and no results for folder -100. The order that the binder IDs are processed in is non-deterministic.</p> <p>The <code>first_id</code> and <code>first</code> parameters can be used to continue retrieving results from binders whose children are only partially listed in the previous request. The children of the binder specified by <code>first_id</code> are included first, beginning with the <code>first + 1</code> child. </p> <p>For example, <code>id=-100&id=48&first_id=48&first=4&count=10</code> is will return results 5-14 of folder 48. If folder 48 has fewer than 14 children, then the first few children of folder -100 will also be included in the response.</p> <p>Paging the results of the Shared with Me (-101), Shared by Me (-102) and Public (-104) top level folders is not supported. This resource will return all children of those folders, even if that means that more than <code>count</code> children are returned.</p> <p>If an error occurs listing the children of a particular binder, a BinderChildren object for that binder will be included in the results with information about the error that occurred.</p> <p>This resource supports top level folder IDs, such as -100 (My Files)</p>]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of children to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[Specifies the first child to return. Ignored if <code>first_id</code> is not specified.]]></wadl:doc> </wadl:param> <wadl:param name="first_id" style="query"> <wadl:doc><![CDATA[The binder to start with.]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[The ID of a binder whose children are to be listed. Can be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A list of BinderChildren resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binderChildren"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="binders/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the Binder with the specified ID.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Configures whether attachments should be included in the returned Binder object.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[Returns a subclass of Binder (Folder or Workspace).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files"> <wadl:method name="GET"> <wadl:doc><![CDATA[List files by ID or file name.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[List files matching this file name pattern. The first characted in the pattern cannot be * or ?.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The first index to return (for paging).]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[A file ID to search for. Can be specified multiple times (<code>id=0909938984230942380432&id=971239483127492384732914</code>]]></wadl:doc> </wadl:param> <wadl:param name="library" style="query"> <wadl:doc><![CDATA[Limit the search to files in library folder. A library folder is one that requires unique file names.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent folder path with each result.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of FileProperties objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}"> <wadl:method name="POST"> <wadl:doc><![CDATA[Upload a new version of a file. The request Content-Type can be anything except <code>x-www-form-urlencoded</code>. Supports <code>multipart/form-data</code> posts (see <a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2">here</a>). If another Content-Type is specified (<code>application/octet-stream</code>, for example), the raw bytes of the request body are read and stored as the file content. <p>You must specify either <code>force_overwrite</code> or <code>last_version</code>.</p>]]></wadl:doc> <wadl:request> <wadl:param name="data_name" style="query"> <wadl:doc><![CDATA[Reserved.]]></wadl:doc> </wadl:param> <wadl:param name="force_overwrite" style="query"> <wadl:doc><![CDATA[Overwrite the current version of the file, regardless of the current file version.]]></wadl:doc> </wadl:param> <wadl:param name="last_major_version" style="query"> <wadl:doc><![CDATA[Reserved.]]></wadl:doc> </wadl:param> <wadl:param name="last_minor_version" style="query"> <wadl:doc><![CDATA[Reserved.]]></wadl:doc> </wadl:param> <wadl:param name="last_version" style="query"> <wadl:doc><![CDATA[Only update the file if the current version matches this value.]]></wadl:doc> </wadl:param> <wadl:param name="md5" style="query"> <wadl:doc><![CDATA[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.]]></wadl:doc> </wadl:param> <wadl:param name="mod_date" style="query"> <wadl:doc><![CDATA[The desired last modified time for the file.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated FileProperties resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Download the specified file.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The content of the file.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}"> <wadl:method name="DELETE"> <wadl:doc><![CDATA[Delete the specified file.]]></wadl:doc> <wadl:request> <wadl:param name="purge" style="query"> <wadl:doc><![CDATA[Whether to purge the file (delete permanently) or move to the trash. Only applies to files in personal storage. Files in external storage are always purged.]]></wadl:doc> </wadl:param> <wadl:param name="version" style="query"> <wadl:doc><![CDATA[Only delete the file if the current version matches this value.]]></wadl:doc> </wadl:param> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}/access"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the access that the authenticated user has to the specified file.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[An Access resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="access"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}/metadata"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the file metadata.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The FileProperties resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}/metadata"> <wadl:method name="POST"> <wadl:doc><![CDATA[Request that the server synchronize the metadata of the specified file. 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. <p>The Content-Type must be <code>application/x-www-form-urlencoded</code>. The value of the file_name form parameter in the request body should be a UTF-8 string that has been URL encoded.</p>]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated FileProperties resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}/name"> <wadl:method name="POST"> <wadl:doc><![CDATA[Rename the specified file. The Content-Type must be <code>application/x-www-form-urlencoded</code>. The value of the file_name form parameter in the request body should be a UTF-8 string that has been URL encoded.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated FileProperties resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}/parent_folder"> <wadl:method name="POST"> <wadl:doc><![CDATA[Move the specified file to another folder. The Content-Type must be <code>application/x-www-form-urlencoded</code>. The value of the file_name form parameter in the request body should be a UTF-8 string that has been URL encoded.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated FileProperties resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}/scaled"> <wadl:method name="GET"> <wadl:doc><![CDATA[Download a scaled image of the specified file.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="files/{id}/thumbnail"> <wadl:method name="GET"> <wadl:doc><![CDATA[Download a square thumbnail image of the specified file.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get folder entries by ID.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[The ID of a folder entry. Can be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of FolderEntryBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a folder entry.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include file attachment metadata in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder_entry"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}"> <wadl:method name="PUT"> <wadl:doc><![CDATA[Update the folder entry.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The updated FolderEntry object.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="folder_entry"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated FolderEntry object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder_entry"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}"> <wadl:method name="POST"> <wadl:doc><![CDATA[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. <p>The Content-Type must be <code>application/x-www-form-urlencoded</code>. The value of the file_name form parameter in the request body should be a UTF-8 string that has been URL encoded.</p>]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated FolderEntry resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder_entry"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}"> <wadl:method name="DELETE"> <wadl:doc><![CDATA[Delete the specified folder entry. <p>Entries in personal storage folders are moved to the trash by default. <code>purge=true</code> will delete the entry permanently instead. Entries in external storage folders (net folders, mirrored folders) are always deleted permanantly.</p>]]></wadl:doc> <wadl:request> <wadl:param name="purge" style="query"> <wadl:doc><![CDATA[Whether the folder entry will be deleted permanently (true) or moved to the trash (false).]]></wadl:doc> </wadl:param> <wadl:param name="version" style="query"> <wadl:doc><![CDATA[Only delete the entry if the current version of the entry's primary file attachment matches this version.]]></wadl:doc> </wadl:param> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}/access"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the access that the authenticated user has to the specified folder entry.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[An Access resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="access"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}/ancestry"> <wadl:method name="GET"> <wadl:doc><![CDATA[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. <p>For example, the ancestry of an entry in "/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A/B" is: <ul> <li>/Home Workspace</li> <li>/Home Workspace/Personal Workspaces</li> <li>/Home Workspace/Personal Workspaces/Bob Barker (bbarker)</li> <li>/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A</li> <li>/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A/B</li> </ul>]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A list of BinderBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}/replies"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the first level of replies to the specified folder entry.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Reply objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}/replies"> <wadl:method name="POST"> <wadl:doc><![CDATA[Add a reply to the specified folder entry.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The reply to add. The description text must be specified in the Reply object. The title is optional.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="reply"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new Reply object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="reply"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}/reply_tree"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a tree structure with all of the replies to this folder entry.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply descriptions in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultTree of Reply objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="tree"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}/shares"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get information about the users and groups with whom the authenticated user has shared the folder entry.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Share resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folder_entries/{id}/shares"> <wadl:method name="POST"> <wadl:doc><![CDATA[Share the specified folder entry with another user or group. Minimally, you must specify the Share recipient and access role. <p>If the authenticated user has already shared the folder entry with the specified recipient, this will overwrite the previous share settings.</p>]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The share object to create.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> <wadl:param name="notify_address" style="query"> <wadl:doc><![CDATA[An email address to notify, if the recipient type is <code>public_link</code>. May be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="share"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> <wadl:param name="notify_address" style="query"> <wadl:doc><![CDATA[An email address to notify, if the recipient type is <code>public_link</code>. May be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> <wadl:param name="notify_address" style="query"> <wadl:doc><![CDATA[An email address to notify, if the recipient type is <code>public_link</code>. May be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The newly created Share resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="share"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get folders by ID.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[The ID of a folder. Can be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of BinderBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the binder with the specified ID.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Configures whether attachments should be included in the returned binder object.]]></wadl:doc> </wadl:param> <wadl:param name="library_info" style="query"> <wadl:doc><![CDATA[Whether to calculate and return binder statistics such as total size on disk.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[Returns a subclass of Binder.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}"> <wadl:method name="PUT"> <wadl:doc><![CDATA[Update a binder.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The new binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to return attachments in the response.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="binder"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to return attachments in the response.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to return attachments in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}"> <wadl:method name="DELETE"> <wadl:doc><![CDATA[Delete the specifed binder object. <p>Personal storage folders are moved to the trash by default. <code>purge=true</code> will delete the folder permanently instead. Folders on external storage (net folders, mirrored folders) are always deleted permanantly.</p>]]></wadl:doc> <wadl:request> <wadl:param name="only_if_empty" style="query"> <wadl:doc><![CDATA[Only delete the folder if it is empty.]]></wadl:doc> </wadl:param> <wadl:param name="purge" style="query"> <wadl:doc><![CDATA[Whether the binder will be deleted permanently (true) or moved to the trash (false).]]></wadl:doc> </wadl:param> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/access"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the rights that the authenticated user has to the binder.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[An Access object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="access"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/ancestry"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get all of the parent binders of the binder. The top workspace is the first item and the immediate parent is the last item. <p>For example, the ancestry of "/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A/B" is: <ul> <li>/Home Workspace</li> <li>/Home Workspace/Personal Workspaces</li> <li>/Home Workspace/Personal Workspaces/Bob Barker (bbarker)</li> <li>/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A</li> </ul>]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A list of BinderBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_changes"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get changes to files and folders that have occurred since the specified date.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of changes to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to return changes in the immediate folder only (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="since" style="query"> <wadl:doc><![CDATA[UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderChanges resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_changes"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_children"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the children of a binder. <p>The <code>title</code> query parameter limits the results to those children with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="allow_jits" style="query"> <wadl:doc><![CDATA[Whether to trigger JITS, if applicable.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_entities"> <wadl:method name="GET"> <wadl:doc><![CDATA[Search for entities by keyword.]]></wadl:doc> <wadl:request> <wadl:param name="binders" style="query"> <wadl:doc><![CDATA[Whether to include binders in the results.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="files" style="query"> <wadl:doc><![CDATA[Whether to include files in the results.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="folder_entries" style="query"> <wadl:doc><![CDATA[Whether to include folder entries in the results.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entity.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the immediate folder (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="replies" style="query"> <wadl:doc><![CDATA[Whether to include replies in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_files"> <wadl:method name="POST"> <wadl:doc><![CDATA[Copy a file into the specified folder. <p>The Content-Type must be <code>application/x-www-form-urlencoded</code>. The parameter values in the form data should be URL-encoded UTF-8 strings. For example: <code>source_id=09c1c3fb530f562401531070137b000e&file_name=H%C3%B6wdy</code>.</p>]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new file metadata.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_files"> <wadl:method name="POST"> <wadl:doc><![CDATA[Add a file to the specified folder. The request Content-Type can be anything except <code>x-www-form-urlencoded</code>. Supports <code>multipart/form-data</code> posts (see <a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2">here</a>). If another Content-Type is specified (<code>application/octet-stream</code>, for example), the raw bytes of the request body are read and stored as the file content.]]></wadl:doc> <wadl:request> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the file to create.]]></wadl:doc> </wadl:param> <wadl:param name="md5" style="query"> <wadl:doc><![CDATA[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.]]></wadl:doc> </wadl:param> <wadl:param name="mod_date" style="query"> <wadl:doc><![CDATA[The desired last modified time for the new file.]]></wadl:doc> </wadl:param> <wadl:param name="overwrite_existing" style="query"> <wadl:doc><![CDATA[If a file already exists with the specified name, this specifies whether to overwrite the file (true) or fail with an error (false).]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_files"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the child files of a binder.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[If true, the path of the parent binder is included in each result.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the binder and sub-binders for files.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the child folders of a binder. <p>The <code>title</code> query parameter limits the results to those folders with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_folders"> <wadl:method name="POST"> <wadl:doc><![CDATA[Copy a folder into the specified binder. <p>The Content-Type must be <code>application/x-www-form-urlencoded</code>. The title value in the form data should be a URL-encoded UTF-8 string. For example: <code>source_id=48&title=H%C3%B6wdy</code>.</p>]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new binder metadata.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_folders"> <wadl:method name="POST"> <wadl:doc><![CDATA[Create a new folder.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The BinderBrief object to be created. Minimally, you must specify the "title".]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder where the folder should be createad..]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="binder_brief"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder where the folder should be createad..]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new Folder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/library_tree"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a tree structure representing the folder structure contained in this binder.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderTree]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_tree"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/parent_binder"> <wadl:method name="POST"> <wadl:doc><![CDATA[Move the specified binder. The Content-Type must be <code>application/x-www-form-urlencoded</code>.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include the binder attachments in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The modified binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/recent_activity"> <wadl:method name="GET"> <wadl:doc><![CDATA[List recently changed folder entries in the specified binder.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entry.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of RecentActivityEntry resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/shares"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get information about the users and groups with whom the authenticated user has shared the binder.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Share resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/shares"> <wadl:method name="POST"> <wadl:doc><![CDATA[Share the binder with another user or group. Minimally, you must specify the Share recipient and access role. <p>If the authenticated user has already shared the folder with the specified recipient, this will overwrite the previous share settings.</p>]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The share object to create.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="share"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The newly created Share resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="share"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="folders/{id}/title"> <wadl:method name="POST"> <wadl:doc><![CDATA[Rename the specified binder. The Content-Type must be <code>application/x-www-form-urlencoded</code>. The value of the title form parameter in the request body should be a UTF-8 string that has been URL encoded.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include the binder attachments in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The modified binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="groups"> <wadl:method name="GET"> <wadl:doc><![CDATA[List groups.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="name" style="query"> <wadl:doc><![CDATA[A name to search for. May contain wildcard characters.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of GroupBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="groups/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a group.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include attachments in the returned group.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A Group resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="group"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="groups/{id}"> <wadl:method name="PUT"> <wadl:doc><![CDATA[Update a group.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[A Group resource with updated fields.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the group.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="group"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the group.]]></wadl:doc> </wadl:param> </wadl:representation> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="groups/{id}/members"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the members of the group.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of GroupMember objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="groups/{id}/members"> <wadl:method name="POST"> <wadl:doc><![CDATA[Add a user or group to a group.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The User or Group to add.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the group.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="principal_brief"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the group.]]></wadl:doc> </wadl:param> </wadl:representation> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="groups/{id}/members/{memberId}"> <wadl:method name="DELETE"> <wadl:doc><![CDATA[Remove a member from a group.]]></wadl:doc> <wadl:request> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="net_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the net folders that the authenticated user has access to. <p>The optional <code>title</code> query parameter limits the results to the net folder with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the net folder.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="net_folders/library_entities"> <wadl:method name="GET"> <wadl:doc><![CDATA[Search for entities by keyword.]]></wadl:doc> <wadl:request> <wadl:param name="binders" style="query"> <wadl:doc><![CDATA[Whether to include binders in the results.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="files" style="query"> <wadl:doc><![CDATA[Whether to include files in the results.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="folder_entries" style="query"> <wadl:doc><![CDATA[Whether to include folder entries in the results.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entity.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the immediate folder (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="replies" style="query"> <wadl:doc><![CDATA[Whether to include replies in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="net_folders/recent_activity"> <wadl:method name="GET"> <wadl:doc><![CDATA[List recently changed folder entries in Net Folders.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entry.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of RecentActivityEntry resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="principals"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get users and groups by ID or by keyword. <p> <ul> <li>By ID: <code>id=20&id=32&id=46</code></li> <li>By Keyword: <code>keyword=Jo*</code></li> </ul> </p>]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the user and group descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[A user or group ID. May be specified multiple times.]]></wadl:doc> </wadl:param> <wadl:param name="include_all_users_group" style="query"> <wadl:doc><![CDATA[Whether to include the "All Users" group in the results.]]></wadl:doc> </wadl:param> <wadl:param name="included_groups" style="query"> <wadl:doc><![CDATA[Whether to include groups in the results.]]></wadl:doc> </wadl:param> <wadl:param name="included_users" style="query"> <wadl:doc><![CDATA[Whether to include users in the results.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. Matches on full names, login names, and email address.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of UserBrief and GroupBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="principals/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a user or group.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include attachments in the returned user or group.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A User or Group resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="release_info"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get information about the server.]]></wadl:doc> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="release_info"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="replies"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get replies by ID.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[The ID of a reply. Can be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of ReplyBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="replies/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a reply.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include file attachment metadata in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="reply"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="replies/{id}"> <wadl:method name="PUT"> <wadl:doc><![CDATA[Update the reply.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The updated Reply object.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the reply.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="reply"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the reply.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated Reply object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="reply"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="replies/{id}"> <wadl:method name="DELETE"> <wadl:doc><![CDATA[Delete the specified reply and its child replies.]]></wadl:doc> <wadl:request> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="replies/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the first level of replies to this reply.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Reply objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="replies/{id}"> <wadl:method name="POST"> <wadl:doc><![CDATA[Add a reply to the specified reply.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The reply to add. The description text must be specified in the Reply object. The title is optional.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the reply.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="reply"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the reply.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new Reply object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="reply"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="replies/{id}/reply_tree"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a tree structure with all of the replies to this reply.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the reply descriptions in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultTree of Reply objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="tree"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the User object representing the authenticated user.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the User description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include attachments in the returned User object.]]></wadl:doc> </wadl:param> <wadl:param name="include_groups" style="query"> <wadl:doc><![CDATA[Whether to include the groups the user belongs to in the response.]]></wadl:doc> </wadl:param> <wadl:param name="include_mobile_devices" style="query"> <wadl:doc><![CDATA[Whether to include the mobile devices associated with the user in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The authenticated User object]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="user"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a Binder object representing the top-level My Files folder.]]></wadl:doc> <wadl:request> <wadl:param name="library_info" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderBrief object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_changes"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get changes to files and folders that have occurred in My Files since the specified date.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of changes to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to return changes in the immediate folder only (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="since" style="query"> <wadl:doc><![CDATA[UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderChanges resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_changes"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_children"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the children of My Files. <p>The <code>title</code> query parameter limits the results to those children with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="allow_jits" style="query"> <wadl:doc><![CDATA[Whether to trigger JITS, if applicable.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_entities"> <wadl:method name="GET"> <wadl:doc><![CDATA[Search for entities by keyword.]]></wadl:doc> <wadl:request> <wadl:param name="binders" style="query"> <wadl:doc><![CDATA[Whether to include binders in the results.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="files" style="query"> <wadl:doc><![CDATA[Whether to include files in the results.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="folder_entries" style="query"> <wadl:doc><![CDATA[Whether to include folder entries in the results.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entity.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the immediate folder (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="replies" style="query"> <wadl:doc><![CDATA[Whether to include replies in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_files"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the child files of My Files.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[If true, the path of the parent binder is included in each result.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the binder and sub-binders for files.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_files"> <wadl:method name="POST"> <wadl:doc><![CDATA[Copy a file into the user's My Files top level folder. <p>The Content-Type must be <code>application/x-www-form-urlencoded</code>. The parameter values in the form data should be URL-encoded UTF-8 strings. For example: <code>source_id=09c1c3fb530f562401531070137b000e&file_name=H%C3%B6wdy</code></p>.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new file metadata.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_files"> <wadl:method name="POST"> <wadl:doc><![CDATA[Add a file to the user's My Files top level folder. The request Content-Type can be anything except <code>x-www-form-urlencoded</code>. Supports <code>multipart/form-data</code> posts (see <a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2">here</a>). If another Content-Type is specified (<code>application/octet-stream</code>, for example), the raw bytes of the request body are read and stored as the file content.]]></wadl:doc> <wadl:request> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the file to create.]]></wadl:doc> </wadl:param> <wadl:param name="md5" style="query"> <wadl:doc><![CDATA[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.]]></wadl:doc> </wadl:param> <wadl:param name="mod_date" style="query"> <wadl:doc><![CDATA[The desired last modified time for the new file.]]></wadl:doc> </wadl:param> <wadl:param name="overwrite_existing" style="query"> <wadl:doc><![CDATA[If a file already exists with the specified name, this specifies whether to overwrite the file (true) or fail with an error (false).]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="file"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the child folders of My Files. <p>The <code>title</code> query parameter limits the results to those folders with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_folders"> <wadl:method name="POST"> <wadl:doc><![CDATA[Copy a folder into the user's My Files folder. <p>The Content-Type must be <code>application/x-www-form-urlencoded</code>. The title value in the form data should be a URL-encoded UTF-8 string. For example: <code>source_id=48&title=H%C3%B6wdy</code>.</p>]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new binder metadata.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_folders"> <wadl:method name="POST"> <wadl:doc><![CDATA[Create a new folder in the authenticated user's My Files folder.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The BinderBrief object to be created. Minimally, you must specify the "title".]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="binder_brief"> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new Folder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/library_tree"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a tree structure representing the folder structure contained in My Files.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderTree]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_tree"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/my_files/recent_activity"> <wadl:method name="GET"> <wadl:doc><![CDATA[List recently changed folder entries in My Files.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entry.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of RecentActivityEntry resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/net_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a Binder object representing the top-level Net Folders folder.]]></wadl:doc> <wadl:response> <wadl:doc><![CDATA[A BinderBrief object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/public_shares"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a Binder object representing the top-level Public folder.]]></wadl:doc> <wadl:response> <wadl:doc><![CDATA[A BinderBrief object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/roots"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a list of virtual workspace roots for the authenticated user. This is useful for displaying starting points for browsing different parts of the workspace hierarchy.]]></wadl:doc> <wadl:response> <wadl:doc><![CDATA[Returns a list of BinderBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/shared_by_me"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a Binder object representing the top-level Shared by Me folder.]]></wadl:doc> <wadl:response> <wadl:doc><![CDATA[A BinderBrief object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="self/shared_with_me"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a Binder object representing the top-level Shared with Me folder.]]></wadl:doc> <wadl:request> <wadl:param name="library_info" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderBrief object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares"> <wadl:method name="POST"> <wadl:doc><![CDATA[Notify share recipients without modifying the shares. <p>For <code>public_link</code> share recipients, the <code>notify_address</code> form parameter can be used to specify email addresses to notify of the public link.</p>]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="notify_warning"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/by_user/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the shares where the specified user is the sharer.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Share objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/by_user/{id}/library_changes"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get changes to files and folders that have occurred in the user's Share by Me folder since the specified date.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of changes to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to return changes in the immediate folder only (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="since" style="query"> <wadl:doc><![CDATA[UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderChanges resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_changes"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/by_user/{id}/library_children"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the files and folders shared by the specified user.. <p>The <code>title</code> query parameter limits the results to those children with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/by_user/{id}/library_entities"> <wadl:method name="GET"> <wadl:doc><![CDATA[Search files and folder shared by the specified user for entities by keyword.]]></wadl:doc> <wadl:request> <wadl:param name="binders" style="query"> <wadl:doc><![CDATA[Whether to include binders in the results.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="files" style="query"> <wadl:doc><![CDATA[Whether to include files in the results.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="folder_entries" style="query"> <wadl:doc><![CDATA[Whether to include folder entries in the results.]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include files and folders that have been hidden by the user.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entity.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the immediate folder (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="replies" style="query"> <wadl:doc><![CDATA[Whether to include replies in the results.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include files and folders that have been not been hidden by the user.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/by_user/{id}/library_files"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the files shared by the specified user.]]></wadl:doc> <wadl:request> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[If true, the path of the parent binder is included in each result.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the binder and sub-binders for files.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/by_user/{id}/library_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the folders shared by the specified user. <p>The <code>title</code> query parameter limits the results to those folders with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/by_user/{id}/recent_activity"> <wadl:method name="GET"> <wadl:doc><![CDATA[List recently changed folder entries shared by the specified user.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entry.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of RecentActivityEntry resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the shares where the recipient is public.]]></wadl:doc> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Share objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public/library_changes"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get changes to files and folders that have occurred in the Public top-level folder since the specified date.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of changes to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to return changes in the immediate folder only (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="since" style="query"> <wadl:doc><![CDATA[UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderChanges resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_changes"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public/library_children"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the files and folders shared publicly. <p>The <code>title</code> query parameter limits the results to those children with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public/library_entities"> <wadl:method name="GET"> <wadl:doc><![CDATA[Search files and folder shared publicly for entities by keyword.]]></wadl:doc> <wadl:request> <wadl:param name="binders" style="query"> <wadl:doc><![CDATA[Whether to include binders in the results.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="files" style="query"> <wadl:doc><![CDATA[Whether to include files in the results.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="folder_entries" style="query"> <wadl:doc><![CDATA[Whether to include folder entries in the results.]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include files and folders that have been hidden by the user.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entity.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the immediate folder (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="replies" style="query"> <wadl:doc><![CDATA[Whether to include replies in the results.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include files and folders that have been not been hidden by the user.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public/library_files"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the files shared publicly.]]></wadl:doc> <wadl:request> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[If true, the path of the parent binder is included in each result.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the binder and sub-binders for files.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public/library_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the folders shared publicly. <p>The <code>title</code> query parameter limits the results to those folders with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public/library_tree"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a tree structure representing the folder structure contained in the Public top-level folder.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderTree]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_tree"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/public/recent_activity"> <wadl:method name="GET"> <wadl:doc><![CDATA[List recently changed folder entries shared publicly.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entry.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of RecentActivityEntry resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the shares where the specified user is the recipient.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Share objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}/library_changes"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get changes to files and folders that have occurred in the user's Share with Me folder since the specified date.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of changes to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to return changes in the immediate folder only (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="since" style="query"> <wadl:doc><![CDATA[UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderChanges resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_changes"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}/library_children"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the files and folders shared with the specified user. <p>The <code>title</code> query parameter limits the results to those children with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}/library_entities"> <wadl:method name="GET"> <wadl:doc><![CDATA[Search files and folder shared with the specified user for entities by keyword.]]></wadl:doc> <wadl:request> <wadl:param name="binders" style="query"> <wadl:doc><![CDATA[Whether to include binders in the results.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="files" style="query"> <wadl:doc><![CDATA[Whether to include files in the results.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="folder_entries" style="query"> <wadl:doc><![CDATA[Whether to include folder entries in the results.]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include files and folders that have been hidden by the user.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entity.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the immediate folder (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="replies" style="query"> <wadl:doc><![CDATA[Whether to include replies in the results.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include files and folders that have been not been hidden by the user.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}/library_files"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the files shared with the specified user.]]></wadl:doc> <wadl:request> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[If true, the path of the parent binder is included in each result.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the binder and sub-binders for files.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}/library_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the folders shared with the specified user. <p>The <code>title</code> query parameter limits the results to those folders with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}/library_tree"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a tree structure representing the folder structure contained the user's Share with Me folder.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderTree]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_tree"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/with_user/{id}/recent_activity"> <wadl:method name="GET"> <wadl:doc><![CDATA[List recently changed folder entries shared with the specified user.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="hidden" style="query"> <wadl:doc><![CDATA[Whether to include hidden shares in the results.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entry.]]></wadl:doc> </wadl:param> <wadl:param name="unhidden" style="query"> <wadl:doc><![CDATA[Whether to include unhidden, or visible, shares in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of RecentActivityEntry resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the specified Share object.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A Share object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="share"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/{id}"> <wadl:method name="POST"> <wadl:doc><![CDATA[Overwrite the specified share. This will not modify the Share's shared entity or recipient. <p>The share will be assigned a new ID. The returned Share object contains the new ID.</p>]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[A Share object containing the new share settings.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the share to overwrite.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> <wadl:param name="notify_address" style="query"> <wadl:doc><![CDATA[An email address to notify, if the recipient type is <code>public_link</code>. May be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="share"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the share to overwrite.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> <wadl:param name="notify_address" style="query"> <wadl:doc><![CDATA[An email address to notify, if the recipient type is <code>public_link</code>. May be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> <wadl:param name="notify_address" style="query"> <wadl:doc><![CDATA[An email address to notify, if the recipient type is <code>public_link</code>. May be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The update SHare object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="share"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="shares/{id}"> <wadl:method name="DELETE"> <wadl:doc><![CDATA[Delete the specified Share.]]></wadl:doc> <wadl:request> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="users/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a user.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include attachments in the returned user or group.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A User resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="user"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="users/{id}/groups"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the groups that the user is a member of.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of GroupBrief resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="users/{id}/password"> <wadl:method name="POST"> <wadl:doc><![CDATA[Change the user's password.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get workspaces by ID.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> <wadl:param name="id" style="query"> <wadl:doc><![CDATA[The ID of a folder. Can be specified multiple times.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of BinderBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the binder with the specified ID.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Configures whether attachments should be included in the returned binder object.]]></wadl:doc> </wadl:param> <wadl:param name="library_info" style="query"> <wadl:doc><![CDATA[Whether to calculate and return binder statistics such as total size on disk.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[Returns a subclass of Binder.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}"> <wadl:method name="PUT"> <wadl:doc><![CDATA[Update a binder.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The new binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to return attachments in the response.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="binder"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to return attachments in the response.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to return attachments in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The updated binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}"> <wadl:method name="DELETE"> <wadl:doc><![CDATA[Delete the specifed binder object. <p>Personal storage folders are moved to the trash by default. <code>purge=true</code> will delete the folder permanently instead. Folders on external storage (net folders, mirrored folders) are always deleted permanantly.</p>]]></wadl:doc> <wadl:request> <wadl:param name="only_if_empty" style="query"> <wadl:doc><![CDATA[Only delete the folder if it is empty.]]></wadl:doc> </wadl:param> <wadl:param name="purge" style="query"> <wadl:doc><![CDATA[Whether the binder will be deleted permanently (true) or moved to the trash (false).]]></wadl:doc> </wadl:param> </wadl:request> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/access"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the rights that the authenticated user has to the binder.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[An Access object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="access"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/ancestry"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get all of the parent binders of the binder. The top workspace is the first item and the immediate parent is the last item. <p>For example, the ancestry of "/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A/B" is: <ul> <li>/Home Workspace</li> <li>/Home Workspace/Personal Workspaces</li> <li>/Home Workspace/Personal Workspaces/Bob Barker (bbarker)</li> <li>/Home Workspace/Personal Workspaces/Bob Barker (bbarker)/A</li> </ul>]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A list of BinderBrief objects.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_brief"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_changes"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get changes to files and folders that have occurred since the specified date.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of changes to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to return changes in the immediate folder only (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="since" style="query"> <wadl:doc><![CDATA[UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderChanges resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_changes"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_children"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the children of a binder. <p>The <code>title</code> query parameter limits the results to those children with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="allow_jits" style="query"> <wadl:doc><![CDATA[Whether to trigger JITS, if applicable.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_entities"> <wadl:method name="GET"> <wadl:doc><![CDATA[Search for entities by keyword.]]></wadl:doc> <wadl:request> <wadl:param name="binders" style="query"> <wadl:doc><![CDATA[Whether to include binders in the results.]]></wadl:doc> </wadl:param> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="files" style="query"> <wadl:doc><![CDATA[Whether to include files in the results.]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="folder_entries" style="query"> <wadl:doc><![CDATA[Whether to include folder entries in the results.]]></wadl:doc> </wadl:param> <wadl:param name="keyword" style="query"> <wadl:doc><![CDATA[A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is allowed but "keyword=*d" is not.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entity.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the immediate folder (false) or all subfolders (true).]]></wadl:doc> </wadl:param> <wadl:param name="replies" style="query"> <wadl:doc><![CDATA[Whether to include replies in the results.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_files"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the child files of a binder.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="file_name" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[If true, the path of the parent binder is included in each result.]]></wadl:doc> </wadl:param> <wadl:param name="recursive" style="query"> <wadl:doc><![CDATA[Whether to search the binder and sub-binders for files.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_folders"> <wadl:method name="GET"> <wadl:doc><![CDATA[List the child folders of a binder. <p>The <code>title</code> query parameter limits the results to those folders with the specified name. Wildcards are not supported.</p>]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the children descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="title" style="query"> <wadl:doc><![CDATA[The name of the child to return,]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of SearchableObjects (BinderBriefs and FileProperties).]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_folders"> <wadl:method name="POST"> <wadl:doc><![CDATA[Copy a folder into the specified binder. <p>The Content-Type must be <code>application/x-www-form-urlencoded</code>. The title value in the form data should be a URL-encoded UTF-8 string. For example: <code>source_id=48&title=H%C3%B6wdy</code>.</p>]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new binder metadata.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_folders"> <wadl:method name="POST"> <wadl:doc><![CDATA[Create a new folder.]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The BinderBrief object to be created. Minimally, you must specify the "title".]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder where the folder should be createad..]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="binder_brief"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the binder where the folder should be createad..]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder description in the response. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The new Folder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="folder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/library_tree"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get a tree structure representing the folder structure contained in this binder.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder descriptions. Can be "html" or "text".]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A BinderTree]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder_tree"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/parent_binder"> <wadl:method name="POST"> <wadl:doc><![CDATA[Move the specified binder. The Content-Type must be <code>application/x-www-form-urlencoded</code>.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include the binder attachments in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The modified binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/recent_activity"> <wadl:method name="GET"> <wadl:doc><![CDATA[List recently changed folder entries in the specified binder.]]></wadl:doc> <wadl:request> <wadl:param name="count" style="query"> <wadl:doc><![CDATA[The maximum number of results to return.]]></wadl:doc> </wadl:param> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the folder entry description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="first" style="query"> <wadl:doc><![CDATA[The index of the first result to return.]]></wadl:doc> </wadl:param> <wadl:param name="parent_binder_paths" style="query"> <wadl:doc><![CDATA[Whether to include the parent binder path with each entry.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of RecentActivityEntry resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/shares"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get information about the users and groups with whom the authenticated user has shared the binder.]]></wadl:doc> <wadl:request> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A SearchResultList of Share resources.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="results"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/shares"> <wadl:method name="POST"> <wadl:doc><![CDATA[Share the binder with another user or group. Minimally, you must specify the Share recipient and access role. <p>If the authenticated user has already shared the folder with the specified recipient, this will overwrite the previous share settings.</p>]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[The share object to create.]]></wadl:doc> <wadl:representation mediaType="application/json"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:representation mediaType="application/xml" element="share"> <wadl:param name="id" style="path"> <wadl:doc><![CDATA[The ID of the folder entry.]]></wadl:doc> </wadl:param> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> </wadl:representation> <wadl:param name="notify" style="query"> <wadl:doc><![CDATA[If true, the recipient will be notified by email.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The newly created Share resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="share"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="workspaces/{id}/title"> <wadl:method name="POST"> <wadl:doc><![CDATA[Rename the specified binder. The Content-Type must be <code>application/x-www-form-urlencoded</code>. The value of the title form parameter in the request body should be a UTF-8 string that has been URL encoded.]]></wadl:doc> <wadl:request> <wadl:param name="description_format" style="query"> <wadl:doc><![CDATA[The desired format for the binder description. Can be "html" or "text".]]></wadl:doc> </wadl:param> <wadl:param name="include_attachments" style="query"> <wadl:doc><![CDATA[Whether to include the binder attachments in the response.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[The modified binder object.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="binder"/> </wadl:response> </wadl:method> </wadl:resource> <wadl:resource path="zone_config"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get system settings.]]></wadl:doc> <wadl:request> <wadl:param name="include_desktop_process_config" style="query"> <wadl:doc><![CDATA[Whether to include desktop application process-blocking configuration.]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> <wadl:doc><![CDATA[A ZoneConfig resource.]]></wadl:doc> <wadl:representation mediaType="application/json"/> <wadl:representation mediaType="application/xml" element="zone_config"/> </wadl:response> </wadl:method> </wadl:resource> </wadl:resources> </wadl:application>