> 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.

# ATS — Metadata

Subscribe to BMS-published metadata for ATS points.

**Direction:** Subscribe (receive)

## Channel

```text
BMS/v1/PUB/Metadata/ATS/{pointType}/{tagPath}
```

BMS-published metadata for ATS points.

**MQTT wildcard examples**

* All ATS metadata: `BMS/v1/PUB/Metadata/ATS/#`

### Parameters

| Parameter   | Description                                                   |
| ----------- | ------------------------------------------------------------- |
| `pointType` | ATS point type. Values: `Status`, `Available`, `GenericPoint` |
| `tagPath`   | Vendor-defined hierarchical tag path.                         |

## Message: ATS Status Metadata

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

### Payload

Optional fields common to all generic equipment metadata, regardless of identifier mode.

### Object Mode

* `objectName` and `objectId` are **required**.
* `servesId` is **optional** in Named-object mode.
* `associateId` must **not** be present.

Incompatible with `EquipmentAssociateMode` — validators enforce this via
the parent `oneOf`.

| Name         | Type              | Required | Description                                                                                                                                                         |
| ------------ | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectName` | string            | Yes      | Human-readable equipment name.                                                                                                                                      |
| `objectId`   | string            | Yes      | Stable unique identifier for the equipment.                                                                                                                         |
| `servesId`   | array\<string> | No       | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |

### Associate Mode

* `associateId` is **required**.
* `objectName`, `objectId`, and `servesId` must **not** be present.

Incompatible with `EquipmentNamedObjectMode` — validators enforce this
via the parent `oneOf`.

| Name          | Type   | Required | Description                          |
| ------------- | ------ | -------- | ------------------------------------ |
| `associateId` | string | Yes      | Identifier of the associated entity. |

```json
{
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ]
}
```

## Message: ATS Available Metadata

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

### Payload

Optional fields common to all generic equipment metadata, regardless of identifier mode.

### Object Mode

* `objectName` and `objectId` are **required**.
* `servesId` is **optional** in Named-object mode.
* `associateId` must **not** be present.

Incompatible with `EquipmentAssociateMode` — validators enforce this via
the parent `oneOf`.

| Name         | Type              | Required | Description                                                                                                                                                         |
| ------------ | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectName` | string            | Yes      | Human-readable equipment name.                                                                                                                                      |
| `objectId`   | string            | Yes      | Stable unique identifier for the equipment.                                                                                                                         |
| `servesId`   | array\<string> | No       | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |

### Associate Mode

* `associateId` is **required**.
* `objectName`, `objectId`, and `servesId` must **not** be present.

Incompatible with `EquipmentNamedObjectMode` — validators enforce this
via the parent `oneOf`.

| Name          | Type   | Required | Description                          |
| ------------- | ------ | -------- | ------------------------------------ |
| `associateId` | string | Yes      | Identifier of the associated entity. |

```json
{
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ]
}
```

## Message: GenericEquipment GenericPoint Metadata

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

### Payload

Field fragment for a vendor-specific or unmapped GenericPoint. `processArea` is required.

`engUnit` and `stateText` are both optional but **mutually exclusive** — include at most one. See the two variants below.

### Object Mode

* `objectName` and `objectId` are **required**.
* `servesId` is **optional** in Named-object mode.
* `associateId` must **not** be present.

Incompatible with `EquipmentAssociateMode` — validators enforce this via
the parent `oneOf`.

| Name         | Type              | Required | Description                                                                                                                                                         |
| ------------ | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectName` | string            | Yes      | Human-readable equipment name.                                                                                                                                      |
| `objectId`   | string            | Yes      | Stable unique identifier for the equipment.                                                                                                                         |
| `servesId`   | array\<string> | No       | Optional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode. |

### Associate Mode

* `associateId` is **required**.
* `objectName`, `objectId`, and `servesId` must **not** be present.

Incompatible with `EquipmentNamedObjectMode` — validators enforce this
via the parent `oneOf`.

| Name          | Type   | Required | Description                          |
| ------------- | ------ | -------- | ------------------------------------ |
| `associateId` | string | Yes      | Identifier of the associated entity. |

```json
{
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ]
}
```