Updating a Custom Property

Changes the value of the specified custom property of a report element.

Request

PUT <webiURL>/documents/{documentId}/reports/{reportId}/elements/{elementId}/properties

Where:
  • {documentId} is the document identifier retrieved from the list of documents
  • {reportId} is the report identifier retrieved from the list of reports
  • {elementId} is the element identifier retrieved from the list of elements

Request body: the custom property to edit (key and value).

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/1234/reports/1/elements/100/properties

Request body:

<property key='NEW_KEY'>Modified Value</property>

Response:

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