Get Report

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.26 (Messages); Use Case B08 — Get Custom Report (Functional Block B. Provisioning)

Overview

The CSMS sends GetReportRequest to ask the Charging Station for a custom Device Model report — narrower than GetBaseReport. Filtering is by componentCriteria (up to 4) and/or by an explicit list of componentVariable[].

The CS first responds with GetReportResponse(status), then delivers the actual data via one or more NotifyReport messages sharing the same requestId.

Sequence Diagram

CSMS  ──── GetReportRequest ────▶  Charging Station
            (requestId, componentCriteria[]?, componentVariable[]?)
CSMS  ◀─── GetReportResponse ────  Charging Station
            (status, statusInfo?)

(then NotifyReportRequest messages with same requestId)

Initiator

CSMS → Charging Station

Fields

Field Name	Field Type	Card.	Description
requestId	integer	1..1	Required. Id of the request.
componentCriteria	ComponentCriterionEnumType	0..4	Optional. Component filter criteria (max 4).
componentVariable	ComponentVariableType	0..*	Optional. Specific component/variable pairs.

ComponentCriterionEnumType values

Active, Available, Enabled, Problem.

Examples

{
  "requestId": 11,
  "componentCriteria": ["Active", "Available"],
  "componentVariable": [
    { "component": { "name": "OCPPCommCtrlr" } }
  ]
}

{
  "status": "Accepted"
}

Schema

Source: schemas/GetReportRequest.json, schemas/GetReportResponse.json (OCPP 2.0.1 FINAL)

Request schema (JSON Schema)

Response schema (JSON Schema)

Field Name	Field Type	Card.	Description
status	GenericDeviceModelStatusEnumType	1..1	Required. Whether the CS could accept the request.
statusInfo	StatusInfoType	0..1	Optional. Detailed status information.