GetReportsResult

Description

The GetReportsResult type holds the number of reports returned, as well as high-level information for each report. The GetReportsResult type parameters are listed below.

Parameters

Name	Type	Description
queryRange	QueryRange	Specifies the number of reports that are returned.
report	ReportInfo	Holds a description of the report.

Usage

The GetReportsResult type is sent back in response to a GetReports call. GetReportsResult summarizes the range of reports returned and provides an overview of each report. The actual contents of a report are obtained in the RunReportResult response. Use the isQueryAtRuntime element in the response to determine if the report can be executed using the RunReport call (query at runtime reports cannot be executed by RunReport). You can use GetReports to retrieve the report data shown here.

XML

The following XML snippet shows the GetReportsResult type in the return element of the GetReports response.

<ae:GetReportsResponse>
   <ae:return>
      <ae:queryRange>
         <ae:startIndex>0</ae:startIndex>
         <ae:fetchSize>0</ae:fetchSize>
         <ae:totalCount>1</ae:totalCount>
      </ae:queryRange>
      <ae:report>
         <ae:report xsi:type="ae:ReportIdentifier">
            <ae:displayName>SCM Association Listing</ae:displayName>
            <ae:id>1</ae:id>
            <ae:uuid>4440bb69-40fa-4bbe-8fd8-41f113210243</ae:uuid>
         </ae:report>
         <ae:reportURL>tmtrack.dll?ReportPage&amp;Template=reports
         →%2Flistframe&amp;ReportId=1</ae:reportURL>
         <ae:reportType>LISTING</ae:reportType>
         <ae:reportCategory>USERREPORTS</ae:reportCategory>
         <ae:reportAccessLevel>GUEST</ae:reportAccessLevel>
         <ae:solution xsi:type="ae:SolutionIdentifier">
            <ae:displayName>Issue Defect Management</ae:displayName>
            <ae:id>1</ae:id>
            <ae:uuid>cea0a86c-5d74-4e12-b8d6-9d6b90186f1e</ae:uuid>
            <ae:uniqueName>ISSUE_DEFECT_MANAGEMENT</ae:uniqueName>
            <ae:tabName>IDM</ae:tabName>
         </ae:solution>
         <ae:table xsi:type="ae:TableIdentifier">
            <ae:displayName>SCM Associations</ae:displayName>
            <ae:id>1001</ae:id>
            <ae:uuid>50db5a94-645a-4e8b-9500-3f2950aa4f45</ae:uuid>
            <ae:dbName>UBG_SCM_ASSOCIATIONS</ae:dbName>
         </ae:table>
         <ae:project xsi:type="ae:ProjectIdentifier">
            <ae:displayName>Base Project</ae:displayName>
            <ae:id>1</ae:id>
            <ae:uuid>ROOTPROJECT</ae:uuid>
            <ae:fullyQualifiedName>Base Project</ae:fullyQualifiedName>
            <ae:internalName>BASE_PROJECT</urn:internalName>
         </ae:project>
         <ae:createdBy xsi:type="ae:UserIdentifier">
            <ae:displayName>Joe Manager</ae:displayName>
            <ae:id>2</ae:id>
            <ae:uuid>85a33f0b-9542-43fe-90c1-e152eeea777f</ae:uuid>
            <ae:loginId>joe</ae:loginId>
         </ae:createdBy>
         <ae:createDate>2009-02-05T22:10:01Z</ae:createDate>
         <ae:modifiedBy xsi:type="ae:UserIdentifier">
            <ae:displayName>Joe Manager</ae:displayName>
            <ae:id>2</ae:id>
            <ae:uuid>85a33f0b-9542-43fe-90c1-e152eeea777f</ae:uuid>
            <ae:loginId>joe</ae:loginId>
         </ae:modifiedBy>
         <ae:modifiedDate>2009-03-04T22:49:31Z</ae:modifiedDate>
         <ae:execDate>2010-09-17T18:45:19Z</ae:execDate>
         <ae:isQueryAtRuntime>true</ae:isQueryAtRuntime>
      </ae:report>
   </ae:return>
</ae:GetReportsResponse>