GET Export Report

/[context]/pullreports/catalog/[catalog id]/report/[report id]/export

The GET Export Report endpoint is supported by other endpoints within the REST API.

The GET Export Parse Parameters endpoint receives the same parameter API as does GET Export Report but returns a JSON representation of the parsed parameters and includes any errors encountered when parsing. Use this endpoint to validate GET Export Report parameters without receiving an 400 status error.

The GET Export SQL endpoint also receives the same parameter API as does GET Export Report but returns a JSON representation of the SQL and SQL parameters used to fulfill the export result. Use this endpoint to retrieve the SQL associated with a GET Export Report request.

The value of the columns parameter is a semicolon (;) separated list of table resource paths or column resource paths to include, in order, in the export results. Specify a table resource path to include all exportable columns from the referenced table. Use a column resource path to control the exact columns to be included and column order. For users familiar with SQL, the columns parameter is analogous to the columns listed within a SQL "select" clause.

At least one column from the report's base table will always be included within the columns parameter. The inclusion is either explicit, meaning one or more base table column resource paths are specified within the parameter, or implicit, meaning the base table columns are not specified within the parameter but are included by the default behavior detailed below.

If one or more table or column resource paths to non-base table columns are specified within the columns parameter, Pull Reports™ will construct all necessary SQL joins to the referenced database tables based on the report's <relationship> configuration.

columns=@name;/employer@name;@id,address_street,address_state

The distinct parameter removes duplicative records from the export results if set to true. For users familiar with SQL, the behavior of the distinct parameter is analogous to the SQL distinct keyword such as SELECT distinct t.name FROM tablename as t.

If not specified, the distinct parameter's default value is false.

columns=/person@first_name,last_name;/person/house@street,state

columns=/person@first_name,last_name;/person/house@state

columns=/person@first_name,last_name;/person/house@state&distinct=true

The filter parameter limits the export results to those rows which match the filter condition(s). The filter parameter may be specified multiple times. Each filter is independently AND'ed to the Export Report SQL query. Additionally, a single filter parameter may have multiple filter terms separated by the or keyword. For users familiar with SQL, the filter parameter is analogous to the terms within a SQL WHERE clause.

Export results may also be filtered via the <pre_filter> catalog configuration element. If present, filters applied via the filter HTTP parameter are always applied in addition to<pre_filter>s.

[Filter Term] (or [Filter Term])*

[Column Resource Path] [Operator] (Values)?

<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="http://www.pullreports.com/catalog-1.6.1" id="class" name="Class Reports"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.pullreports.com/catalog-1.6.1
    https://www.pullreports.com/docs/xsd/pullreports-catalog-1.6.1.xsd">
    <report id="student-information" name="Student Information Report">
        <export_config defaultColumns="id"/>
        <table id="student" name="person" displayName="Person Info"> 
            <column id="id" name="student" paramType="java.lang.Integer"/>
            <column id="age" name="age" paramType="java.lang.Integer"/>
            <column id="birth_date" name="bdate" paramType="java.sql.Date"/>
            <column id="address_street" name="street"/>
            <column id="address_state" name="state"/>
            <relationship>
                <join_table name="student_parent">
                    <join_columns>
                        <join_column columnName="student_id" referencedColumnName="id" />
                    </join_columns>
                    <inverse_join_columns>
                        <join_column columnName="parent_id" referencedColumnName="id" />
                    </inverse_join_columns>
                </join_table>
                <table id="parent" name="parent" displayName="Parent">
                    <column id="id" name="student" paramType="java.lang.Integer"/>
                    <column id="first_name" name="first_name"/>
                    <column id="last_name" name="last_name"/>
                </table>
            </relationship>
        </table>
    </report>
</catalog>

filter=/student@age > 8

filter=/student/parent@last_name like 'H%' or /student@address_state in ('Colorado','Wyoming')

The format parameter specifies the format and content type of the exported results. Valid values are xml , json , jsontree , csv , html , htmltable , htmltree , kml , geojson , or map. If not specified, the default is json.

See the response documentation for detailed information about format response structure.

The limit parameter is a non-negative integer which limits the maximum number of export results returned. Note that regardless of the value of the limit parameter, the maximum number of exports results may never exceed the export.report.maxResults installation parameter.

The offset parameter is a non-negative integer indicating the offset of the export results.

The value of the sort parameter is a semicolon (;) separated list of column resource paths which specify, in order, the desired sort of the export results.

Each sorted column must be included in the export results either by specific inclusion in the columns parameter or by the default exported columns if the columns parameter is not specified. The Export Report API will return a 400 HTTP status code if the sort parameter references a column not included within the export results.

Appending desc or asc to a column resource path will set the sort order to be descending or ascending, respectively. The default sort order is ascending.

If the sort parameter is not specified, the results will sort based on the defaultSort attribute of the <report>'s <export_config>, if present. If the sort parameter is present but empty (e.g. sort=), the results will be unsorted regardless of the presence of the defaultSort attribute.

The Export Report REST API returns non-200 HTTP status codes for a variety of error conditions. The structure of the response body for non-200 responses varies by format. See the detailed format documentation below for more information.

Here are different types of non-200 responses and their common causes.