Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: dot replaced by semicolon under export POST date parameter
Created dateUpdated dateAffects versionFix version

  

  

Management PortalN/A

Table of Contents

...

ParameterDescription
date

Date range for the exported reports. This object consists of properties with the following valid names: lte (less than or equal), lt (less than), eq (equal), gt (greater than), and gte (greater than or equal).

If this isn't defined, the default is to export reports from the past month.

For example, in order to export all reports from January 2021, you'd use the following: {"gte". : "2021-01-01T00:00:00Z", "lt": "2021-02-01T00:00:00Z"}.

In order to disable date filtering, use an empty object. Default range of past month is derived by decreasing the "number" of the month. E.g. if the current date at the time the export is executed is 2021-03-01T07:00:00Z, then that becomes the end of the date range and start would be 2021-02-01T07:00:00Z.

format

Format of the exported report. If omitted, default format for ERASURE reports is "XML".

Valid values: "CSV", "JSON", and "XML".

container

Container in which all individual reports are wrapped in.

Valid values: "NONE" and "ZIP" (default).

With "NONE", the reports are wrapped into a single document of the same format as the reports themselves. For example, if format is "XML" and container is "NONE", a single XML document is returned that contains all individual XML reports. When container is "ZIP", all reports have their own file within the returned ZIP file.

...