Report Drill APIs

The REST APIs to drill through reports in a Web Intelligence document.

The tables below indicate the 4.0 and/or 4.1 release in which support for the API was introduced.

Base URL: http://<server_name>:6405/biprws/raylight/v1

Path parameters:

  • <documentID>: document identifier retrieved from the list of documents
  • <reportID>: report identifier retrieved from the list of reports
  • <filterID>: drill filter identifier retrieved from the list of the drill filters
Table 1: Report Drill
Action Method URL Since
Getting the Drill Mode GET /documents/<documentID>/reports/<reportID>/driller 4.0 SP6 | 4.1
Enabling the Query Drill POST /documents/<documentID>/reports/<reportID>/driller 4.0 SP6 | 4.1
Updating the Drill Mode PUT /documents/<documentID>/reports/<reportID>/driller 4.0 SP6 | 4.1
Disabling the Query Drill DELETE /documents/<documentID>/reports/<reportID>/driller 4.0 SP6 | 4.1
Getting the Free Drill Elements GET /documents/<documentID>/reports/<reportID>/driller/drillelements 4.0 SP6 | 4.1
Getting Information on the Drill Hierarchies GET /documents/<documentID>/reports/<reportID>/driller/hierarchies 4.0 SP6 | 4.1
Performing a Drill POST /documents/<documentID>/reports/<reportID>/driller/instructions 4.0 SP6 | 4.1
Making a Snapshot of a Report in Drill Mode POST /documents/<documentID>/reports/<reportID>/driller/snapshot 4.0 SP6 | 4.1
Table 2: Drill Filters
Action Method URL Since
Creating a Drill Filter POST /documents/<documentID>/reports/<reportID>/driller/filters 4.0 SP6 | 4.1
Getting the Drill Filters of a Report GET /documents/<documentID>/reports/<reportID>/driller/filters 4.0 SP6 | 4.1
Getting the Details of a Drill Filter GET /documents/<documentID>/reports/<reportID>/driller/filters/<filterID> 4.0 SP6 | 4.1
Updating a Drill Filter PUT /documents/<documentID>/reports/<reportID>/driller/filters/<filterID> 4.0 SP6 | 4.1
Removing a Drill Filter DELETE /documents/<documentID>/reports/<reportID>/driller/filters/<filterID> 4.0 SP6 | 4.1