Creating a Table Break

Creates a break in the specified axis of a report element of type table.

Restriction You cannot create breaks in the following cases:
  • In a Form table
  • In the body of an XTable
Request

POST <webiURL>/documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/breaks

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 of a report
  • {axisId} is the axis identifier

A table of type HTable or Form has only one axis with identifier 0 that represents a row. A table of type VTable has one axis with identifier 1 that represents a column. A table of type XTable has 3 axes with identifiers 0 for the row, 1 for the column, and 2 for the body.

Request body: the details of the break.

Response

Response type: application/xml or application/json

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

Example

POST <webiURL>/documents/17230/reports/3/elements/8/axes/0/breaks

Request body:

<break onePage="true" newPage="true" sort="false" duplicate="Repeat" repeatHeader="true" showHeader="true" showFooter="false">
    <formula dataType="String">=[Year]</formula>
</break>
Response:
<success>
    <message>The resource of type 'Break' with identifier '1' has been successfully created.</message>
    <id>1</id>
</success>