Skip to main content

Tagging entities

info

The code examples in this article are only documented with the Python API Client. While many concepts still apply for the JavaScript API, implementation details might differ.

Entities can be tagged with one or more tags that allow filtering or querying by this association. Under the hood, tagging is done by creating a custom attribute link directed from the tagged entity to the entity of type Tag. The behaviour is similar to the custom attribute type dynamic enumerator but more flexible. Tags allow you to create virtually unlimited number of tags and still expect good performance.

To tag an entity, we essentially create a CustomAttributeLink :

session.create('CustomAttributeLink', {
  'from_id': my_task_id,
  'to_id': my_tag_id,
  'configuration_id': my_configuration_id
})

If you need to create the CustomAttributeLinkConfiguration entity, please read this.

Limitations​

Projections​

It is currently not possible to use the custom_attribute_links relation as a projection.