Updating the Properties of a Document

Updates the properties of a Web Intelligence document referenced by its identifier.

Note Certain settings are attributed automatically and cannot be set manually (for example, the last refresh time).
Request

PUT <webiURL>/documents/{documentId}/properties

Where:
  • {documentId} is the document identifier retrieved from the list of documents

Request body:

<properties>    
    <property key="...">
Response

Response type: application/xml or application/json

The response is a message stating the success or failure of the request.

Example

PUT <webiURL>/documents/9939/properties

With the following body in an XML file:

<properties>    
    <property key="refreshonopen">true</property>
</properties>

Response:

<success>
    <message>The resource of type 'properties' has been successfully updated.</message> 
    <id>9939</id>
</success>