Skip to main content
Version: 1.2.0

Retrieve a partially loaded asset (no attributes or path)

GET 

https://demo.openremote.io/api/master/asset/partial/:assetId

Retrieve a partially loaded asset (no attributes or path)

Request

Path Parameters

    assetId stringrequired

Header Parameters

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

Responses

default response

Schema

    idstring

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

    versionint64
    createdOndate-time
    namestringrequired

    Possible values: non-empty and <= 1023 characters

    accessPublicReadboolean
    parentIdstring

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

    realmstringrequired

    Possible values: non-empty and <= 255 characters

    typestring
    pathstring[]

    attributes

    object

    delegate

    object

    property name*

    AttributeObject

    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
    namestringrequired

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

    meta

    object

    delegate

    object

    property name*

    MetaItemObject

    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
    namestringrequired

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

    property name*

    MetaItemObject

    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
    namestringrequired

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

    timestampint64

    property name*

    AttributeObject

    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
    namestringrequired

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

    meta

    object

    delegate

    object

    property name*

    MetaItemObject

    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
    namestringrequired

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

    property name*

    MetaItemObject

    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
    namestringrequired

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

    timestampint64

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 -L 'https://demo.openremote.io/api/master/asset/partial/:assetId' \
-H 'Authorization: Bearer <token>'
Request Collapse all
Base URL
https://demo.openremote.io/api/master
Auth
Parameters
— pathrequired
— header
— header
— header
ResponseClear

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