Skip to main content
Version: 1.28.0

AssetTreeNode

asset object

Polymorphic OpenRemote asset. The type discriminator selects a registered asset subtype; attributes are keyed by attribute name.

type string

Polymorphic OpenRemote asset. The type discriminator selects a registered asset subtype; attributes are keyed by attribute name.

Possible values: []

accessPublicReadboolean

Allows anonymous callers to read this asset where an endpoint supports public access.

Example: false
attributes object

Attributes keyed by attribute name. Each entry contains type, value, timestamp, and optional metadata.

delegate object
property name* AttributeObject

Named typed asset value. Attribute JSON includes name, type, value, optional Unix-millisecond timestamp, and optional metadata.

meta object
delegate object
property name* MetaItemObject
namestringrequired

Machine-readable name.

Possible values: non-empty, Value must match regular expression ^\w+$

Example: temperature
type object
arrayDimensionsinteger<int32>
constraints object[]
  • Array [
    • messagestring
    type stringrequired

    Possible values: []

  • ]
    • format object
    asBooleanboolean
    asDateboolean
    asMomentaryboolean
    asNumberboolean
    asOnOffboolean
    asOpenClosedboolean
    asPressedReleasedboolean
    asSliderboolean
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsinteger<int32>
    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    maximumFractionDigitsinteger<int32>
    maximumSignificantDigitsinteger<int32>
    minimumFractionDigitsinteger<int32>
    minimumIntegerDigitsinteger<int32>
    minimumSignificantDigitsinteger<int32>
    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    multilineboolean
    resolutionnumber
    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    useGroupingboolean
    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    jsonTypestring
    metaUseOnlyboolean
    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    unitsstring[]
    property name* MetaItemObject
    namestringrequired

    Machine-readable name.

    Possible values: non-empty, Value must match regular expression ^\w+$

    Example: temperature
    type object
    arrayDimensionsinteger<int32>
    constraints object[]
  • Array [
    • messagestring
    type stringrequired

    Possible values: []

  • ]
    • format object
    asBooleanboolean
    asDateboolean
    asMomentaryboolean
    asNumberboolean
    asOnOffboolean
    asOpenClosedboolean
    asPressedReleasedboolean
    asSliderboolean
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsinteger<int32>
    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    maximumFractionDigitsinteger<int32>
    maximumSignificantDigitsinteger<int32>
    minimumFractionDigitsinteger<int32>
    minimumIntegerDigitsinteger<int32>
    minimumSignificantDigitsinteger<int32>
    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    multilineboolean
    resolutionnumber
    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    useGroupingboolean
    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    jsonTypestring
    metaUseOnlyboolean
    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    unitsstring[]
    namestringrequired

    Machine-readable name.

    Possible values: non-empty, Value must match regular expression ^\w+$

    Example: temperature
    timestampinteger<int64>

    Value timestamp in Unix milliseconds; zero means no explicit timestamp was supplied.

    Example: 1767225600000
    type object
    arrayDimensionsinteger<int32>
    constraints object[]
  • Array [
    • messagestring
    type stringrequired

    Possible values: []

  • ]
    • format object
    asBooleanboolean
    asDateboolean
    asMomentaryboolean
    asNumberboolean
    asOnOffboolean
    asOpenClosedboolean
    asPressedReleasedboolean
    asSliderboolean
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsinteger<int32>
    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    maximumFractionDigitsinteger<int32>
    maximumSignificantDigitsinteger<int32>
    minimumFractionDigitsinteger<int32>
    minimumIntegerDigitsinteger<int32>
    minimumSignificantDigitsinteger<int32>
    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    multilineboolean
    resolutionnumber
    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    useGroupingboolean
    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    jsonTypestring
    metaUseOnlyboolean
    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    unitsstring[]
    property name* AttributeObject

    Named typed asset value. Attribute JSON includes name, type, value, optional Unix-millisecond timestamp, and optional metadata.

    meta object
    delegate object
    property name* MetaItemObject
    namestringrequired

    Machine-readable name.

    Possible values: non-empty, Value must match regular expression ^\w+$

    Example: temperature
    type object
    arrayDimensionsinteger<int32>
    constraints object[]
  • Array [
    • messagestring
    type stringrequired

    Possible values: []

  • ]
    • format object
    asBooleanboolean
    asDateboolean
    asMomentaryboolean
    asNumberboolean
    asOnOffboolean
    asOpenClosedboolean
    asPressedReleasedboolean
    asSliderboolean
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsinteger<int32>
    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    maximumFractionDigitsinteger<int32>
    maximumSignificantDigitsinteger<int32>
    minimumFractionDigitsinteger<int32>
    minimumIntegerDigitsinteger<int32>
    minimumSignificantDigitsinteger<int32>
    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    multilineboolean
    resolutionnumber
    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    useGroupingboolean
    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    jsonTypestring
    metaUseOnlyboolean
    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    unitsstring[]
    property name* MetaItemObject
    namestringrequired

    Machine-readable name.

    Possible values: non-empty, Value must match regular expression ^\w+$

    Example: temperature
    type object
    arrayDimensionsinteger<int32>
    constraints object[]
  • Array [
    • messagestring
    type stringrequired

    Possible values: []

  • ]
    • format object
    asBooleanboolean
    asDateboolean
    asMomentaryboolean
    asNumberboolean
    asOnOffboolean
    asOpenClosedboolean
    asPressedReleasedboolean
    asSliderboolean
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsinteger<int32>
    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    maximumFractionDigitsinteger<int32>
    maximumSignificantDigitsinteger<int32>
    minimumFractionDigitsinteger<int32>
    minimumIntegerDigitsinteger<int32>
    minimumSignificantDigitsinteger<int32>
    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    multilineboolean
    resolutionnumber
    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    useGroupingboolean
    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    jsonTypestring
    metaUseOnlyboolean
    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    unitsstring[]
    namestringrequired

    Machine-readable name.

    Possible values: non-empty, Value must match regular expression ^\w+$

    Example: temperature
    timestampinteger<int64>

    Value timestamp in Unix milliseconds; zero means no explicit timestamp was supplied.

    Example: 1767225600000
    type object
    arrayDimensionsinteger<int32>
    constraints object[]
  • Array [
    • messagestring
    type stringrequired

    Possible values: []

  • ]
    • format object
    asBooleanboolean
    asDateboolean
    asMomentaryboolean
    asNumberboolean
    asOnOffboolean
    asOpenClosedboolean
    asPressedReleasedboolean
    asSliderboolean
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsinteger<int32>
    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    maximumFractionDigitsinteger<int32>
    maximumSignificantDigitsinteger<int32>
    minimumFractionDigitsinteger<int32>
    minimumIntegerDigitsinteger<int32>
    minimumSignificantDigitsinteger<int32>
    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    multilineboolean
    resolutionnumber
    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    useGroupingboolean
    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    jsonTypestring
    metaUseOnlyboolean
    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    unitsstring[]
    createdOnstring<date-time>

    Server-assigned asset creation time.

    Example: 2026-01-01T00:00:00Z
    idstring

    Stable 22-character asset identifier. Omit when creating an asset.

    Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

    Example: 7A6p4AnLTkKxJUCQAAABAA
    namestringrequired

    Human-readable asset name.

    Possible values: non-empty and <= 1023 characters

    Example: Boiler room sensor
    parentIdstring

    Parent asset identifier. Omit for a root asset.

    Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

    Example: 1ZyG7BmsTQ2cGmbuaMsi0A
    pathstring[]

    Ancestor identifiers from the root through the parent.

    realmstringrequired

    Realm that owns the asset; immutable after creation.

    Possible values: non-empty and <= 255 characters

    Example: building
    versioninteger<int64>

    Optimistic-lock version. Omit when creating an asset and preserve the latest value when updating it.

    Possible values: >= 0

    Example: 3
    children []
  • Array [
    • circular(AssetTreeNode)
  • ]
    • AssetTreeNode
    {
      "asset": {
        "accessPublicRead": false,
        "attributes": {
          "delegate": {}
        },
        "createdOn": "2026-01-01T00:00:00Z",
        "id": "7A6p4AnLTkKxJUCQAAABAA",
        "name": "Boiler room sensor",
        "parentId": "1ZyG7BmsTQ2cGmbuaMsi0A",
        "path": [
          "string"
        ],
        "realm": "building",
        "type": "ThingAsset",
        "version": 3
      },
      "children": [
        null
      ]
    }