Gets the datapaths available for a report element.
A datapath allows you to find a specific instance of a report element that can be used for example in several sections, or to find a specific report element of type cell in a table. The datapath may also be used to export a report element or to get its associated data.
GET <webiURL>/documents/{documentId}/reports/{reportId}/elements/{elementId}/datapaths?[parameters]
Parameter | |
---|---|
datapath | A string that specifies an initial datapath needed to get to the next level, for example datapaths?datapath=DP0.DO18:"FY93". |
reference | A string that specifies a reference, for example datapaths?reference=1.D.7. |
Response type: application/xml or application/json
GET <webiURL>/documents/8413/reports/1/elements/20/datapaths
Response:
<datapaths elementId="17"> <datapath>DP0.DObc:"2004"</datapath> <datapath>DP0.DObc:"2005"</datapath> <datapath>DP0.DObc:"2006"</datapath> </datapaths>
GET <webiURL>/documents/8413/reports/1/elements/17/datapaths?datapath=DP0.DObc:"2006"
Response:
<datapaths elementId="10"> <datapath>DP0.DObc:"2006",DP0.DOda:"California"</datapath> <datapath>DP0.DObc:"2006",DP0.DOda:"Colorado"</datapath> <datapath>DP0.DObc:"2006",DP0.DOda:"DC"</datapath> <datapath>DP0.DObc:"2006",DP0.DOda:"Florida"</datapath> <datapath>DP0.DObc:"2006",DP0.DOda:"Illinois"</datapath> <datapath>DP0.DObc:"2006",DP0.DOda:"Massachusetts"</datapath> <datapath>DP0.DObc:"2006",DP0.DOda:"New York"</datapath> <datapath>DP0.DObc:"2006",DP0.DOda:"Texas"</datapath> </datapaths>
GET <webiURL>/documents/8413/reports/1/elements/10/datapaths?reference=1.5.2.7
Response:
<datapaths elementId="11"> <datapath>DP0.DOa5:"Accessories"</datapath> <datapath>DP0.DOa5:"City Skirts"</datapath> <datapath>DP0.DOa5:"City Trousers"</datapath> <datapath>DP0.DOa5:"Dresses"</datapath> <datapath>DP0.DOa5:"Jackets"</datapath> <datapath>DP0.DOa5:"Leather"</datapath> <datapath>DP0.DOa5:"Outerwear"</datapath> <datapath>DP0.DOa5:"Overcoats"</datapath> <datapath>DP0.DOa5:"Shirt Waist"</datapath> <datapath>DP0.DOa5:"Sweaters"</datapath> <datapath>DP0.DOa5:"Sweat-T-Shirts"</datapath> <datapath>DP0.DOa5:"Trousers"</datapath> </datapaths>
This returns an error:
<error> <error_code>101</error_code> <message>The resource of type 'Report element' with identifier '16' contains datapaths: one must be specified.</message> </error>
This returns:
<datapaths elementId="5"> <datapath>DP0.DO18:"FY92"</datapath> <datapath>DP0.DO18:"FY93"</datapath> <datapath>DP0.DO18:"FY94"</datapath> <datapath>DP0.DO18:"FY95"</datapath> </datapaths>
<datapaths elementId="8"> <datapath>DP0.DO18:"FY92",DP0.DO1a:"Q1"</datapath> <datapath>DP0.DO18:"FY92",DP0.DO1a:"Q2"</datapath> <datapath>DP0.DO18:"FY92",DP0.DO1a:"Q3"</datapath> <datapath>DP0.DO18:"FY92",DP0.DO1a:"Q4"</datapath> </datapaths>
<datapaths/>
<dataset> <data id="Category" type="String"> <label>Month</label> <value>Feb</value> </data> <data id="Value" type="Numeric"> <label>Revenue</label> <value>291190</value> </data> </dataset>