Deleting a Report Element

Usage

You can delete one of the following report elements:

  • Cell (only free cells, not cells in a table)
  • Section
  • Table (VTable, HTable, XTable, and Form)
  • Row or column of a table that contains a given cell
  • Visualization (charts)
Remember
  • The content of that element is also deleted from the report.
  • You cannot delete PageZone elements and table elements of type Cell.
Request

DELETE /documents/<documentID>/reports/<reportID>/elements/<elementID>?strip=<strip>

Where:
  • <strip> is an optional, string parameter that defines the row or column to remove from the table that contains the given cell <elementID>. Values are row or column. This parameter is mandatory if the cell is in the table header or footer. It is not necessary if the cell is in the table body, because the corresponding row or column will be deleted automatically depending on the table type.
Response

Response type: application/xml or application/json

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

Example

Deleting a Table (XML)

DELETE /documents/5022/reports/3/elements/4

<success>
    <message>The resource of type "Report element" with identifier "4" has been successfully deleted.</message>
    <id>4</id>
</success>

Example

Deleting the Row Containing the Given Cell of a Table Header (JSON)

DELETE /documents/5022/reports/3/elements/22?strip=row

{"success":{
    "message":"The resource of type "Report element" with identifier "22" has been successfully deleted.",
    "id":22
    }
}

Example

Deleting the Row Containing the Given Cell of a Table Body (XML)

DELETE /documents/5022/reports/3/elements/23

<success>
    <message>The resource of type "Report element" with identifier "23" has been successfully deleted.</message>
    <id>23</id>
</success>