AttributeDescription

Attribute description schema defining the structure and metadata for attributes.

Serves as a template that defines how attributes should be structured and displayed. Contains type information, the entity type, localization settings, and default values that govern attribute behavior across the system.

An attribute description is the definition/blueprint of an attribute, specifying what entity it applies to (product, company, etc.), what data type it is (text, int, etc.), localized descriptions, and default values. The actual attributes are just the specific values assigned to objects using this description as their template. You must first define the attribute description, then use it to assign values to specific objects.

type AttributeDescription {
  id: String!
  name: String!
  descriptions: [LocalizedString!]!
  units: [LocalizedString!]
  attributeClass: AttributeDescriptionClass!
  type: AttributeType!
  valuesetId: Int
  group: String
  isSearchable: Boolean!
  isPublic: Boolean!
  isSystem: Boolean!
  isHidden: Boolean!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdBy: Int
  lastModifiedBy: Int
  defaultValue: AttributeValue!
}

Fields

AttributeDescription.id ● String! non-null scalar

Unique identifier for this attribute description.

This UUID serves as the primary key and is automatically generated when the attribute description is created. Used to reference this description when creating attribute values and establishing relationships.

AttributeDescription.name ● String! non-null scalar

Human-readable identifier name for this attribute description.

Must be in SCREAMING_SNAKE_CASE format with maximum length of 64 characters. Must be unique within the attribute class. Used as a stable reference for the attribute description across different environments.

AttributeDescription.descriptions ● [LocalizedString!]! non-null object

Localized human-readable descriptions explaining what this attribute represents.

Provides user-friendly explanations in multiple languages for display in user interfaces and documentation. Each entry contains a language code and the corresponding description text.

AttributeDescription.units ● [LocalizedString!] list object

Localized units of measurement for the attribute value.

Specifies the units in which the attribute value is measured (e.g., "cm", "kg", "pieces") in multiple languages. Only applicable for numeric attribute types.

AttributeDescription.attributeClass ● AttributeDescriptionClass! non-null enum

Entity type that this attribute description applies to. One of: [product, category, cluster, customer, contact, company]

Specifies which type of resource can have attribute value based on this description. Each class has its own namespace for attribute names.

AttributeDescription.type ● AttributeType! non-null enum

The type of the attribute. One of: [TEXT, ENUM, COLOR, DATETIME, INT, DECIMAL]

Determines how attribute values are stored depending on what this attribute is used for.

AttributeDescription.valuesetId ● Int scalar

Reference to a valueset that provides predefined options when the attribute type is ENUM.

Required for ENUM-type attributes to define the available selection options. The referenced valueset should already exist and contain valueset items that define the valid choices users can select when assigning attribute values to objects.

AttributeDescription.group ● String scalar

Logical grouping identifier for related attributes.

Used to organize attributes into categories for better management and user interface organization. Attributes in the same group are typically displayed together.

AttributeDescription.isSearchable ● Boolean! non-null scalar

Enable this attribute for search and filtering operations.

When true, attributes based on this description can be used in search filters and faceted navigation. Useful for attributes that help users find and filter products or other resources.

AttributeDescription.isPublic ● Boolean! non-null scalar

Make this attribute visible to end users.

When true, attributes based on this description are displayed in public interfaces like product specifications. When false, they are only visible to administrative users.

AttributeDescription.isSystem ● Boolean! non-null scalar

Restrict access to system administrators only.

When true, only users with system-level permissions can view and modify attributes based on this description. Used for internal system attributes.

AttributeDescription.isHidden ● Boolean! non-null scalar

Hide this attribute from all user interfaces.

When true, attributes based on this description are completely hidden from user interfaces and are only used for internal processing and background operations.

AttributeDescription.createdAt ● DateTime! non-null scalar

Date and time this attribute description was created.

Timestamp of when the attribute description was first created in the system. Used for auditing and tracking the creation history of attribute descriptions.

AttributeDescription.lastModifiedAt ● DateTime! non-null scalar

Date and time this attribute description was last modified.

Timestamp of when the attribute description was last updated in the system. Used for auditing and tracking the modification history of attribute descriptions.

AttributeDescription.createdBy ● Int scalar

ID of the user that created this attribute description.

References the user ID of the user who created the attribute description. Used for auditing and tracking the creation history of attribute descriptions.

AttributeDescription.lastModifiedBy ● Int scalar

ID of the user that last modified this attribute description.

References the user ID of the user who last modified the attribute description. Used for auditing and tracking the modification history of attribute descriptions.

AttributeDescription.defaultValue ● AttributeValue! non-null interface

Default value configuration for attributes based on this description.

Specifies the initial value that will be assigned to new attributes created from this description. The value type must match the attribute type specified above.

Returned By

attributeDescription query ● attributeDescriptionCreate mutation ● attributeDescriptionUpdate mutation

Member Of

Attribute interface ● AttributeDescriptionResponse object ● AttributeFilter object ● AttributeResult object ● CategoryAttribute object ● ClusterAttribute object ● CompanyAttribute object ● ContactAttribute object ● CustomerAttribute object ● ProductAttribute object