For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • DSX Exchange
    • Architecture
    • Pre-Deployment
    • Deployment
    • Integrator Quickstart
    • Operations
    • Authentication
    • BMS Integration
    • Validated Capabilities
  • Schema
      • Overview
          • BMS Value
          • Integration Value
          • Metadata
      • Messages
      • Schemas
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
On this page
  • Channel
  • Parameters
  • Message: HeartbeatTimestampBms Metadata
  • Payload
  • Message: HeartbeatEchoBms Metadata
  • Payload
  • Message: HeartbeatTimestampIntegration Metadata
  • Payload
  • Message: HeartbeatEchoIntegration Metadata
  • Payload
SchemaBMS Event BusOperationsSystem

System — Metadata

||View as Markdown|
Previous

Integration Value

Next

Metadata

Subscribe to System metadata for all System point types.

Direction: Subscribe (receive)

Channel

BMS/v1/PUB/Metadata/System/{pointType}/{tagPath}

BMS-published metadata for all System point types.

MQTT wildcard examples

  • All System metadata: BMS/v1/PUB/Metadata/System/#

Parameters

ParameterDescription
pointTypeSystem point type. Values: HeartbeatTimestampBms, HeartbeatEchoBms, HeartbeatTimestampIntegration, HeartbeatEchoIntegration, Status, Available … (7 total)
tagPathVendor-defined hierarchical tag path.

Message: HeartbeatTimestampBms Metadata

Content Type: application/json

Payload

NameTypeRequiredDescription
objectTypestringYesCanonical object type. Matches the objectType MQTT topic segment.
pointTypestringYesValues: HeartbeatTimestampBms
objectNamestringYesHuman-readable name of the BMS publishing this heartbeat.
objectIdstringYesStable identifier for the BMS publishing this heartbeat (e.g., "BMS"). One instance per BMS.
scopestringNoIdentifies which MQTT topics this heartbeat covers.
Example payload
1{
2  "objectType": "string",
3  "pointType": "HeartbeatTimestampBms",
4  "objectName": "string",
5  "objectId": "string",
6  "scope": "string"
7}

Message: HeartbeatEchoBms Metadata

Content Type: application/json

Payload

NameTypeRequiredDescription
objectTypestringYesCanonical object type. Matches the objectType MQTT topic segment.
pointTypestringYesValues: HeartbeatEchoBms
objectNamestringYesHuman-readable name of the integration whose timestamp is being echoed.
objectIdstringYesStable identifier of the integration whose timestamp is being echoed (e.g., "MEPAI1"). Matches that integration’s integration metadata value on its other points.
scopestringNoOptional. Identifies which BMS MQTT-client/topic namespace this echo is associated with.
Example payload
1{
2  "objectType": "string",
3  "pointType": "HeartbeatEchoBms",
4  "objectName": "string",
5  "objectId": "string",
6  "scope": "string"
7}

Message: HeartbeatTimestampIntegration Metadata

Content Type: application/json

Payload

NameTypeRequiredDescription
objectTypestringYesCanonical object type. Matches the objectType MQTT topic segment.
pointTypestringYesValues: HeartbeatTimestampIntegration
integrationstringYesIntegration identifier.
objectNamestringYesHuman-readable name of the integration publishing this heartbeat.
objectIdstringYesStable identifier of the integration publishing this heartbeat (e.g., "MEPAI1"). By convention, matches the integration metadata value used by this integration on its other points.
Example payload
1{
2  "objectType": "string",
3  "pointType": "HeartbeatTimestampIntegration",
4  "integration": "string",
5  "objectName": "string",
6  "objectId": "string"
7}

Message: HeartbeatEchoIntegration Metadata

Content Type: application/json

Payload

NameTypeRequiredDescription
objectTypestringYesCanonical object type. Matches the objectType MQTT topic segment.
pointTypestringYesValues: HeartbeatEchoIntegration
integrationstringYesIntegration identifier.
objectNamestringYesHuman-readable name of the BMS whose timestamp is being echoed.
objectIdstringYesStable identifier of the BMS whose timestamp is being echoed (e.g., "BMS").
Example payload
1{
2  "objectType": "string",
3  "pointType": "HeartbeatEchoIntegration",
4  "integration": "string",
5  "objectName": "string",
6  "objectId": "string"
7}