Retrieve the asset type information of an asset type

GET 
/model/assetInfo/:assetType

Retrieve the asset type information of an asset type

Request

Path Parameters

assetType stringrequired

Query Parameters

parentId string

Header Parameters

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

Responses

default

default response

application/json

Schema

Schema

assetDescriptor

object

namestring

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

iconstring

colourstring

dynamicboolean

descriptorTypestringrequired

attributeDescriptors

object[]

Array [

namestring

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

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[]

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+$

optionalboolean

]

metaItemDescriptors

object[]

Array [

namestring

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

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[]

]

valueDescriptors

object[]

Array [

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

]

Example (from schema)

{
  "assetDescriptor": {
    "name": "string",
    "icon": "string",
    "colour": "string",
    "dynamic": true,
    "descriptorType": "string"
  },
  "attributeDescriptors": [
    {
      "name": "string",
      "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"
      },
      "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"
      ],
      "meta": {
        "delegate": {}
      },
      "optional": true
    }
  ],
  "metaItemDescriptors": [
    {
      "name": "string",
      "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"
      },
      "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"
      ]
    }
  ],
  "valueDescriptors": [
    {
      "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"
    }
  ]
}