Export list of device changes to XLS file

Export a Changes Summary Report to an Excel file (.xls) based on the device name.

  • To return the device name, use the device-setup-controller API GET /devices method

  • For a range of dates, specify start and end times. For a specific date, specify the same time for start and end time.

    Times are in milliseconds can be taken from https://currentmillis.com/

The response provides a link to download the excel file.

Note: By default the maximum number of characters allowed in a cell in the exported excel is 255.

When the number of characters in the cell exceeds the limit, they will appear in a tooltip for the cell.

You can make maximum number of characters smaller by setting the Max_Characters_Excel_Cell parameter in Administration Advanced Configuration parameters.

You cannot exceed the limit of 255 characters in a cell.

See Max_Characters_Excel_Cell.

Resource Name:

/api/v1/device/export/xls

Request Method: GET

Request URL Parameters:

Element

Type

Description

deviceName

Mandatory

String

Device tree name. To get the device tree name, use GET /devices method from the device-setup-controller.
endTime integer End time in milliseconds.
startTime integer Start time in milliseconds.
timeZone string

Time zone.

Default value : America/New_York

Response:

Code

Description
200

Operation completed successfully

400

Bad request

401

Unauthorized

403

Non-admin user

Request example 

curl -X GET "https://[machine IP]/afa/api/v1/device/export/xls?deviceName=DC_42_root&endTime=1616220563000&startTime=1611122963000&timeZone=America%2FNew_York" -H "accept: */*"

Response example

Download file