Retrieve the available value descriptors

GET 
https://demo.openremote.io/api/master/model/valueDescriptors

Retrieve the available value descriptors

Request

Query Parameters

parentId string

Header Parameters

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

Responses

default

default response

application/json

Schema

Schema

property name* ValueDescriptorObject
namestring
Possible values: Value must match regular expression ^\w+(\[\])?$
constraints object[]
Array [
messagestring
type stringrequired
Possible values: []
]
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

Example (auto)

{}

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 'https://demo.openremote.io/api/master/model/valueDescriptors' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

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

Auth

Bearer Token

Parameters

parentId — query

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

ResponseClear

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