Additional Attributes

Introduction

Additional attribute provide configurable fields for entities such as Departments and Roles. An AttributeSet acts as a container for fields (similar to Forms/TaskTemplates), while values are stored per target entity.

Request flow

Before linking AttributeSets to target entities, you should create the attribute set and fill it with attributes.

AttributeSet: Defines the grouping and structure of additional fields.
AttributeFields: Concrete fields inside an AttributeSet.

Target entity linking and attribute value assignment

For entities that use AttributeSets (currently especially Department and Role), the request structure for linking and submitting values follows the same pattern.

Payload keys for creating and updating entities with AttributeSets

for example these endpoints:

PUT /api/departments/{department}
PUT /api/roles/{role}
POST /api/departments/{department}
POST /api/roles/{role}

Key

Type

Description

attribute_set_ids

array

Which AttributeSets should be linked to the target entity.

additional_attributes

object

Values grouped by attributeSet.key and field key (field-{formFieldId}).

`attribute_set_ids` formats

attribute_set_ids supports two formats:

IDs only

{
  "attribute_set_ids": [1, 2, 3]
}

IDs with sorting

{
  "attribute_set_ids": [
    { "id": 1, "sort_number": 1 },
    { "id": 2, "sort_number": 2 }
  ]
}