> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/dsx-exchange/llms.txt.
> For full documentation content, see https://docs.nvidia.com/dsx-exchange/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/dsx-exchange/_mcp/server.

# System — Metadata

Subscribe to System metadata for all System point types.

**Direction:** Subscribe (receive)

## Channel

```text
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

| Parameter   | Description                                                                                                                                                              |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `pointType` | System point type. Values: `HeartbeatTimestampBms`, `HeartbeatEchoBms`, `HeartbeatTimestampIntegration`, `HeartbeatEchoIntegration`, `Status`, `Available` ... (7 total) |
| `tagPath`   | Vendor-defined hierarchical tag path.                                                                                                                                    |

## Message: HeartbeatTimestampBms Metadata

**Content Type:** `application/json`

### Payload

| Name         | Type   | Required | Description                                                                                    |
| ------------ | ------ | -------- | ---------------------------------------------------------------------------------------------- |
| `objectType` | string | Yes      | Canonical object type. Matches the objectType MQTT topic segment.                              |
| `pointType`  | string | Yes      | Values: `HeartbeatTimestampBms`                                                                |
| `objectName` | string | Yes      | Human-readable name of the BMS publishing this heartbeat.                                      |
| `objectId`   | string | Yes      | Stable identifier for the BMS publishing this heartbeat (e.g., `"BMS"`). One instance per BMS. |
| `scope`      | string | No       | Identifies which MQTT topics this heartbeat covers.                                            |

```json
{
  "objectType": "string",
  "pointType": "HeartbeatTimestampBms",
  "objectName": "string",
  "objectId": "string",
  "scope": "string"
}
```

## Message: HeartbeatEchoBms Metadata

**Content Type:** `application/json`

### Payload

| Name         | Type   | Required | Description                                                                                                                                                           |
| ------------ | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectType` | string | Yes      | Canonical object type. Matches the objectType MQTT topic segment.                                                                                                     |
| `pointType`  | string | Yes      | Values: `HeartbeatEchoBms`                                                                                                                                            |
| `objectName` | string | Yes      | Human-readable name of the integration whose timestamp is being echoed.                                                                                               |
| `objectId`   | string | Yes      | Stable identifier of the integration whose timestamp is being echoed (e.g., `"MEPAI1"`). Matches that integration's `integration` metadata value on its other points. |
| `scope`      | string | No       | Optional. Identifies which BMS MQTT-client/topic namespace this echo is associated with.                                                                              |

```json
{
  "objectType": "string",
  "pointType": "HeartbeatEchoBms",
  "objectName": "string",
  "objectId": "string",
  "scope": "string"
}
```

## Message: HeartbeatTimestampIntegration Metadata

**Content Type:** `application/json`

### Payload

| Name          | Type   | Required | Description                                                                                                                                                                              |
| ------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectType`  | string | Yes      | Canonical object type. Matches the objectType MQTT topic segment.                                                                                                                        |
| `pointType`   | string | Yes      | Values: `HeartbeatTimestampIntegration`                                                                                                                                                  |
| `integration` | string | Yes      | Integration identifier.                                                                                                                                                                  |
| `objectName`  | string | Yes      | Human-readable name of the integration publishing this heartbeat.                                                                                                                        |
| `objectId`    | string | Yes      | Stable 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. |

```json
{
  "objectType": "string",
  "pointType": "HeartbeatTimestampIntegration",
  "integration": "string",
  "objectName": "string",
  "objectId": "string"
}
```

## Message: HeartbeatEchoIntegration Metadata

**Content Type:** `application/json`

### Payload

| Name          | Type   | Required | Description                                                                   |
| ------------- | ------ | -------- | ----------------------------------------------------------------------------- |
| `objectType`  | string | Yes      | Canonical object type. Matches the objectType MQTT topic segment.             |
| `pointType`   | string | Yes      | Values: `HeartbeatEchoIntegration`                                            |
| `integration` | string | Yes      | Integration identifier.                                                       |
| `objectName`  | string | Yes      | Human-readable name of the BMS whose timestamp is being echoed.               |
| `objectId`    | string | Yes      | Stable identifier of the BMS whose timestamp is being echoed (e.g., `"BMS"`). |

```json
{
  "objectType": "string",
  "pointType": "HeartbeatEchoIntegration",
  "integration": "string",
  "objectName": "string",
  "objectId": "string"
}
```