GetReport

Asks for a filtered slice of the device model, rather than the whole inventory.

Version
OCPP 2.0.1
Direction
CSMS → Charge Point
Functional block
Provisioning

Where GetBaseReport takes everything, GetReport takes a filter: specific components and variables, or everything matching a set of criteria such as 'only variables that are currently at a problematic value'.

Like GetBaseReport, the content comes back through NotifyReport.

Request

FieldTypeRequiredDescription
requestIdintegerRequiredCorrelation id, echoed in the NotifyReport messages.
componentVariableComponentVariableType[]OptionalSpecific components and variables to report on.
componentCriteriaComponentCriterionEnumType[]OptionalFilter by state: Active, Available, Enabled, Problem.
json
[2, "19223201", "GetReport", {
  "requestId": 502,
  "componentCriteria": ["Problem"]
}]

Response

FieldTypeRequiredDescription
statusGenericDeviceModelStatusEnumTypeRequiredWhether the report will be produced.
statusInfoStatusInfoTypeOptionalReason code.
json
[3, "19223201", {
  "status": "Accepted"
}]

Implementation notes

`componentCriteria: ["Problem"]` is the fastest health check in 2.0.1 — it asks the station to report only what it considers wrong with itself.

EmptyResultSet here is good news: nothing matched the problem filter.