Report Element URLs

This is a reference to the URLs available for working with elements of a report.

In the tables below are indicated the 4.0 and/or 4.1 releases from which each call is supported. The URL must be used with the default base URL value: <webiURL>.

Table 1: Report Elements
Action Method URL Release
Creating a Report Element POST /documents/{documentId}/reports/{reportId}/elements 4.1 SP2
Getting the List of Report Elements GET /documents/{documentId}/reports/{reportId}/elements 4.0 SP6 | 4.1
Getting the Details of a Report Element GET /documents/{documentId}/reports/{reportId}/elements/{elementId} 4.0 SP6 | 4.1
Getting the Background of a Report Element GET /documents/{documentId}/reports/{reportId}/elements/{elementId}/background 4.1 SP5
Getting the Datapaths of a Report Element GET /documents/{documentId}/reports/{reportId}/elements/{elementId}/datapaths 4.1 SP3
Getting the Dataset of a Report Element GET /documents/{documentId}/reports/{reportId}/elements/{elementId}/dataset 4.1 SP3
Exporting a Report Element GET /documents/{documentId}/reports/{reportId}/elements/{elementId} 4.0 SP6 | 4.1
Updating a Report Element PUT /documents/{documentId}/reports/{reportId}/elements/{elementId} 4.1 SP2
Deleting a Report Element DELETE /documents/{documentId}/reports/{reportId}/elements/{elementId} 4.1 SP2
Table 2: Axes of a Report Element
Action Method URL Release
Updating the Expressions of an Axis PUT /documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/expressions 4.1 SP3
Removing the Expressions From an Axis DELETE /documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/expressions 4.1 SP3
Table 3: Custom Properties of a Report Element
Action Method URL Release
Getting the List of Custom Properties GET /documents/{documentId}/reports/{reportId}/elements/{elementId}/properties 4.1 SP3
Getting the Custom Property Value GET /documents/{documentId}/reports/{reportId}/elements/{elementId}/properties/{propertyKey} 4.1 SP3
Adding a Custom Property to a Report Element POST /documents/{documentId}/reports/{reportId}/elements/{elementId}/properties 4.1 SP3
Updating a Custom Property PUT /documents/{documentId}/reports/{reportId}/elements/{elementId}/properties 4.1 SP3
Deleting a Custom Property DELETE /documents/{documentId}/reports/{reportId}/elements/{elementId}/properties/{propertyKey} 4.1 SP3
Table 4: Data Filters of a Report Element
Action Method URL Release
Creating a Data Filter for a Report Element POST /documents/{documentId}/reports/{reportId}/elements/{elementId}/datafilter 4.1 SP2
Getting the Details of a Data Filter for a Report Element GET /documents/{documentId}/reports/{reportId}/elements/{elementId}/datafilter 4.1 SP2
Updating the Data Filter for a Report Element PUT /documents/{documentId}/reports/{reportId}/elements/{elementId}/datafilter 4.1 SP2
Deleting a Data Filter from a Report Element DELETE /documents/{documentId}/reports/{reportId}/elements/{elementId}/datafilter 4.1 SP2
Table 5: Rankings of a Report Element
Action Method URL Release
Creating a Ranking in a Report Element POST /documents/{documentId}/reports/{reportId}/elements/{elementId}/ranking 4.1 SP3
Updating the Ranking of a Report Element PUT /documents/{documentId}/reports/{reportId}/elements/{elementId}/ranking 4.1 SP3
Deleting the Ranking of a Report Element DELETE /documents/{documentId}/reports/{reportId}/elements/{elementId}/ranking 4.1 SP3
Table 6: Table Axes and Breaks
Action Method URL Release
Updating the Sortings of a Table Axis PUT /documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/sorts 4.1 SP3
Removing the Sortings From a Table Axis DELETE /documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/sorts 4.1 SP3
Creating a Table Break POST /documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/breaks 4.1 SP3
Updating a Table Break PUT /documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/breaks/{breakId} 4.1 SP3
Deleting a Table Break DELETE /documents/{documentId}/reports/{reportId}/elements/{elementId}/axes/{axisId}/breaks/{breakId} 4.1 SP3