JSON Format for Data Points

A JSON object describing a data point using a single skill data point as input and output has the following syntax:

{
  "@DataPoint": {
    "name": "Temperature",
    "UUID": "7fc18ee3-d2b7-43ac-b9ef-7a217f509436",
    "ACL": { ... },
    "units": "°C",
    "displayName": "Turbine Exhaust Temperature",
    "io": "Building.Rack.DAQ.AI 1/06"
  }
}

Object Members

name	A string value containing the name of the data point. The name is used to construct the data point’s primary key.
UUID	A string value containing the unique UUID of the data point.
ACL	An optional JSON object containing the element ACL of the data point. The format of the object is described under JSON Format for ACLs.
units	An optional string value containing the physical units of the data point’s value, like “kg” or “°C”. If you omit the “units” member, then the data point will have no units, and the “units” attribute will contain an empty string.
displayName	An optional string value containing the display name of for the data point. If you omit the “displayName” member, then the primary key will be used as display name.
io	A string value describing the skill data point that the data point should use. The string value must contain the primary key of the skill data point. The data point will be readable if the skill data point supports the input direction, and writable if the skill data point supports the output direction.

For more control over the input and output, the skill data point for input and output can be specified separately. This allows using different skill data points for input and output, as well as suppressing one of the data directions of the skill data point (e.g. making a data point read-only even though the skill data point supports reading and writing).

To specify separate skill data points for input and output, specify a JSON object with “input” and “output” members as “io” instead of a string:

{
  "@DataPoint": {
    ...
    "io": {
      "input": "Building.Rack.DAQ.AI 2/04",
      "output": "Building.Rack.DAQ.AO 3/01"
    }
  }
}

“io” Object Members

input	An optional string value describing the skill data point that should be used as input. The string value must contain the primary key of the skill data point. The given skill data point must support the input direction. If you omit the “input” member, the data point will not be readable.
output	An optional string value describing the skill data point that should be used for output. The string value must contain the primary key of the skill data point. The given skill data point must support the output direction. If you omit the “output” member, the data point will not be writable.