NG Reports (Scheduled)

Update a scheduled custom report

Changed on

Update an existing scheduled custom report identified by reportScheduleId.

put/ng-reports/scheduled/custom/{reportId}

Request

  • Base URL
    https://api.extremecloudiq.com
  • URL
    https://api.extremecloudiq.com/ng-reports/scheduled/custom/{reportId}
  • Auth
    HTTP bearer

Path parameters

reportIdinteger required

The report ID

Request body

metricsXiqQoeDiagnosticsMetrics[] required

List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).

report_namestring required

The name of the report.

report_descriptionstring

A short description of the report.

site_idsinteger[]

List of site IDs the report will cover.

building_idsinteger[]

List of building IDs the report will cover.

floor_idsinteger[]

List of floor IDs the report will cover.

ssidsstring[]

List of SSIDs to be included in the report.

bandsXiqDiagnosticsBands[]

List of bands (e.g., 2.4GHz, 5GHz) to be covered in the report.

file_formatXiqReportFileFormat[] required

The file format(s) of the report (e.g., PDF, CSV).

Response

OK

report_idinteger

Unique ID of the report

report_namestring

The name of the actual report.

report_descriptionstring

A short description of the report.

metricsXiqQoeDiagnosticsMetrics[] required

List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).

site_idsinteger[]

List of site IDs the report will cover.

building_idsinteger[]

List of building IDs the report will cover.

floor_idsinteger[]

List of floor IDs the report will cover.

ssidsstring[]

List of SSIDs to be included in the report.

bandsXiqDiagnosticsBands[]

List of bands (e.g., 2.4GHz, 5GHz) to be included in the report.

file_formatXiqReportFileFormat[] required

The file format(s) of the report (e.g., PDF, CSV).

Changes

  • 242a0e1b1b40Revision changes
    • breaking

      the request property's minItems was increased to 1

    • breaking

      the request property's minItems was increased to 1

    • breaking

      the request property's minItems was increased to 1

    • breaking

      the // request property's minItems was increased to 1

    • breaking

      the request property's minLength was increased from 0 to 1