GetReports

Description

This service returns a list of reports within a specified range, limited by one or more optional filters.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
queryRange (optional)	QueryRange	The QueryRange type allows you to specify the number of reports to return. This enables you to limit the number of reports that are returned.
reportsFilter (optional)	ReportsFilter	The ReportsFilter type allows you to filter the reports that are returned based on optional parameters similar to the Find Reports command in the SBM User Workspace.
options	Options	Holds name value pairing for future arguments.

Response

GetReportsResult is returned. A filtered list of reports, within the specified range, is displayed in the response. The response contains the number of reports returned and a high-level description for each report. 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). For more detail, see GetReportsResult.

Usage

The GetReports call finds a list of available reports without actually running any of the reports themselves. You can use GetReports to search for all reports that you have privileges to run, modify, and delete within the provided range . You can also use this call to search for auxiliary table reports that you can run, modify, and delete. You can use this call to identify which report you would like to run using the UUID of the report. To run a given report in the returned list, use RunReport. You can optionally use the returned report URL to run the report in a Web browser.

Faults

Invalid database pointer.
The project ID is not valid.
The user lacks sufficient permission.
Returning the report fails.

XML

The following XML is a snippet of the payload that is sent with GetReports.

<urn:GetReports>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
    </urn:auth>
    <urn:queryRange>
            <urn:startIndex>1</urn:startIndex>
            <urn:fetchSize>4</urn:fetchSize>
            <urn:totalCount></urn:totalCount>
    </urn:queryRange>
    <urn:reportsFilter>
        <urn:solution>
            <urn:displayName></urn:displayName>
            <urn:id>1</urn:id>
            <urn:uuid></urn:uuid>
            <urn:uniqueName></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:displayName></urn:displayName>
            <urn:id></urn:id>
            <urn:uuid></urn:uuid>
            <urn:loginId></urn:loginId>
        </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></urn:searchByName>
        <urn:includeSubProjects>true</urn:includeSubProjects>
        <urn:createdDateFrom></urn:createdDateFrom>
        <urn:createdDateTo></urn:createdDateTo>
        <urn:extendedData>
            <urn:data>
                <urn:name></urn:name>
                <urn:value></urn:value>
            </urn:data>
        </urn:extendedData>
    </urn:reportsFilter>
    <urn:options>
        <urn:extraOption>
            <urn:name></urn:name>
            <urn:value></urn:value>
        </urn:extraOption>
    </urn:options>
</urn:GetReports>