ReportDefinition

Description

The ReportDefinition type contains columns and the order by definition for a report. The ReportDefinition type parameters are listed below.

Parameters

Name Type Description
orderBy OrderBy Indicates which fields are used to organize the report results.
column Field Holds a description the fields used in the report.

Usage

The ReportDefinition describes the basic structure of a report. The ReportDefinition type contains a description of each of the fields used in the report. If the report uses any of the columns to order the results, the OrderBy parameter will indicate which column(s) are used.

XML

The following XML snippet shows the ReportDefintion type in the return element of the RunReport response.

<ae:reportDefinition>
   <ae:orderBy/>
   <ae:column>
      <ae:field xsi:type="ae:FieldIdentifier">
         <ae:displayName>Item Id</ae:displayName>
         <ae:id>53</ae:id>
         <ae:uuid>8a46043d-8cff-4871-a106-f0646ed3c58f</ae:uuid>
         <ae:dbName>ISSUEID</ae:dbName>
      </ae:field>
      <ae:fieldType>FLDTYPE-TEXT</ae:fieldType>
      <ae:attribute>0</ae:attribute>
      <ae:properties>0</ae:properties>
   </ae:column>
   <ae:column>
      <ae:field xsi:type="ae:FieldIdentifier">
         <ae:displayName>Title</ae:displayName>
         <ae:id>54</ae:id>
         <ae:uuid>9bf79ebb-c66f-43dc-b608-5edc0677d4ca</ae:uuid>
         <ae:dbName>TITLE</ae:dbName>
      </ae:field>
      <ae:fieldType>FLDTYPE-TEXT</ae:fieldType>
      <ae:attribute>0</ae:attribute>
      <ae:properties>0</ae:properties>
   </ae:column>
</ae:reportDefinition>