Getting the Map of a Report

Usage

Gets the map of a report in a Web Intelligence document.

The map of a report is the list of all the instances of a report element in the document.

Request

GET /documents/<documentID>/reports/<reportID>/map?reference=<nodeReference>

Where:
  • <nodeReference> is a valid reference of a map node (optional)
Response

Response type: application/xml or application/json

Response body: the node references of the report map.

Example

Getting the Full Map References of a Report

GET /documents/18809/reports/1/map

Response:

<map>  
    <node reference="1.G.0" name="2004"/> 
    <node reference="1.G.1" name="2005"/> 
    <node reference="1.G.2" name="2006"/>
</map>

Example

Getting the Map Reference of a Node of a Report

Once you have obtained the list of node references for a report, you can use this example to get a specific map reference for a node.

GET /documents/18809/reports/1/map?reference=1.G.1

Response:

<map>  
    <node reference="1.5.1.0" name="California"/> 
    <node reference="1.5.1.1" name="Colorado"/>
    <node reference="1.5.1.2" name="DC"/> 
    <node reference="1.5.1.3" name="Florida"/> 
    <node reference="1.5.1.4" name="Illinois"/> 
    <node reference="1.5.1.5" name="Massachusetts"/> 
    <node reference="1.5.1.6" name="New York"/> 
    <node reference="1.5.1.7" name="Texas"/>
</map>