ReportCategory

Description

ReportCategory is used to describe a grouping of reports. The available report categories are listed below.

Parameters

Name	Type	Description
ALL	string	This is the default ReportCategory. No filter is applied and all reports should be returned.
APPLICATION	string	Return only Application Reports (process app-specific listing reports designed in SBM Composer).
BUILTIN	string	Return only built-in reports.
MY	string	Return all reports that you have authored.
QUICKLINKS	string	Return only reports that are saved as Quick Links.
USERREPORTS	string	Return all reports, with the exception of built-in reports.

Usage

ReportCategory is used to limit the reports returned in the reportsFilter argument of the GetReports call. The default setting is "ALL" which will returns all reports (no filter is applied via this parameter in that case). See ReportsFilter for further usage.

XML

The following XML snippet shows ReportCategory as seen in a typical call.

<urn:reportsFilter>
    <urn:solution>
        <urn:displayName></urn:displayName>
        <urn:id>1</urn:id>
        <urn:uuid></urn:uuid>
        <urn:uniqueName>BASE_ISSUE_DEFECT_TRACKING</urn:uniqueName>
        <urn:tabName></urn:tabName>
    </urn:solution>
    <urn:project>
        <urn:displayName></urn:displayName>
        <urn:id>4</urn:id>
        <urn:uuid></urn:uuid>
        <urn:fullyQualifiedName></urn:fullyQualifiedName>
    </urn:project>
    <urn:table>
        <urn:displayName></urn:displayName>
        <urn:id>1000</urn:id>
        <urn:uuid></urn:uuid>
        <urn:dbName></urn:dbName>
    </urn:table>
    <urn:author></urn:author>
    <urn:reportType>LISTING</urn:reportType>
    <urn:reportCategory>ALL</urn:reportCategory>
    <urn:reportAccessLevel>USER</urn:reportAccessLevel>
    <urn:report>
        <urn:displayName></urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
    </urn:report>
    <urn:searchByName>ALL</urn:searchByName>
    <urn:includeSubProjects>true</urn:includeSubProjects>
    <urn:createdDateFrom>2007-06-20T15:35:38-07:00</urn:createdDateFrom>
    <urn:createdDateTo>2007-07-20T15:35:38-07:00</urn:createdDateTo>
</urn:reportsFilter>