GetBaseReport

Configuration CSMS->CS OCPP 2.0.1

Sent by the CSMS to request the Charging Station to generate a report containing all its configuration variables. The report is delivered via NotifyReport messages.

Quick Reference

Required Fields

requestId integer

Unique ID for this report request, used to correlate NotifyReport responses

reportBase ReportBaseEnumType

Type of report: ConfigurationInventory, FullInventory, or SummaryInventory

Example Payload

{
  "requestId": 1,
  "reportBase": "FullInventory"
}

Example Full Frame

[
  2,
  "msg-001",
  "GetBaseReport",
  {
    "requestId": 1,
    "reportBase": "FullInventory"
  }
]

Format: [MessageType, MessageId, Action, Payload]

Open in Builder Go to Validator

Overview

GetBaseReport requests a complete report of all Charging Station variables. The Charging Station delivers the report asynchronously via one or more NotifyReport messages.

When to Send

  • During commissioning to discover all available configuration variables
  • To audit the full configuration of a station
  • When GetVariables for a specific component returns UnknownComponent

Expected Response

Initial: status: Accepted or Rejected

Then, the Charging Station sends one or more NotifyReport messages with requestId matching the request, containing the actual variable data.

Report Types

  • ConfigurationInventory: Only user-configurable variables
  • FullInventory: All variables including read-only and monitoring variables
  • SummaryInventory: A condensed summary of the most important variables

Usage Notes

  • Large stations may send many NotifyReport messages — use seqNo to track them
  • The last NotifyReport has tbc: false (to be continued = false)
  • Use requestId to match NotifyReport messages to this request

Testing Tips

  • Request a FullInventory and verify all components and variables are returned
  • Verify that NotifyReport messages arrive with requestId matching the request
  • Verify the sequence ends with tbc: false

Common Errors

TypeConstraintViolation

Cause: reportBase uses an invalid value

Solution: Use one of: ConfigurationInventory, FullInventory, or SummaryInventory

Related Actions

NotifyReport GetVariables SetVariables