Custom attributes

Definitions

Custom attribute definitions are stored uniquely for each resource type and organization, each accompanied by its own schema and offering complete user-defined configurability.

Currently supported resource types: Floor, Space, Asset, Product
and value types: Text, Number, Boolean

Example of registering a custom attribute with the apiFieldName 'department' for the resource type Space.
Corresponding post method.

{
  apiFieldName: 'department',
  description: 'Defines the department the space belongs to.',
  title: 'Department',
  valueType: 'Text'
}

Values

Setting custom attribute values for a specific resource by resourceId and apiFieldName, in this case a specific space.
with the operations endpoint. To remove a value set it to null.

{
  type: 'operation:spaceUpdate'
  nodeId: '<space-id>'
  value: {
    customAttributes: {
      'department': 'Engineering'
    }
  }
}