GET reports/run?ReportGuid={ReportGuid}&CustomerID={CustomerID}&StartDate={StartDate}&EndDate={EndDate}&TagID={TagID}&ActiveDeviceWithin={ActiveDeviceWithin}&OutputFormat={OutputFormat}&DealerID={DealerID}

Run report. Roles: ApiRole

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ReportGuid

The Report to run.

globally unique identifier

Required

CustomerID

The Customer to run the View for

integer

Required

StartDate

Optional - Format (utc): "dd-mm-yyyy+hh:mm:ss" (date is required, time is optional) - Default is 3 months ago

date

None.

EndDate

Optional - Format (utc): "dd-mm-yyyy+hh:mm:ss" (date is required, time is optional) - Default is NOW

date

None.

TagID

Optional - Result of view, will only contain devices tagged with Tag ID.

integer

None.

ActiveDeviceWithin

Optional - Set this to filter devices.

ActiveDeviceWithin

None.

OutputFormat

Optional - Output format of the generated report

OutputFormat_Values

None.

DealerID

Optional - Dealer ID

integer

None.

Examples:

https://api2.jetadvice.com/reports/run?reportguid=fa463591-f6c5-4aa4-a7a8-16c3f0955a1d&customerid=1234&startdate=01-01-2015+00:00:00&enddate=31-12-2015+23:59:59    // Period = Whole 2015
https://api2.jetadvice.com/reports/run?reportguid=fa463591-f6c5-4aa4-a7a8-16c3f0955a1d&customerid=1234&startdate=01-01-2015&enddate=31-12-2015+23:59:59             // Period = Whole 2015
https://api2.jetadvice.com/reports/run?reportguid=fa463591-f6c5-4aa4-a7a8-16c3f0955a1d&customerid=1234&startdate=01-01-2015&enddate=01-01-2016                      // Period = Whole 2015
https://api2.jetadvice.com/reports/run?reportguid=fa463591-f6c5-4aa4-a7a8-16c3f0955a1d&customerid=1234&startdate=01-01-2015                                         // Period = from 01/01/2015 till NOW
https://api2.jetadvice.com/reports/run?reportguid=fa463591-f6c5-4aa4-a7a8-16c3f0955a1d&customerid=1234                                                              // Period = last 3 months
https://api2.jetadvice.com/reports/run?reportguid=fa463591-f6c5-4aa4-a7a8-16c3f0955a1d&customerid=1234&tagid=123                                                    // Require devices to be tagged with Tag ID = 123                
https://api2.jetadvice.com/reports/run?reportguid=fa463591-f6c5-4aa4-a7a8-16c3f0955a1d&customerid=1234&activedevicewithinid=123                                     // Require devices to be Active within ActiveDeviceWithinID = 123

Response

The format of the Report result is flexible by nature. Depending on the Report setup, the number and types of fields in the result is variable. The XML format is as follows (format is subject to change):

    <?xml version="1.0"?>
    <Report>
        <Dates>
            <ReportRun>2015-01-01 10:00:00Z</ReportRun>
            <PeriodStart>2014-01-01 00:00:00Z</PeriodStart>
            <PeriodEnd>2014-12-31 23:59:59Z</PeriodEnd>
        </Dates>
        <Devices>
            <Device>
                <Notice-Message/>
                <Printer-Name>HP Business InkJet 1200</Printer-Name>
                <IPv4>128.253.217.61</IPv4>
                <Serial>TH4AE110NC</Serial>
                <Hostname>HP7C4BE5</Hostname>
            </Device>
            <Device>
                <Notice-Message/>
                <Printer-Name>HP CM8060 Color MFP</Printer-Name>
                <IPv4>192.168.0.169</IPv4>
                <Serial>SG73OC100N</Serial>
                <Hostname>NPI0F8B33</Hostname>
            </Device>
            ...
        </Devices>
    </Report>