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 Parameters
Parameter Description
reference

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

This results in an additional piece of information called datapath.

unit Specifies the unit of measurement used for all dimensional values such as size, padding, and position. Values are metric (default) , inch and centimeter.
Response:

Response type: application/xml or application/json

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

  • <id>
  • <reference>
  • <parentId>
  • <size>
  • <position>
  • <hide>
  • <padding>
  • <style>
  • <content>
  • type attribute, with the possible values PageZone, Cell, VTable, HTable, XTable, Form, and Visualization.

Example

Cell

GET <webiURL>/documents/6580/reports/1/elements/4?unit=inch

Response:

<element type="Cell">
    <id>4</id>  
    <reference>1.4</reference>  
    <parentId>2</parentId>  
    <size minimalWidth="4.18" minimalHeight="0.43" autofitWidth="false" autofitHeight="true"/>  
    <position x="2.06" y="0.12" horizontalAnchorType="None" verticalAnchorType="None" 
        oneHorizontalPage="false" newHorizontalPage="false" repeatOnEveryVerticalPage="false"
        oneVerticalPage="false" newVerticalPage="false"/>  
    <hide always="false"/>  
    <padding left="0.059" right="0.059" top="0.043" bottom="0.043"/>  
    <style> 
        <border> 
            <top thickness="None" rgb="#000000" style="None"/>  
            <bottom thickness="None" rgb="#000000" style="None"/>  
            <left thickness="None" rgb="#000000" style="None"/>  
            <right thickness="None" rgb="#000000" style="None"/> 
        </border>  
        <background>
            <color rgb="#ff00ff"/>
        </background>
        <font size="16" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#333333"/>  
        <alignment horizontal="Center" vertical="Center" wrapText="false"/> 
    </style>
    <content>
        <expression>
            <formula type="Text" dataType="Numeric">=[帳票_累計(内)_発生]+[帳票_累計(外)_発生]</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/6580/reports/1/elements/1?unit=centimeter

Response:

<element type="PageZone"> 
    <id>1</id>  
    <size minimalHeight="1.4"/>  
    <hide always="false"/>  
    <style> 
        <border> 
            <top thickness="None" rgb="#000000" style="None"/>  
            <bottom thickness="None" rgb="#000000" style="None"/>  
            <left thickness="None" rgb="#000000" style="None"/>  
            <right thickness="None" rgb="#000000" style="None"/> 
        </border>  
        <background> 
            <color rgb="#ffffff"/> 
        </background> 
    </style> 
</element>

Example

Section

GET <webiURL>/documents/6580/reports/1/elements/13?unit=inch

Response:

<element type="Section"> 
    <id>13</id>  
    <reference>1.D</reference>  
    <parentId>2</parentId>  
    <size minimalHeight="0.2"/>  
    <position repeatOnEveryVerticalPage="true" oneVerticalPage="true" newVerticalPage="true"/>  
    <hide always="false"> 
        <expression dataType="Boolean">=Min([Number of guests])=0</expression> 
    </hide>  
    <padding bottom="0.1"/>  
    <style> 
        <background> 
            <color rgb="#ffffce"/> 
        </background> 
    </style>  
    <content> 
        <axes duplicateRowAggregation="true"> 
            <axis role="Row"> 
                <id>0</id>  
                <expressions> 
                    <formula dataType="String" dataObjectId="DP0.DO39">=[Country]</formula> 
                </expressions> 
            </axis> 
        </axes>  
        <emptyHidingBlocks> 
            <child id="14"/>  
            <child id="11"/> 
        </emptyHidingBlocks>  
        <body> 
            <child id="14"/>  
            <child id="11"/> 
        </body> 
    </content> 
</element>

Example

XTable

GET <webiURL>/documents/19035/reports/2/elements/12?unit=centimeter

Response:

<element type="XTable"> 
    <id>12</id>  
    <reference>2.C</reference>  
    <name>Block 1</name>  
    <parentId>1</parentId>  
    <position x="4.894" y="1.376" horizontalAnchorType="None" verticalAnchorType="None" 
        oneHorizontalPage="false" newHorizontalPage="false" repeatOnEveryVerticalPage="false" 
        oneVerticalPage="false" newVerticalPage="false"/>  
    <hide always="false"/>    
    <style> 
        <border> 
            <top thickness="None" rgb="#000000" style="None"/>  
            <bottom thickness="None" rgb="#000000" style="None"/>  
            <left thickness="None" rgb="#000000" style="None"/>  
            <right thickness="None" rgb="#000000" style="None"/> 
        </border>  
        <background width="0.0" height="0.0"/>  
        <alternateColor frequency="2" rgb="#fcfdfd"/> 
    </style>  
    <content> 
        <axes duplicateRowAggregation="true"> 
            <axis role="Row"> 
                <id>0</id>  
                <breaks> 
                    <break onePage="false" newPage="false" sort="true" duplicate="Remove" 
                        repeatHeader="false" showHeader="true" showFooter="true"> 
                        <id>1</id>  
                        <formula dataType="String" dataObjectId="DP0.DO31">=[Year]</formula> 
                    </break> 
                </breaks>  
                <expressions> 
                    <formula dataType="String" dataObjectId="DP0.DO31">=[Year]</formula>  
                    <formula dataType="String" dataObjectId="DP0.DO39">=[Country]</formula> 
                </expressions> 
            </axis>  
            <axis role="Column"> 
                <id>1</id>  
                <expressions> 
                    <formula dataType="String" dataObjectId="DP0.DO2">=[Resort]</formula> 
                </expressions> 
            </axis>  
            <axis role="Body"> 
                <id>2</id>  
                <expressions> 
                    <formula dataType="Numeric" dataObjectId="DP0.DO7">=[Revenue]</formula> 
                </expressions> 
            </axis> 
        </axes>  
        <layout> 
            <zone horizontalType="Body" verticalType="Body"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="5"/> 
            </zone>  
            <zone horizontalType="Body" verticalType="Header"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="8"/> 
            </zone>  
            <zone horizontalType="Body" verticalType="Header" verticalBreakId="1"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="19"/> 
            </zone>  
            <zone horizontalType="Body" verticalType="Footer" verticalBreakId="1"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="24"/>  
                <child row="1" rowSpan="1" column="0" columnSpan="1" id="27"/> 
            </zone>  
            <zone horizontalType="Header" verticalType="Body"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="14"/>  
                <child row="0" rowSpan="1" column="1" columnSpan="1" id="7"/> 
            </zone>  
            <zone horizontalType="Header" verticalType="Header"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="10"/>  
                <child row="0" rowSpan="1" column="1" columnSpan="1" id="11"/> 
            </zone>  
            <zone horizontalType="Header" verticalType="Header" verticalBreakId="1"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="16"/>  
                <child row="0" rowSpan="1" column="1" columnSpan="1" id="17"/> 
            </zone>  
            <zone horizontalType="Header" verticalType="Footer" verticalBreakId="1"> 
                <child row="0" rowSpan="1" column="0" columnSpan="1" id="21"/>  
                <child row="0" rowSpan="1" column="1" columnSpan="1" id="22"/>  
                <child row="1" rowSpan="1" column="0" columnSpan="1" id="25"/>  
                <child row="1" rowSpan="1" column="1" columnSpan="1" id="26"/> 
            </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>

Example

Chart

GET <webiURL>/documents/6503/reports/1/elements/39?unit=inch

<element type="Visualization"> 
    <id>39</id>  
    <reference>1.d</reference>  
    <name>Block 2 (2)</name>  
    <parentId>2</parentId>  
    <size minimalWidth="4.165" minimalHeight="3.125"/>  
    <position x="0.334" y="0.018" oneHorizontalPage="false" newHorizontalPage="false" 
        repeatOnEveryVerticalPage="false" oneVerticalPage="false" newVerticalPage="false"/>  
    <hide always="false"/>  
    <style> 
        <border> 
            <top thickness="None" rgb="#000000" style="None"/>  
            <bottom thickness="None" rgb="#000000" style="None"/>  
            <left thickness="None" rgb="#000000" style="None"/>  
            <right thickness="Thin" rgb="#ff0000" style="Dashed"/> 
        </border>  
        <background> 
            <gradient orientation="Horizontal"> 
                <start alpha="255" rgb="#ffff00"/>  
                <end alpha="255" rgb="#ff00ff"/> 
            </gradient> 
        </background> 
    </style>  
    <content> 
        <chart type="HorizontalBar"> 
            <layout showDimensionsWithEmptyMeasureValues="true" showDimensionsWithMeasuresEqualToZero="false"
                showDimensionsWithSumOfMeasuresEqualToZero="true" showMeasuresWithEmptyDimensionValues="true"
                showParentNodes="true" duplicateRowAggregation="true" horizontal="true"/>  
            <title visible="true"> 
                <style> 
                    <border thickness="None"> 
                        <color alpha="255" rgb="#000000"/> 
                    </border>  
                    <background> 
                        <color alpha="0" rgb="#000000"/> 
                    </background>  
                    <font size="9" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#000000"/>  
                    <alignment horizontal="Left" vertical="Center" textPolicy="Truncate"/> 
                </style>  
                <label dataType="String">="Bar"</label>  
                <layout location="Top" orientation="Auto" spacing="2" adjust="false"/> 
            </title>  
            <legend visible="true"> 
                <style> 
                    <border thickness="None"> 
                        <color alpha="0" rgb="#000000"/> 
                    </border>  
                    <background> 
                        <color alpha="0" rgb="#000000"/> 
                    </background>  
                    <font size="8" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#707070"/>  
                    <alignment horizontal="Left" vertical="Center" textPolicy="Wrap"/> 
                </style>  
                <title visible="true"> 
                    <style> 
                        <border thickness="None"> 
                            <color alpha="255" rgb="#000000"/> 
                        </border>  
                        <background> 
                            <color alpha="0" rgb="#000000"/> 
                        </background>  
                        <font size="8" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#000000"/>  
                        <alignment horizontal="Left" vertical="Center" textPolicy="Truncate"/> 
                    </style>  
                    <layout orientation="Auto" spacing="2"/> 
                </title>  
                <layout groupByDimension="false" symbolSize="9" location="Right" orientation="Auto" spacing="4" adjust="false"/> 
            </legend>  
            <dataLabels type="Auto" visible="false"> 
                <style> 
                    <border thickness="None"> 
                        <color alpha="255" rgb="#000000"/> 
                    </border>  
                    <background> 
                        <color alpha="0" rgb="#000000"/> 
                    </background>  
                    <font size="8" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#707070"/> 
                </style>  
                <layout autoHiding="true" resolveOverlapping="false" position="InsideFirstOutsideOtherwise" orientation="Vertical" spacing="0"/> 
            </dataLabels>  
            <plotArea>
                <barSeries dashedLines="false" spacingBetweenGroups="0.2" spacingWithinGroups="0.2"/> 
                <background mode="Plain"> 
                    <coloring> 
                        <color alpha="0" rgb="#000000"/> 
                    </coloring> 
                </background>  
                <grids> 
                    <grid type="Vertical"> 
                        <color alpha="0" rgb="#000000"/> 
                    </grid>  
                    <grid type="Horizontal"> 
                        <color alpha="255" rgb="#e7e7e7"/> 
                    </grid> 
                </grids>  
            </plotArea>  
            <graphics> 
                <coloring> 
                    <palettes> 
                        <palette alpha="0" refId="green"/> 
                    </palettes> 
                </coloring>  
                <rendering filter="RealLightingAndComplexShadows" look3D="false"> 
                    <edge type="None"/>  
                    <shadow effect="OneSided" xOffset="0.0" yOffset="0.0" filterPassCount="3" filterWindowSize="5" lightPower="0.3"> 
                        <color alpha="187" rgb="#9d9d9d"/> 
                    </shadow> 
                </rendering>  
                <effects> 
                    <barSeries effect="None" roundedCorners="false"/> 
                </effects> 
            </graphics>  
            <axes> 
                <axis role="Color" optional="true"> 
                    <id>0</id>  
                    <name>Region Color</name>  
                    <expressions> 
                        <formula dataType="String" dataObjectId="DP0.DO4">=[Service Line]</formula> 
                    </expressions> 
                </axis>  
                <axis role="Category" visible="true" optional="false"> 
                    <id>1</id>  
                    <name>Category Axis</name>  
                    <title visible="true"> 
                        <style> 
                            <border thickness="None"> 
                                <color alpha="255" rgb="#000000"/> 
                            </border>  
                            <background> 
                                <color alpha="0" rgb="#000000"/> 
                            </background>  
                            <font size="8" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#000000"/> 
                        </style>  
                        <layout spacing="0"/>  
                        <separator>&amp;</separator> 
                    </title>  
                    <layout reverseOrder="false" continuous="false" adjust="false"/>  
                    <coloring> 
                        <color alpha="255" rgb="#707070"/> 
                    </coloring>  
                    <grid> 
                        <color alpha="255" rgb="#dadada"/>  
                        <background> 
                            <color alpha="0" rgb="#000000"/> 
                        </background> 
                    </grid>  
                    <tick length="4" margin="0"/>  
                    <labels visible="true" orientation="Auto" deleteMode="Auto" autoResize="false" staggered="false"> 
                        <font size="8" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#707070"/> 
                    </labels>  
                    <expressions> 
                        <formula dataType="String" dataObjectId="DP0.DO39">=[Country]</formula> 
                    </expressions> 
                </axis>  
                <axis role="Value" visible="true" optional="false"> 
                    <id>2</id>  
                    <name>Value Axis 1</name>  
                    <title visible="true"> 
                        <style> 
                            <border thickness="None"> 
                                <color alpha="255" rgb="#000000"/> 
                            </border>  
                            <background> 
                                <color alpha="0" rgb="#000000"/> 
                            </background>  
                            <font size="8" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#000000"/> 
                        </style>  
                        <layout spacing="0"/>  
                        <separator>&amp;</separator> 
                    </title>  
                    <layout adjust="false"/>  
                    <coloring> 
                        <color alpha="255" rgb="#707070"/> 
                    </coloring>  
                    <tick length="5" margin="4" densityMode="Fixed" density="2"/>  
                    <labels visible="true" orientation="Auto" staggered="false"> 
                        <font size="8" face="Arial" italic="false" bold="true" strikethrough="false" underline="false" rgb="#707070"/> 
                    </labels>  
                    <stacking mode="GloballyStacked" stacked100percent="true"/>  
                    <scaling mode="Linear" originInRange="Always" unitScaleFactor="0" roundMinMaxValues="false"> 
                        <minValue type="Auto"/>  
                        <maxValue type="Auto"/> 
                    </scaling>  
                    <expressions> 
                        <formula regionType="Default" dataType="Numeric" dataObjectId="DP0.DO7">=[Revenue]</formula> 
                    </expressions> 
                </axis> 
            </axes> 
        </chart> 
    </content> 
</element>