Getting the Details of a Report

Usage

Gets the details of the report specified by the given identifier.

Request

GET /documents/<documentID>/reports/<reportID>

Response

Response type: application/xml or application/json

Response body:

  • The <id>, <name>, and <reference> of the reports
  • The <showDataChanges> Boolean value that expresses whether data changes are displayed
  • The report style and page settings if defined

Example

XML

GET /documents/7858/reports/1

Response:

<report> 
    <id>1</id>  
    <name>Revenue by City</name>  
    <reference>1.RS</reference>  
    <showDataChanges>false</showDataChanges>  
    <style> 
        <hyperLinkColors visited="#000000" link="#0000ff" hover="#000000" active="#000000"/> 
    </style>  
    <pageSettings> 
        <margins left="2835" right="2835" top="2835" bottom="2835"/>  
        <format orientation="Portrait" height="42094" width="29764"/>  
        <records vertical="100" horizontal="20"/>  
        <scaling factor="100"/> 
    </pageSettings> 
</report>

Example

JSON

GET /documents/5152/reports/5

Response:

{"report":
    {"id":5,
     "name":"Element Linking",
     "reference":"5.RS",
     "showDataChanges":false,
     "style":
         {"hyperLinkColors":
             {"@visited":"#000000","@link":"#0000ff","@hover":"#000000","@active":"#000000"}
         },
     "pageSettings":
         {"margins":{"@left":"2835","@right":"2835","@top":"2835","@bottom":"2835"},
          "format":{"@orientation":"Portrait","@height":"42094","@width":"29764"},
          "records":{"@vertical":"100","@horizontal":"20"},
          "scaling":{"@factor":"100"}
         }
    }
}