Getting Information on the Drill Hierarchies

Obtains the drill hierarchies.

It returns an error if the drill is not activated on this report.

Request

GET <webiURL>/documents/{documentId}/reports/{reportId}/driller/hierarchies

Where:
  • {documentId} is the document identifier retrieved from the list of documents
  • {reportId} is the report identifier retrieved from the list of reports
Response

Response type: application/xml or application/json

Response body: the details of the drill hierarchies.

Example

GET <webiURL>/documents/4567/reports/1/driller/hierarchies

Response:

<hierarchies>
    <hierarchy>
        <id>DP0.DH1</id>
        <name>Resort Hierarchy</name>
        <dataProviderId>DP0</dataProviderId>
        <elements>
            <element>
                <id>DP0.DO39</id>
                <name>Country</name>
                <description></description>
                <filterValue></filterValue>
                <qualification>dimension</qualification>
		      <inQuery>false</inQuery>
                <ambiguous>false</ambiguous>
                <inScope>true</inScope>
            </element>
            <element>
                <id>DP0.DO2</id>
                <name>Resort</name>
                <description></description>  
                <filterValue></filterValue>   
                <qualification>dimension</qualification>
                <inQuery>false</inQuery> 
                <ambiguous>false</ambiguous>  
                <inScope>true</inScope>
            </element>
            <element>
                <id>DP0.DO4</id>
                <name>Service Line</name> 
                <description></description>
                <filterValue></filterValue>
                <qualification>dimension</qualification>
                <inQuery>false</inQuery>
                <ambiguous>false</ambiguous>
                <inScope>true</inScope>
            </element>
            <element>
                <id>DP0.DO5</id>
                <name>Service</name>
                <description></description>
                <filterValue></filterValue>
                <qualification>dimension</qualification>
                <inQuery>false</inQuery>
                <ambiguous>false</ambiguous>
                <inScope>true</inScope>
            </element>
        </elements>
    </hierarchy>
</hierarchies>