Skip to content

AttributeState

HTTP API schema

← HTTP API reference

AttributeState fields

namespacestringRequired

The capability interface namespace for this attribute

namestringRequired

The name of the attribute within the namespace

retrievabilityAttributeRetrievabilityRequired

retrievability: Reference AttributeRetrievability

autoUpdateFrequencyAttributeAutoUpdateFrequencyRequired

autoUpdateFrequency: Reference AttributeAutoUpdateFrequency

errorError

error: Reference Error

valueobject

The attribute value payload, structure depends on the attribute schema

versionstring

Version of the capability attribute schema used for this value.

sampledAtstring

Device or provider reported sample time in UTC. Omitted when the source did not report a sample time; fetching the value does not make an unknown or old sample fresh. Compare with `freshness`, which says whether the sample is recent enough to treat as current.

format: "date-time"

freshnessAttributeFreshness

freshness: Reference AttributeFreshness

View source specification ↗