Skip to main content

HolderTypeView

Holder type information

organizationCodestringrequired

Organization code

Example: ORG123
codestringrequired

Code of the holder type

Example: BUILDING
typestringrequired

Type category

Example: ASSET
naturestring | nullnullable

Nature of the holder type (PHYSICAL, LOGICAL, PROPERTY_DYNAMIC)

Example: PHYSICAL
equipmentDestinationstring | nullnullable

Equipment destination classification

Example: WALL
names object[]required

Localized names for this holder type

  • Array [
    • singularstringrequired

    Singular form of the name

    Example: Building
    pluralstringrequired

    Plural form of the name

    Example: Buildings
    languagestringrequired

    Language code

    Example: en
  • ]
    • numberOfAssets(integer | null)<int32>nullable

    Number of assets of this holder type. Asynchronous: refreshed by a background job, may lag behind asset changes by ~10 minutes

    Example: 42
    hasAssetsboolean | nullnullable

    Whether at least one non-deleted asset of this type or of any of its subtypes exists. Live check, only returned when withHasAssets=true and the holder super type is ASSET. Unlike numberOfAssets (asynchronous and direct assets only), this includes subtype assets: a parent type reports true when only its subtypes hold assets

    Example: true
    importErrors object

    Information about import errors

    oneOf

    Information about import errors

    duplicatesinteger<int32>required

    Number of duplicate entries

    Example: 0
    othersinteger<int32>required

    Number of other errors

    Example: 0
    recommendedPropertyCodesstring[]required

    Codes of properties recommended for this holder type

    Example: ["PROP_AREA","PROP_HEIGHT"]
    mandatoryPropertyCodesstring[]required

    Codes of properties mandatory for this holder type

    Example: ["PROP_REFERENCE"]
    HolderTypeView
    {
      "organizationCode": "ORG123",
      "code": "BUILDING",
      "type": "ASSET",
      "nature": "PHYSICAL",
      "equipmentDestination": "WALL",
      "names": [
        {
          "singular": "Building",
          "plural": "Buildings",
          "language": "en"
        }
      ],
      "numberOfAssets": 42,
      "hasAssets": true,
      "importErrors": {
        "duplicates": 0,
        "others": 0
      },
      "recommendedPropertyCodes": [
        "PROP_AREA",
        "PROP_HEIGHT"
      ],
      "mandatoryPropertyCodes": [
        "PROP_REFERENCE"
      ]
    }