Getting the Details of a Report Element

Gets the details of a specific report element, referenced by its ID.

Request

GET <webiURL>/documents/{documentId}/reports/{reportId}/elements/{elementId}

Where:
  • {documentId} is the document identifier retrieved from the list of documents
  • {reportId} is the report identifier retrieved from the list of reports
  • {elementId} is the element identifier retrieved from the list of elements of a report
Table 1: Optional Parameter
Parameter Description
reference

Specifies an element reference, for example: {elementId}?reference=1.D.7.

This results in an additional piece of information called datapath.

Response:

Response type: application/xml or application/json

Response body: the definition of a report element, with the following information:

  • id
  • name
  • reference
  • type (PageZone, Cell, VTable, etc.)

Example

Cell

GET <webiURL>/documents/9199/reports/154769/elements/289477

Response:

<element type="Cell">
    <id>289477</id>
    <reference>boH.16h5</reference>
    <parentId>289435</parentId>
    <size minimalWidth="4500" minimalHeight="675" autofitWidth="false" autofitHeight="true"/>
    <padding left="75" right="75" top="75" bottom="75"/>
    <style>
        <parentId>19</parentId>
        <border>
            <top thickness="None" rgb="#cacad9" style="None"/>
            <bottom thickness="Thin" rgb="#cacad9" style="Plain"/>
            <left thickness="Thin" rgb="#cacad9" style="Plain"/>
            <right thickness="Thin" rgb="#cacad9" style="Plain"/>
        </border>
        <background>
            <color rgb="#ffffff"/>
        </background>
        <font size="9" face="Gothic" italic="false" bold="false" strikethrough="false" underline="false"/>
        <alignment horizontal="Right" vertical="Center" wrapText="true"/>
    </style>
    <content>
        <expression>
            <formula type="Text" dataType="Numeric">=[report_cumulative (in)_occurence] + 
                [report_cumulative (out)_occurence]</formula>
            <format type="Custom">
                <template positive="#,##0" negative="-#,##0" zero="0" undefined="0"/>
            </format>
        </expression>
        <alerters>
            <id>2</id>
        </alerters>
    </content>
</element>

Example

PageZone
GET <webiURL>/documents/8022/reports/2/elements/1

Response:

<element type="PageZone">
    <id>1</id>
    <size minimalHeight="5358"/>
</element>

Example

Section
GET <webiURL>/documents/8022/reports/2/elements/21

Response:

<element type="Section">
    <id>21</id>
    <reference>1.L</reference>
    <parentId>2</parentId>
    <content>
        <axes duplicateRowAggregation="true">
            <axis role="Row">
                <expressions>
                    <formula dataType="String">=[Year]</formula>
                </expressions>
            </axis>
        </axes>
        <body>
            <child id="22"/>
            <child id="17"/>
        </body>
    </content>
</element>

Example

XTable

GET <webiURL>/documents/9199/reports/1/elements/17

Response:

<element type="XTable">
    <id>17</id>
    <reference>1.H</reference>
    <name>Block 1</name>
    <parentId>21</parentId>
    <position verticalAnchorId="22" verticalAnchorType="End" horizontalAnchorType="None" y="1169" x="450"/>
    <padding bottom="75" top="75" right="75" left="75"/>
    <content>
        <axes duplicateRowAggregation="true">
            <axis role="Row">
                <expressions>
                    <formula dataType="String">=[Lines]</formula>
                </expressions>
                <alternateStyles>
                    <style>
                        <background>
                            <color rgb="#f8fbfc"/>
                        </background>
                        <alignment wrapText="false" vertical="Bottom" horizontal="Left"/>
                        <frequency>2</frequency>
                    </style>
                </alternateStyles>
            </axis>
            <axis role="Column">
                <breaks>
                    <break repeatHeader="false" duplicate="Repeat" sort="true" newPage="false" onePage="false">
                        <id>1</id>
                        <formula dataType="String">=[State]</formula>
                    </break>
                </breaks>
                <expressions>
                    <formula dataType="String">=[State]</formula>
                    <formula dataType="String">=[City]</formula>
                </expressions>
                <alternateStyles>
                    <style>
                        <alignment wrapText="false" vertical="Bottom" horizontal="Left"/>
                        <frequency>2</frequency>
                    </style>
                </alternateStyles>
            </axis>
        </axes>
        <layout>
            <zone verticalType="Body" horizontalType="Body">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="5"/>
            </zone>
            <zone verticalType="Header" horizontalType="Body">
                <child columnSpan="1" column="0" rowSpan="1" row="1" id="8"/>
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="7"/>
            </zone>
            <zone verticalType="Footer" horizontalType="Body">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="35"/>
            </zone>
            <zone verticalType="Body" horizontalType="Header">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="11"/>
            </zone>
            <zone verticalType="Header" horizontalType="Header">
                <child columnSpan="1" column="0" rowSpan="1" row="1" id="16"/>
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="15"/>
            </zone>
            <zone verticalType="Footer" horizontalType="Header">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="42"/>
            </zone>
            <zone verticalType="Body" horizontalType="Footer">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="27"/>
            </zone>
            <zone horizontalBreakId="1" verticalType="Body" horizontalType="Footer">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="25"/>
                <child columnSpan="1" column="1" rowSpan="1" row="0" id="31"/>
            </zone>
            <zone verticalType="Header" horizontalType="Footer">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="29"/>
                <child columnSpan="1" column="0" rowSpan="1" row="1" id="30"/>
            </zone>
            <zone horizontalBreakId="1" verticalType="Header" horizontalType="Footer">
                <child columnSpan="1" column="0" rowSpan="1" row="1" id="14"/>
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="23"/>
                <child columnSpan="1" column="1" rowSpan="1" row="0" id="32"/>
                <child columnSpan="1" column="1" rowSpan="1" row="1" id="33"/>
            </zone>
            <zone verticalType="Footer" horizontalType="Footer">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="37"/>
            </zone>
            <zone horizontalBreakId="1" verticalType="Footer" horizontalType="Footer">
                <child columnSpan="1" column="0" rowSpan="1" row="0" id="39"/>
                <child columnSpan="1" column="1" rowSpan="1" row="0" id="40"/>
            </zone>
        </layout>
    </content>
</element>

Example

Cell with Reference

GET <webiURL>/documents/8362/reports/1/elements/6?reference=1.6.Ga

<element type="Cell">
    <id>6</id>
    <reference>1.6</reference>
    <parentId>11</parentId>
    <datapath>DP0.DO1:"Robert King"|"0000000007",DP0.DO10:" 6561 - Centre Sport"|"0000006561"</datapath>
    ...
</element>