Update Document Metadata Properties
Submits a request to update (and replace) the metadata properties for a specific Document entity in the Server.
Request takes a JSON Name/Value List as content (the Document ID and the new metadata properties), and on success returns a response containing the result of the request for update/replacement (“true”).
Request
Method Type: |
PUT |
---|---|
URI: | |
Content: | JSON Name/Value List of metadata properties for Document |
Content Type: |
application/json |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Path
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
documentId |
– |
– |
– |
The ID of the Document entity in Server |
Response
Success
The following lists status codes indicative of a successful response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
200 OK |
Result of request to update Document | text/plain | – | Update of Document metadata properties successfully requested (response of “true” for success) |
Error
The following lists status codes indicative of a failed or error response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
401 Unauthorized |
JSON Error specifying error message |
application/json |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication has failed. Response when either:
|
403 Forbidden |
JSON Error specifying error message |
application/json |
– |
Server authentication has succeeded, but user authorization for this specific method has failed. Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges. |
500 |
JSON Error specifying error message |
application/json |
– |
Server error or Document ID mismatch in JSON |