Performing a Drill

Performs a drill on a report.

This throws an error if the resource is not created or if the parameters are not valid.

Request

POST <webiURL>/documents/{documentId}/reports/{reportId}/driller/instructions

Where:
  • {documentId} is the document identifier retrieved from the list of documents
  • {reportId} is the report identifier retrieved from the list of reports
Request body: the drill instructions. The drill instructions are made of the following:
  • The instruction type (either "Down", "Up", or "By")
  • The identifier of the report element on which you perform the drill
  • The drill elements on which you perform the drill
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/9512/reports/67/driller/instructions

Request body:

<instruction type="Down">
    <elementId>11</elementId>
    <from>
        <drillElement>
            <id>DP0.DO2</id>
            <filterValue>French Riviera</filterValue>
        </drillElement>
    </from>
    <to>
        <drillElement>
            <id>DP0.DO4</id>
            <hierarchyId>DP0.DH1</hierarchyId>
        </drillElement>
    </to>
</instruction>

Response:

<success>
    <message>The resource of type 'DrillerInstruction' has been successfully created.</message>
    <id>1</id>
</success>