Report Definition



The report definition. Use to store, retrieve and edit pre-defined reports within the API.

ReportDefinition [Schema]

Name Type Required Description
Title xsd:string ( min: 3 max: 200)
Pattern: [A-Za-z0-9\- ]*
yes The report definition title. Meta data only; not used during report generation.
Readonly xsd:boolean yes The report definition read only status. Read only report definitions cannot be altered or deleted.
ReportQuery Query yes The report query definition title. Used to generate the report.

Example

<?xml version="1.0"?>
<ReportDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Title>string</Title>
  <Readonly>true</Readonly>
  <ReportQuery>
    <RootNodeName>string</RootNodeName>
    <SuppressMetricAttributes>true</SuppressMetricAttributes>
    <ExcludeNullOrEmptyElements>true</ExcludeNullOrEmptyElements>
    <Groups />
  </ReportQuery>
</ReportDefinition>
{
  "ReportDefinition": {
    "Title": "string",
    "Readonly": "true",
    "ReportQuery": {
      "RootNodeName": "string",
      "SuppressMetricAttributes": "true",
      "ExcludeNullOrEmptyElements": "true",
      "Groups": { "Group": [] }
    }
  }
}