Getting the List of Report Elements

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

Request

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

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 list of elements of the report, with the following information:

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

Example

To get the elements of report 2 of document ID 1224

GET <webiURL>/documents/1224/reports/2

Response:

<elements>
    <element type="PageZone">
        <id>1</id>
        <name>Header</name>
        <size minimalHeight="1984"/>
    </element>
    <element type="Cell">
        <id>12</id>
        <reference>UIREF:V=1:RID=1:BID=12</reference>
        <parentId>15</parentId>
        <size minimalWidth="3005" minimalHeight="567" autofitWidth="false" autofitHeight="true"/>
        <padding left="250" right="250" top="300" bottom="350"/>
    </element>
    <element type="Cell">
        <id>8</id>
        <reference>UIREF:V=1:RID=1:BID=8</reference>
        <parentId>15</parentId>
        <size minimalWidth="3005" minimalHeight="567" autofitWidth="false" autofitHeight="true"/>
        <padding left="250" right="250" top="220" bottom="230"/>
    </element>
    <element type="Cell">
        <id>4</id>
        <reference>UIREF:V=1:RID=1:BID=4</reference>
        <parentId>2</parentId>
        <size minimalWidth="15048" minimalHeight="1548" autofitWidth="false" autofitHeight="true"/>
        <position x="7416" y="432" horizontalAnchorType="None" verticalAnchorType="None"/>
        <padding left="213" right="213" top="156" bottom="156"/>
    </element>
    <element type="Cell">
        <id>5</id>
        <reference>UIREF:V=1:RID=1:BID=5</reference>
        <parentId>15</parentId>
        <size minimalWidth="3005" minimalHeight="567" autofitWidth="false" autofitHeight="true"/>
        <padding left="250" right="250" top="220" bottom="230"/>
    </element>
    <element type="PageZone">
        <id>2</id>
        <name>Body</name>
    </element>
    <element type="VTable">
        <id>15</id>
        <reference>UIREF:V=1:RID=1:BID=15</reference>
        <name>Block 1</name>
        <parentId>2</parentId>
        <position x="450" y="900" horizontalAnchorType="None" verticalAnchorType="End" verticalAnchorId="4"/>
    </element>  
</elements>