PUT api/document/setprivacy
Sets the document privacy for an existing document. This is used to change a document from being publicly accessible to being private, and vice versa. Processes this document API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The set document privacy command data contract supplied with the request.
SetDocumentPrivacyCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
The unique identifier of the related document resource. |
integer |
None. |
| SetAsPublic |
Indicates whether set as public is true. |
boolean |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"DocumentId": 1,
"SetAsPublic": true,
"Id": 3
}
Response Information
Resource Description
The response returned after the operation completes.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version |
The version value. |
Version |
None. |
| Content |
The content value. |
HttpContent |
None. |
| StatusCode |
The status code classification. |
HttpStatusCode |
None. |
| ReasonPhrase |
The reason phrase value. |
string |
None. |
| Headers |
The collection of headers. |
Collection of Object |
None. |
| RequestMessage |
The request message value. |
HttpRequestMessage |
None. |
| IsSuccessStatusCode |
Indicates whether this item is success status code. |
boolean |
None. |