Update attribute values with timestamps

PUT 
https://demo.openremote.io/api/master/asset/attributes/timestamp

Update attribute values with timestamps

Request

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

application/json

Body

array

• Array [

attributeState

object

ref

object

idstring

The asset identifier

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

Example: 7Bt8M3cXEP6BHPh8r47DYf

namestringrequired

The attribute name

Possible values: Value must match regular expression ^\w+$

Example: location

valueobject

ref

object

idstring

The asset identifier

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

Example: 7Bt8M3cXEP6BHPh8r47DYf

namestringrequired

The attribute name

Possible values: Value must match regular expression ^\w+$

Example: location
valueobject
timestampint64
messageIDstring
deletedboolean
realmstring
parentIdstring
oldValueobject
oldValueTimestampint64
pathstring[]
assetNamestring
assetTypestring
createdOndate-time

type

object

namestring

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

constraints

object[]

Array [

messagestring

typestringrequired

]

format

object

useGroupingboolean

minimumIntegerDigitsint32

minimumFractionDigitsint32

maximumFractionDigitsint32

minimumSignificantDigitsint32

maximumSignificantDigitsint32

asBooleanboolean

asDateboolean

asSliderboolean

resolutionnumber

dateStylestring

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

timeStylestring

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

dayPeriodstring

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

hour12boolean

iso8601boolean

weekdaystring

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

erastring

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

yearstring

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

monthstring

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

weekstring

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

daystring

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

hourstring

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

minutestring

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

secondstring

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

fractionalSecondDigitsint32

timeZoneNamestring

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

momentJsFormatstring

asNumberboolean

asOnOffboolean

asPressedReleasedboolean

asOpenClosedboolean

asMomentaryboolean

multilineboolean

unitsstring[]

arrayDimensionsint32

metaUseOnlyboolean

jsonTypestring

• ]

Responses

default

default response

application/json

Schema

Schema

• Array [

ref

object

idstring

The asset identifier

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

Example: 7Bt8M3cXEP6BHPh8r47DYf

namestringrequired

The attribute name

Possible values: Value must match regular expression ^\w+$

Example: location
failurestring

Possible values: [ASSET_NOT_FOUND, ATTRIBUTE_NOT_FOUND, INSUFFICIENT_ACCESS, INVALID_VALUE, INTERCEPTOR_FAILURE, STATE_STORAGE_FAILED, CANNOT_PROCESS, QUEUE_FULL, UNKNOWN, ASSET_ID_MISSING, ATTRIBUTE_NAME_MISSING]

• ]

Example (from schema)

[
  {
    "ref": {
      "id": "7Bt8M3cXEP6BHPh8r47DYf",
      "name": "location"
    },
    "failure": "ASSET_NOT_FOUND"
  }
]

Authorization: oauth2

name: openidtype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  }
}

• curl
• nodejs
• java
• python
• ruby
• csharp
• go
• php
• powershell

• CURL

curl -L -X PUT 'https://demo.openremote.io/api/master/asset/attributes/timestamp' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '[
  {
    "attributeState": {
      "ref": {
        "id": "7Bt8M3cXEP6BHPh8r47DYf",
        "name": "location"
      },
      "value": {}
    },
    "ref": {
      "id": "7Bt8M3cXEP6BHPh8r47DYf",
      "name": "location"
    },
    "value": {},
    "timestamp": 0,
    "messageID": "string",
    "deleted": true,
    "realm": "string",
    "parentId": "string",
    "oldValue": {},
    "oldValueTimestamp": 0,
    "path": [
      "string"
    ],
    "assetName": "string",
    "assetType": "string",
    "createdOn": "2024-07-29T15:51:28.071Z",
    "type": {
      "name": "string",
      "constraints": [
        {
          "message": "string",
          "type": "string"
        }
      ],
      "format": {
        "useGrouping": true,
        "minimumIntegerDigits": 0,
        "minimumFractionDigits": 0,
        "maximumFractionDigits": 0,
        "minimumSignificantDigits": 0,
        "maximumSignificantDigits": 0,
        "asBoolean": true,
        "asDate": true,
        "asSlider": true,
        "resolution": 0,
        "dateStyle": "numeric",
        "timeStyle": "numeric",
        "dayPeriod": "numeric",
        "hour12": true,
        "iso8601": true,
        "weekday": "numeric",
        "era": "numeric",
        "year": "numeric",
        "month": "numeric",
        "week": "numeric",
        "day": "numeric",
        "hour": "numeric",
        "minute": "numeric",
        "second": "numeric",
        "fractionalSecondDigits": 0,
        "timeZoneName": "numeric",
        "momentJsFormat": "string",
        "asNumber": true,
        "asOnOff": true,
        "asPressedReleased": true,
        "asOpenClosed": true,
        "asMomentary": true,
        "multiline": true
      },
      "units": [
        "string"
      ],
      "arrayDimensions": 0,
      "metaUseOnly": true,
      "jsonType": "string"
    }
  }
]'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

Parameters

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

Body

[
  {
    "attributeState": {
      "ref": {
        "id": "7Bt8M3cXEP6BHPh8r47DYf",
        "name": "location"
      },
      "value": {}
    },
    "ref": {
      "id": "7Bt8M3cXEP6BHPh8r47DYf",
      "name": "location"
    },
    "value": {},
    "timestamp": 0,
    "messageID": "string",
    "deleted": true,
    "realm": "string",
    "parentId": "string",
    "oldValue": {},
    "oldValueTimestamp": 0,
    "path": [
      "string"
    ],
    "assetName": "string",
    "assetType": "string",
    "createdOn": "2024-07-29T15:51:28.071Z",
    "type": {
      "name": "string",
      "constraints": [
        {
          "message": "string",
          "type": "string"
        }
      ],
      "format": {
        "useGrouping": true,
        "minimumIntegerDigits": 0,
        "minimumFractionDigits": 0,
        "maximumFractionDigits": 0,
        "minimumSignificantDigits": 0,
        "maximumSignificantDigits": 0,
        "asBoolean": true,
        "asDate": true,
        "asSlider": true,
        "resolution": 0,
        "dateStyle": "numeric",
        "timeStyle": "numeric",
        "dayPeriod": "numeric",
        "hour12": true,
        "iso8601": true,
        "weekday": "numeric",
        "era": "numeric",
        "year": "numeric",
        "month": "numeric",
        "week": "numeric",
        "day": "numeric",
        "hour": "numeric",
        "minute": "numeric",
        "second": "numeric",
        "fractionalSecondDigits": 0,
        "timeZoneName": "numeric",
        "momentJsFormat": "string",
        "asNumber": true,
        "asOnOff": true,
        "asPressedReleased": true,
        "asOpenClosed": true,
        "asMomentary": true,
        "multiline": true
      },
      "units": [
        "string"
      ],
      "arrayDimensions": 0,
      "metaUseOnly": true,
      "jsonType": "string"
    }
  }
]

ResponseClear

Click the Send API Request button above and see the response here!