#API Delegation ## BasePath: http://localhost:8080/linshare/webservice/rest/delegation ## Api Version: v1 ## Resources ### 0. /rest/delegation/{ownerUuid}/documents #### Overview #### 0. `/{ownerUuid}/documents/{uuid}` ##### 0..0 find **GET** `/{ownerUuid}/documents/{uuid}` Get a document. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [Document](#Document) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 0..0 delete **DELETE** `/{ownerUuid}/documents/{uuid}` Delete a document. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 0..0 update **PUT** `/{ownerUuid}/documents/{uuid}` Update a document. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/{uuid} ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>false</td> <td>The documentDto with updated values.</td> <td><a href="#Document">Document</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [Document](#Document) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 0. `/{ownerUuid}/documents/` ##### 0..0 create **POST** `/{ownerUuid}/documents/` Create a document which will contain the uploaded file. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>File stream.</td> <td><a href="#java.io.InputStream">java.io.InputStream</a></td> </tr> <tr> <th>body</th> <td>false</td> <td>An optional description of a document.</td> <td>string</td> </tr> <tr> <th>body</th> <td>false</td> <td>The given file name of the uploaded file.</td> <td>string</td> </tr> <tr> <th>body</th> <td>true</td> <td>The given attachment datas.</td> <td><a href="#MultipartBody">MultipartBody</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Document](#Document) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 0..0 delete **DELETE** `/{ownerUuid}/documents/` Delete a document. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>The document to delete.</td> <td><a href="#Document">Document</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 0..0 findAll **GET** `/{ownerUuid}/documents/` Get all documents. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/ ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Set[Document]](#Set[Document]) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 0. `/{ownerUuid}/documents/{uuid}/download` ##### 0..0 download **GET** `/{ownerUuid}/documents/{uuid}/download` Download a file. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/{uuid}/download ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 0. `/{ownerUuid}/documents/{uuid}/thumbnail` ##### 0..0 thumbnail **GET** `/{ownerUuid}/documents/{uuid}/thumbnail` Download the thumbnail of a file. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/{uuid}/thumbnail ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 0. `/{ownerUuid}/documents/{uuid}/upload` ##### 0..0 updateFile **PUT** `/{ownerUuid}/documents/{uuid}/upload` Update the file inside the document. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/documents/{uuid}/upload ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>File stream.</td> <td><a href="#java.io.InputStream">java.io.InputStream</a></td> </tr> <tr> <th>body</th> <td>true</td> <td>The given file name of the uploaded file.</td> <td>string</td> </tr> <tr> <th>body</th> <td>true</td> <td>The given datas.</td> <td><a href="#MultipartBody">MultipartBody</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [Document](#Document) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ### 1. /rest/delegation/{ownerUuid}/threads #### Overview #### 1. `/{ownerUuid}/threads/{uuid}` ##### 1..0 find **GET** `/{ownerUuid}/threads/{uuid}` Get a thread. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [Thread](#Thread) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 1..0 delete **DELETE** `/{ownerUuid}/threads/{uuid}` Delete a thread. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 1..0 update **PUT** `/{ownerUuid}/threads/{uuid}` Update a thread. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{uuid} ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>Thread to create.</td> <td><a href="#Thread">Thread</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 1. `/{ownerUuid}/threads/` ##### 1..0 create **POST** `/{ownerUuid}/threads/` Create a thread. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>Thread to create.</td> <td><a href="#Thread">Thread</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Thread](#Thread) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 1..0 delete **DELETE** `/{ownerUuid}/threads/` Delete a thread. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>Thread to delete.</td> <td><a href="#Thread">Thread</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 1..0 findAll **GET** `/{ownerUuid}/threads/` Get all threads. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/ ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Set[Thread]](#Set[Thread]) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ### 2. /rest/delegation/users #### Overview #### 2. `/users/{mail}` ##### 2..0 getUser **GET** `/users/{mail}` Find a user. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/users/{mail} ###### Parameters - query <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>domainId</th> <td>false</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>mail</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Set[GenericUser]](#Set[GenericUser]) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ### 3. /rest/delegation/{ownerUuid}/guests #### Overview #### 3. `/{ownerUuid}/guests/{identifier}` ##### 3..0 get **GET** `/{ownerUuid}/guests/{identifier}` Get a guest. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/guests/{identifier} ###### Parameters - query <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>mail</th> <td>false</td> <td>Domain identifier. Restrict the search to a specific domain and its children.</td> <td>boolean</td> </tr> <tr> <th>domain</th> <td>false</td> <td>Domain identifier. Restrict the search to a specific domain and its children.</td> <td>string</td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>identifier</th> <td>true</td> <td>The guest identifier, could be uuid or mail.</td> <td>string</td> </tr> </table> ###### Response [Guest](#Guest) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 3. `/{ownerUuid}/guests/` ##### 3..0 create **POST** `/{ownerUuid}/guests/` Create a guest. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/guests/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>Guest to create.</td> <td><a href="#Guest">Guest</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Guest](#Guest) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 3..0 delete **DELETE** `/{ownerUuid}/guests/` Delete a guest. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/guests/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>Guest to delete.</td> <td><a href="#Guest">Guest</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or guest not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 3..0 update **PUT** `/{ownerUuid}/guests/` Update a guest. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/guests/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>Guest to update.</td> <td><a href="#Guest">Guest</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Guest](#Guest) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or guest not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 3..0 getAll **GET** `/{ownerUuid}/guests/` Get all guests. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/guests/ ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [Set[Guest]](#Set[Guest]) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 3. `/{ownerUuid}/guests/{uuid}` ##### 3..0 delete **DELETE** `/{ownerUuid}/guests/{uuid}` Delete a guest. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/guests/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The guest uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or guest not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ### 4. /rest/delegation/{ownerUuid}/shares #### Overview #### 4. `/{ownerUuid}/shares/` ##### 4..0 create **POST** `/{ownerUuid}/shares/` Create a share. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/shares/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>false</td> <td></td> <td><a href="#ShareCreationDto">ShareCreationDto</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ### 5. /rest/delegation/{ownerUuid}/threads/{threadUuid}/entries #### Overview #### 5. `/{ownerUuid}/threads/{threadUuid}/entries/{uuid}` ##### 5..0 find **GET** `/{ownerUuid}/threads/{threadUuid}/entries/{uuid}` Get a thread entry. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The thread entry uuid.</td> <td>string</td> </tr> </table> ###### Response [ThreadEntry](#ThreadEntry) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 5..0 delete **DELETE** `/{ownerUuid}/threads/{threadUuid}/entries/{uuid}` Delete a thread entry. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The thread entry uuid to delete.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread entry not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 5. `/{ownerUuid}/threads/{threadUuid}/entries/` ##### 5..0 create **POST** `/{ownerUuid}/threads/{threadUuid}/entries/` Create a thread entry which will contain the uploaded file. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>File stream.</td> <td><a href="#java.io.InputStream">java.io.InputStream</a></td> </tr> <tr> <th>body</th> <td>false</td> <td>An optional description of a thread entry.</td> <td>string</td> </tr> <tr> <th>body</th> <td>true</td> <td>The given file name of the uploaded file.</td> <td>string</td> </tr> <tr> <th>body</th> <td>false</td> <td></td> <td><a href="#MultipartBody">MultipartBody</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [ThreadEntry](#ThreadEntry) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 5..0 delete **DELETE** `/{ownerUuid}/threads/{threadUuid}/entries/` Delete a thread entry. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>The thread entry to delete.</td> <td><a href="#ThreadEntry">ThreadEntry</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread entry not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 5..0 findAll **GET** `/{ownerUuid}/threads/{threadUuid}/entries/` Get all thread entries. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/ ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [Set[ThreadEntry]](#Set[ThreadEntry]) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 5. `/{ownerUuid}/threads/{threadUuid}/entries/copy` ##### 5..0 copy **POST** `/{ownerUuid}/threads/{threadUuid}/entries/copy` Create a thread entry which will contain the uploaded file. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/copy ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> <tr> <th>entryUuid</th> <td>true</td> <td>The document entry uuid.</td> <td>string</td> </tr> </table> ###### Response [ThreadEntry](#ThreadEntry) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 5. `/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}` ##### 5..0 update **PUT** `/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}` Update the thread entry properties. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid} ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>The Thread Entry.</td> <td><a href="#ThreadEntry">ThreadEntry</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 5. `/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}/download` ##### 5..0 download **GET** `/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}/download` Download a file. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}/download ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The thread entry uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 5. `/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}/thumbnail` ##### 5..0 thumbnail **GET** `/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}/thumbnail` Download the thumbnail of a file. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/entries/{ownerUuid}/documents/{uuid}/thumbnail ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The document uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ### 6. /rest/delegation/authentication #### Overview #### 6. `/authentication/authorized` ##### 6..0 isAuthorized **GET** `/authentication/authorized` Check if user is authorized. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/authentication/authorized ###### Parameters ###### Response [Account](#Account) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> </table> - - - #### 6. `/authentication/` ##### 6..0 noop **GET** `/authentication/` No operation. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/authentication/ ###### Parameters ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> </table> - - - #### 6. `/authentication/change_password` ##### 6..0 changePassword **POST** `/authentication/change_password` Change the password of the current user. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/authentication/change_password ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>New password.</td> <td><a href="#Password">Password</a></td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>User isn&#39;t a super admin.</td> </tr> </table> - - - #### 6. `/authentication/logout` ##### 6..0 logout **GET** `/authentication/logout` Logout the current user. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/authentication/logout ###### Parameters ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> </table> - - - ### 7. /rest/delegation/{ownerUuid}/threads/{threadUuid}/members #### Overview #### 7. `/{ownerUuid}/threads/{threadUuid}/members/` ##### 7..0 create **POST** `/{ownerUuid}/threads/{threadUuid}/members/` Create a thread member. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/members/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>The user domain identifier.</td> <td><a href="#ThreadMember">ThreadMember</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [ThreadMember](#ThreadMember) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 7..0 delete **DELETE** `/{ownerUuid}/threads/{threadUuid}/members/` Delete a thread member. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/members/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>The thread member to delete.</td> <td><a href="#ThreadMember">ThreadMember</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread member not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 7..0 update **PUT** `/{ownerUuid}/threads/{threadUuid}/members/` Update a thread member. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/members/ ###### Parameters - body <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>body</th> <td>true</td> <td>The thread member to update.</td> <td><a href="#ThreadMember">ThreadMember</a></td> </tr> </table> - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [ThreadMember](#ThreadMember) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread member not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ##### 7..0 findAll **GET** `/{ownerUuid}/threads/{threadUuid}/members/` Get all thread members. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/members/ ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> </table> ###### Response [Set[ThreadMember]](#Set[ThreadMember]) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - #### 7. `/{ownerUuid}/threads/{threadUuid}/members/{uuid}` ##### 7..0 delete **DELETE** `/{ownerUuid}/threads/{threadUuid}/members/{uuid}` Delete a thread member. ###### URL http://localhost:8080/linshare/webservice/rest/delegation/{ownerUuid}/threads/{threadUuid}/members/{uuid} ###### Parameters - path <table border="1"> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> <th>Data Type</th> </tr> <tr> <th>ownerUuid</th> <td>true</td> <td>The owner (user) uuid.</td> <td>string</td> </tr> <tr> <th>threadUuid</th> <td>true</td> <td>The thread uuid.</td> <td>string</td> </tr> <tr> <th>uuid</th> <td>true</td> <td>The user uuid.</td> <td>string</td> </tr> </table> ###### Response [](#) ###### Errors <table border="1"> <tr> <th>Status Code</th> <th>Reason</th> </tr> <tr> <td>403</td> <td>Current logged in account does not have the delegation role.</td> </tr> <tr> <td>404</td> <td>Owner or thread member not found.</td> </tr> <tr> <td>400</td> <td>Bad request : missing required fields.</td> </tr> <tr> <td>500</td> <td>Internal server error.</td> </tr> </table> - - - ## Data Types ## <a name="Account">Account</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>mail</td> <td>string</td> <td>optional</td> <td>-</td> <td>Mail</td> <td>Mail</td> </tr> <tr> <td>domain</td> <td>string</td> <td>optional</td> <td>-</td> <td>Domain</td> <td>Domain</td> </tr> <tr> <td>name</td> <td>string</td> <td>optional</td> <td>-</td> <td>Name</td> <td>Name</td> </tr> <tr> <td>locale</td> <td><a href="#SupportedLanguage">SupportedLanguage</a></td> <td>optional</td> <td>-</td> <td>Locale</td> <td>Locale</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>Uuid</td> <td>Uuid</td> </tr> </table> ## <a name="Attachment">Attachment</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>object</td> <td><a href="#Object">Object</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>dataHandler</td> <td><a href="#DataHandler">DataHandler</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>contentDisposition</td> <td><a href="#ContentDisposition">ContentDisposition</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>contentType</td> <td><a href="#MediaType">MediaType</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>contentId</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>headers</td> <td><a href="#javax.ws.rs.core.MultivaluedMap&lt;java.lang.String, java.lang.String&gt;">javax.ws.rs.core.MultivaluedMap&lt;java.lang.String, java.lang.String&gt;</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="CommandInfo">CommandInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>commandName</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>commandClass</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="ContentDisposition">ContentDisposition</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>parameters</td> <td><a href="#Map[string,string]">Map[string,string]</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>type</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="DataFlavor">DataFlavor</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>representationClassByteBuffer</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>representationClassSerializable</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>representationClassInputStream</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>defaultRepresentationClassAsString</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>primaryType</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>representationClassReader</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>mimeTypeSerializedObject</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>representationClassRemote</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>subType</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>flavorJavaFileListType</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>representationClassCharBuffer</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>flavorTextType</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>flavorSerializedObjectType</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>humanPresentableName</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>mimeType</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>flavorRemoteObjectType</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="DataHandler">DataHandler</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>allCommands</td> <td><a href="#CommandInfo">Array[CommandInfo]</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>preferredCommands</td> <td><a href="#CommandInfo">Array[CommandInfo]</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>name</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>dataSource</td> <td><a href="#DataSource">DataSource</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>content</td> <td><a href="#Object">Object</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>transferDataFlavors</td> <td><a href="#DataFlavor">Array[DataFlavor]</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>outputStream</td> <td><a href="#OutputStream">OutputStream</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>contentType</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>inputStream</td> <td><a href="#InputStream">InputStream</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="DataSource">DataSource</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>name</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>outputStream</td> <td><a href="#OutputStream">OutputStream</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>contentType</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>inputStream</td> <td><a href="#InputStream">InputStream</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="Document">Document</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>creationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>CreationDate</td> <td>CreationDate</td> </tr> <tr> <td>type</td> <td>string</td> <td>optional</td> <td>-</td> <td>Type</td> <td>Type</td> </tr> <tr> <td>sha256sum</td> <td>string</td> <td>optional</td> <td>-</td> <td>Sha256sum</td> <td>Sha256sum</td> </tr> <tr> <td>owner</td> <td><a href="#GenericUser">GenericUser</a></td> <td>optional</td> <td>-</td> <td>Owner</td> <td>Owner</td> </tr> <tr> <td>modificationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>ModificationDate</td> <td>ModificationDate</td> </tr> <tr> <td>description</td> <td>string</td> <td>optional</td> <td>-</td> <td>Description</td> <td>Description</td> </tr> <tr> <td>size</td> <td>long</td> <td>optional</td> <td>-</td> <td>Size</td> <td>Size</td> </tr> <tr> <td>expirationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>ExpirationDate</td> <td>ExpirationDate</td> </tr> <tr> <td>name</td> <td>string</td> <td>optional</td> <td>-</td> <td>Name</td> <td>Name</td> </tr> <tr> <td>metaData</td> <td>string</td> <td>optional</td> <td>-</td> <td>MetaData</td> <td>MetaData</td> </tr> <tr> <td>ciphered</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>Ciphered</td> <td>Ciphered</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>Uuid</td> <td>Uuid</td> </tr> </table> ## <a name="GenericUser">GenericUser</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>lastName</td> <td>string</td> <td>optional</td> <td>-</td> <td>LastName</td> <td>LastName</td> </tr> <tr> <td>mail</td> <td>string</td> <td>optional</td> <td>-</td> <td>Mail</td> <td>Mail</td> </tr> <tr> <td>domain</td> <td>string</td> <td>optional</td> <td>-</td> <td>Domain identifier</td> <td>Domain identifier</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>User uuid</td> <td>User uuid</td> </tr> <tr> <td>firstName</td> <td>string</td> <td>optional</td> <td>-</td> <td>FirstName</td> <td>FirstName</td> </tr> </table> ## <a name="Guest">Guest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>lastName</td> <td>string</td> <td>optional</td> <td>-</td> <td>LastName</td> <td>LastName</td> </tr> <tr> <td>comment</td> <td>string</td> <td>optional</td> <td>-</td> <td>Comment</td> <td>Comment</td> </tr> <tr> <td>mail</td> <td>string</td> <td>optional</td> <td>-</td> <td>Mail</td> <td>Mail</td> </tr> <tr> <td>creationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>CreationDate</td> <td>CreationDate</td> </tr> <tr> <td>domain</td> <td>string</td> <td>optional</td> <td>-</td> <td>Domain</td> <td>Domain</td> </tr> <tr> <td>canUpload</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>CanUpload</td> <td>CanUpload</td> </tr> <tr> <td>owner</td> <td><a href="#GenericUser">GenericUser</a></td> <td>optional</td> <td>-</td> <td>Owner</td> <td>Owner</td> </tr> <tr> <td>modificationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>ModificationDate</td> <td>ModificationDate</td> </tr> <tr> <td>expirationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>Expiration date</td> <td>Expiration date</td> </tr> <tr> <td>restricted</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>Restricted</td> <td>Restricted</td> </tr> <tr> <td>locale</td> <td><a href="#SupportedLanguage">SupportedLanguage</a></td> <td>optional</td> <td>-</td> <td>Locale</td> <td>Locale</td> </tr> <tr> <td>externalMailLocale</td> <td><a href="#Language">Language</a></td> <td>optional</td> <td>-</td> <td>ExternalMailLocale</td> <td>ExternalMailLocale</td> </tr> <tr> <td>restrictedContacts</td> <td><a href="#GenericUser">Array[GenericUser]</a></td> <td>optional</td> <td>-</td> <td>RestrictedContacts</td> <td>RestrictedContacts</td> </tr> <tr> <td>firstName</td> <td>string</td> <td>optional</td> <td>-</td> <td>FirstName</td> <td>FirstName</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>Uuid</td> <td>Uuid</td> </tr> </table> ## <a name="MediaType">MediaType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>parameters</td> <td><a href="#Map[string,string]">Map[string,string]</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>wildcardType</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>type</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>wildcardSubtype</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>subtype</td> <td>string</td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="MultipartBody">MultipartBody</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>allAttachments</td> <td><a href="#Attachment">Array[Attachment]</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>type</td> <td><a href="#MediaType">MediaType</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>childAttachments</td> <td><a href="#Attachment">Array[Attachment]</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> <tr> <td>rootAttachment</td> <td><a href="#Attachment">Attachment</a></td> <td>optional</td> <td>-</td> <td>-</td> <td>-</td> </tr> </table> ## <a name="Password">Password</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>oldPwd</td> <td>string</td> <td>optional</td> <td>-</td> <td>Old</td> <td>Old</td> </tr> <tr> <td>newPwd</td> <td>string</td> <td>optional</td> <td>-</td> <td>new</td> <td>new</td> </tr> </table> ## <a name="ShareCreationDto">ShareCreationDto</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>expirationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>ExpirationDate</td> <td>ExpirationDate</td> </tr> <tr> <td>message</td> <td>string</td> <td>optional</td> <td>-</td> <td>Message</td> <td>Message</td> </tr> <tr> <td>secured</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>Secured</td> <td>Secured</td> </tr> <tr> <td>documents</td> <td>Array[string]</td> <td>optional</td> <td>-</td> <td>Document uuids</td> <td>Document uuids</td> </tr> <tr> <td>recipients</td> <td><a href="#GenericUser">Array[GenericUser]</a></td> <td>optional</td> <td>-</td> <td>Recipients</td> <td>Recipients</td> </tr> <tr> <td>subject</td> <td>string</td> <td>optional</td> <td>-</td> <td>Subject</td> <td>Subject</td> </tr> </table> ## <a name="Thread">Thread</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>creationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>CreationDate</td> <td>CreationDate</td> </tr> <tr> <td>domain</td> <td>string</td> <td>optional</td> <td>-</td> <td>Domain</td> <td>Domain</td> </tr> <tr> <td>modificationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>ModificationDate</td> <td>ModificationDate</td> </tr> <tr> <td>members</td> <td><a href="#ThreadMember">Array[ThreadMember]</a></td> <td>optional</td> <td>-</td> <td>Members</td> <td>Members</td> </tr> <tr> <td>name</td> <td>string</td> <td>optional</td> <td>-</td> <td>Name</td> <td>Name</td> </tr> <tr> <td>externalMailLocale</td> <td><a href="#Language">Language</a></td> <td>optional</td> <td>-</td> <td>ExternalMailLocale</td> <td>ExternalMailLocale</td> </tr> <tr> <td>locale</td> <td><a href="#SupportedLanguage">SupportedLanguage</a></td> <td>optional</td> <td>-</td> <td>Locale</td> <td>Locale</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>Uuid</td> <td>Uuid</td> </tr> </table> ## <a name="ThreadEntry">ThreadEntry</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>creationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>CreationDate</td> <td>CreationDate</td> </tr> <tr> <td>type</td> <td>string</td> <td>optional</td> <td>-</td> <td>Type</td> <td>Type</td> </tr> <tr> <td>sha256sum</td> <td>string</td> <td>optional</td> <td>-</td> <td>Sha256sum</td> <td>Sha256sum</td> </tr> <tr> <td>modificationDate</td> <td>Date</td> <td>optional</td> <td>-</td> <td>ModificationDate</td> <td>ModificationDate</td> </tr> <tr> <td>description</td> <td>string</td> <td>optional</td> <td>-</td> <td>Description</td> <td>Description</td> </tr> <tr> <td>size</td> <td>long</td> <td>optional</td> <td>-</td> <td>Size</td> <td>Size</td> </tr> <tr> <td>name</td> <td>string</td> <td>optional</td> <td>-</td> <td>Name</td> <td>Name</td> </tr> <tr> <td>metaData</td> <td>string</td> <td>optional</td> <td>-</td> <td>MetaData</td> <td>MetaData</td> </tr> <tr> <td>ciphered</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>Ciphered</td> <td>Ciphered</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>Uuid</td> <td>Uuid</td> </tr> </table> ## <a name="ThreadMember">ThreadMember</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>access</th> <th>description</th> <th>notes</th> </tr> <tr> <td>lastName</td> <td>string</td> <td>optional</td> <td>-</td> <td>LastName</td> <td>LastName</td> </tr> <tr> <td>role</td> <td>string</td> <td>optional</td> <td>-</td> <td>Role</td> <td>Role</td> </tr> <tr> <td>readonly</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>Readonly</td> <td>Readonly</td> </tr> <tr> <td>admin</td> <td>boolean</td> <td>optional</td> <td>-</td> <td>Admin</td> <td>Admin</td> </tr> <tr> <td>threadUuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>ThreadUuid</td> <td>ThreadUuid</td> </tr> <tr> <td>userDomainId</td> <td>string</td> <td>optional</td> <td>-</td> <td>UserDomainId</td> <td>UserDomainId</td> </tr> <tr> <td>userUuid</td> <td>string</td> <td>optional</td> <td>-</td> <td>UserUuid</td> <td>UserUuid</td> </tr> <tr> <td>userMail</td> <td>string</td> <td>optional</td> <td>-</td> <td>UserMail</td> <td>UserMail</td> </tr> <tr> <td>firstName</td> <td>string</td> <td>optional</td> <td>-</td> <td>FirstName</td> <td>FirstName</td> </tr> <tr> <td>id</td> <td>long</td> <td>optional</td> <td>-</td> <td>Id</td> <td>Id</td> </tr> </table>