Skip to main content

PublicPropertiesResponse

List of properties for an organization

properties object[]required
  • Array [
  • codestringrequired

    Code of property for an organization

    namestringrequired

    Name of property for an organization

    typestringrequired

    Type of property for an organization

    temporalitystringrequired

    Temporality of property for an organization

    descriptionstring | nullnullable

    Description of property for an organization

    assetTypesstring[]required

    Asset types of property for an organization

    defaultUnitstring | nullnullable

    Default unit of property for an organization

    enumValuesstring[]nullable

    Enum values of property for an organization

    enumLabels object | null

    Label of each enum value, keyed by value code

    property name*string
    aliasesstring[]required

    Aliases supported for this property

    hasValuesbooleanrequired

    Whether at least one data row exists for this property in the organization

  • ]
  • PublicPropertiesResponse
    {
    "properties": [
    {
    "code": "string",
    "name": "string",
    "type": "string",
    "temporality": "string",
    "description": "string",
    "assetTypes": [
    "string"
    ],
    "defaultUnit": "string",
    "enumValues": "Unknown Type: array,null",
    "enumLabels": {
    "OFFICE": "Bureau"
    },
    "aliases": [
    "string"
    ],
    "hasValues": true
    }
    ]
    }