Deleting a Custom Property

Deletes a custom property from a report element.

Request

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

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
  • {propertyKey} is the key of the custom property to delete
Response

Response type: application/xml or application/json

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

Example

DELETE <webiURL>/documents/1234/reports/1/elements/100/properties/MYKEY

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