Schemas

Changed

Property Type Description

lastLog

List of string

Code

One of:

  • Property Type Description
    javaScript*

    string

Command

Property Type Description

encoding

Command_encoding

The encoding of the command

mode

Command_mode

If the command should be sent actively after the period expired.
period*

string

The period when a command will be sent out to reconcile.

CommandEncoding

One of:

  • string

  • Property Type Description

    | Property | Type | Description

    a|

    channel*

    | string

    a|

    a|

    device*

    | string

    a|

  • Property Type Description
    channel*

    string

CommandMode

Type: string

Command_encoding

The encoding of the command

All of:

Command_mode

If the command should be sent actively after the period expired.

All of:

Deleting

Type:

Map of objects

DesiredFeature

Property Type Description
lastUpdate*

string

(date-time)

The timestamp the desired value was last updated.

method

DesiredFeature_method

The method of reconciliation.

mode

DesiredFeature_mode

The mode this value should be applied with.

reconciliation

DesiredFeature_reconciliation

The current reconciliation state of the desired value.

validUntil

string

(date-time)

An optional indication until when the desired value is valid.

value

DesiredFeature_value

The value the system desired the device to apply. If the value is not set, then nothing will be reconciled.

DesiredFeatureMethod

One of:

  • string

  • Property Type Description
    command*

    Command

  • Property Type Description
    code*

    Code

DesiredFeatureReconciliation

One of:

  • Property Type Description

    lastAttempt

    string

    (date-time)
    state*

    string

    • reconciling

  • Property Type Description
    state*

    string

    • succeeded
    when*

    string

    (date-time)

  • Property Type Description

    reason

    string
    state*

    string

    • failed
    when*

    string

    (date-time)

  • Property Type Description
    state*

    string

    • disabled
    when*

    string

    (date-time)

DesiredFeature_method

The method of reconciliation.

All of:

DesiredFeature_mode

The mode this value should be applied with.

All of:

DesiredFeature_reconciliation

The current reconciliation state of the desired value.

All of:

DesiredFeature_value

The value the system desired the device to apply. If the value is not set, then nothing will be reconciled.

Unknown

DesiredMode

The mode of the desired feature.

Type: string

DesiredStateUpdate

A more flexible update struct for [DesiredFeature].

Property Type Description

method

DesiredStateUpdate_method

mode

DesiredStateUpdate_mode

reconciliation

DesiredStateUpdate_reconciliation

validFor

string

Durations in a format intended for humans:

The format uses a combination of amount and time unit (like: h, m, s) to define a duration. For example:

  • 1m = 1 minute = 60 seconds
  • 30s = 30 seconds
  • 1h 30m = 90 minutes

Time units are:

  • ms, millis, msec = milliseconds
  • s, seconds, second, secs, sec = seconds
  • m, minutes, minute, mins, min = minutes
  • h, hours, hour, hrs, hrs = hours
  • d, days, day = days
  • w, weeks, week = weeks
  • M, months, month = month (=30.44d)
  • y, years, year = year (=365.25d)

validUntil

string

(date-time)

value

DesiredStateUpdate_value

DesiredStateUpdate_method

All of:

DesiredStateUpdate_mode

All of:

DesiredStateUpdate_reconciliation

All of:

DesiredStateUpdate_value

Unknown

ErrorInformation

Property Type Description
error*

string

message

string

items

One of:

  • Unknown

  • Unknown

  • Unknown

JsonSchema

One of:

  • Property Type Description
    schema*

    Unknown
    version*

    string

    • draft7

Metadata

Property Type Description

annotations

Map of string
application*

string

creationTimestamp

string

(date-time)

deletionTimestamp

string

(date-time)

generation

integer

(uint32)

labels

Map of string
name*

string

resourceVersion

string

uid

string

path

A JSON Pointer path.

Type: string

Reconciliation

Property Type Description

changed

Map of Changed

deleting

Map of Deleting

timers

Map of Timer

ReportedFeature

Property Type Description
lastUpdate*

string

(date-time)
value*

ReportedFeature_value

ReportedFeature_value

Unknown

RequestBodyApiV1alpha1ThingsApplicationThingsThingDesiredStatesNameValuePutApplicationJson

Unknown

Schema

One of:

SyntheticFeature

Property Type Description
lastUpdate*

string

(date-time)
value*

SyntheticFeature_value

SyntheticFeature_value

Unknown

Thing

The full thing model.

Property Type Description

desiredState

Map of DesiredFeature
metadata*

Metadata

reconciliation

Reconciliation

reportedState

Map of ReportedFeature

schema

Thing_schema

syntheticState

Map of SyntheticFeature

Thing_schema

All of:

Timer

Property Type Description

initialDelay

string

an optional, initial delay. if there is none, the time will be run the first time it is configured

lastLog

List of string

the logs of the last run

lastRun

string

(date-time)

the timestamp the timer last ran

lastStarted

string

(date-time)

the latest timestamp the timer was started
period*

string

the period the timer is scheduled

stopped

boolean

A flag to stop the timer