Rack — Metadata

Subscribe to BMS-published metadata for all Rack point types.

Direction: Subscribe (receive)

Channel

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

BMS-published metadata for all Rack points. Includes integration-owned points which carries the integration field.

MQTT wildcard examples

All rack metadata: BMS/v1/PUB/Metadata/Rack/#

Parameters

Parameter	Description
`pointType`	Rack point type. Values: `RackLiquidSupplyTemperature`, `RackLiquidReturnTemperature`, `RackLiquidFlow`, `RackLiquidDifferentialPressure`, `RackLiquidDifferentialPressureSp`, `RackControlValvePosition` … (14 total)
`tagPath`	Must match the tagPath of the corresponding value topic exactly.

Message: Rack RackLiquidSupplyTemperature Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLiquidSupplyTemperature`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`engUnit`	string	Yes	Values: `C`

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLiquidSupplyTemperature",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "engUnit": "C"
7 }

Message: Rack RackLiquidReturnTemperature Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLiquidReturnTemperature`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`engUnit`	string	Yes	Values: `C`

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLiquidReturnTemperature",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "engUnit": "C"
7 }

Message: Rack RackLiquidFlow Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLiquidFlow`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`engUnit`	string	Yes	Values: `LPM`

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLiquidFlow",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "engUnit": "LPM"
7 }

Message: Rack RackLiquidDifferentialPressure Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLiquidDifferentialPressure`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`engUnit`	string	Yes	Values: `kPa`

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLiquidDifferentialPressure",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "engUnit": "kPa"
7 }

Message: Rack RackLiquidDifferentialPressureSp Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLiquidDifferentialPressureSp`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`engUnit`	string	Yes	Values: `kPa`
`isSetpoint`	boolean	No	Optional inclusion. Indicates this point is a target value written to control equipment behavior.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLiquidDifferentialPressureSp",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "engUnit": "kPa",
7   "isSetpoint": false
8 }

Message: Rack RackControlValvePosition Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackControlValvePosition`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`engUnit`	string	Yes	Values: `%`

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackControlValvePosition",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "engUnit": "%"
7 }

Message: Rack RackPower Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackPower`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`engUnit`	string	Yes	Values: `kW`

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackPower",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "engUnit": "kW"
7 }

Message: Rack RackLeakDetect Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLeakDetect`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`stateText`	array<map<string, any>>	Yes	State label mapping for leak detection.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLeakDetect",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "stateText": [
7     {
8       "value": 0,
9       "text": "NoLeak"
10     },
11     {
12       "value": 1,
13       "text": "Leak"
14     }
15   ]
16 }

Message: Rack RackLeakSensorFault Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLeakSensorFault`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`stateText`	array<map<string, any>>	Yes	State label mapping for leak sensor fault status.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLeakSensorFault",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "stateText": [
7     {
8       "value": 0,
9       "text": "NoFault"
10     },
11     {
12       "value": 1,
13       "text": "Fault"
14     }
15   ]
16 }

Message: Rack RackLeakDetectTray Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLeakDetectTray`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`integration`	string	Yes	Integration identifier responsible for publishing this value.
`stateText`	array<map<string, any>>	Yes	State label mapping for tray leak detection.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLeakDetectTray",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "integration": "string",
7   "stateText": [
8     {
9       "value": 0,
10       "text": "NoLeak"
11     },
12     {
13       "value": 1,
14       "text": "Leak"
15     }
16   ]
17 }

Message: Rack RackLiquidIsolationStatus Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLiquidIsolationStatus`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`stateText`	array<map<string, any>>	Yes	State label mapping for liquid isolation status.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLiquidIsolationStatus",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "stateText": [
7     {
8       "value": 0,
9       "text": "NotIsolated"
10     },
11     {
12       "value": 1,
13       "text": "Isolated"
14     }
15   ]
16 }

Message: Rack RackElectricalIsolationStatus Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackElectricalIsolationStatus`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`stateText`	array<map<string, any>>	Yes	State label mapping for electrical isolation status.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackElectricalIsolationStatus",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "stateText": [
7     {
8       "value": 0,
9       "text": "NotIsolated"
10     },
11     {
12       "value": 1,
13       "text": "Isolated"
14     }
15   ]
16 }

Message: Rack RackLiquidIsolationRequest Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackLiquidIsolationRequest`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`integration`	string	Yes	Integration identifier responsible for publishing this value.
`stateText`	array<map<string, any>>	Yes	State label mapping for liquid isolation request.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackLiquidIsolationRequest",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "integration": "string",
7   "stateText": [
8     {
9       "value": 0,
10       "text": "NoIsolationRequested"
11     },
12     {
13       "value": 1,
14       "text": "IsolationRequested"
15     }
16   ]
17 }

Message: Rack RackElectricalIsolationRequest Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `Rack`
`pointType`	string	Yes	Values: `RackElectricalIsolationRequest`
`rackLocationName`	string	Yes	Human-readable rack name as defined by the BMS.
`rackLocationId`	string	Yes	Stable unique identifier for the rack.
`integration`	string	Yes	Integration identifier responsible for publishing this value.
`stateText`	array<map<string, any>>	Yes	State label mapping for electrical isolation request.

Example payload

1 {
2   "objectType": "Rack",
3   "pointType": "RackElectricalIsolationRequest",
4   "rackLocationName": "string",
5   "rackLocationId": "string",
6   "integration": "string",
7   "stateText": [
8     {
9       "value": 0,
10       "text": "NoIsolationRequested"
11     },
12     {
13       "value": 1,
14       "text": "IsolationRequested"
15     }
16   ]
17 }