GetReport

Configuration CSMS->CS OCPP 2.0.1

Sent by the CSMS to request a custom report of specific variables from the Charging Station, using component/variable criteria.

Quick Reference

Required Fields

requestId integer

Request ID to correlate NotifyReport responses

Optional Fields

componentVariable array[ComponentVariableType]

Filter to specific component/variable pairs

componentCriteria array[ComponentCriterionEnumType]

Filter by criteria: Active, Available, Enabled, or Problem

Example Payload

{
  "requestId": 1,
  "componentVariable": [
    {
      "component": {
        "name": "SmartChargingCtrlr"
      },
      "variable": {
        "name": "Enabled"
      }
    }
  ],
  "componentCriteria": [
    "Active"
  ]
}

Example Full Frame

[
  2,
  "msg-001",
  "GetReport",
  {
    "requestId": 1,
    "componentVariable": [
      {
        "component": {
          "name": "SmartChargingCtrlr"
        },
        "variable": {
          "name": "Enabled"
        }
      }
    ],
    "componentCriteria": [
      "Active"
    ]
  }
]

Format: [MessageType, MessageId, Action, Payload]

Open in Builder Go to Validator

Overview

GetReport is like GetBaseReport but with filtering. It requests only the variables that match specific component/variable criteria or component states.

Expected Response

Initial: status: Accepted, Rejected, or EmptyResultSet

Then, NotifyReport messages deliver the filtered variable data.

Usage Notes

  • componentCriteria: Active — only variables that are currently active
  • componentCriteria: Problem — only variables in a fault state (useful for diagnostics)
  • Combine componentVariable filters with componentCriteria for precise targeting

Testing Tips

  • Request variables filtered by Problem and verify only faulted components are returned
  • Test EmptyResultSet by filtering for components that don’t match any criteria

Related Actions

GetBaseReport NotifyReport GetVariables