Skip to main content

attributeDescription

Retrieve comprehensive information about a specific attribute description by its unique identifier.

Returns complete attribute description data including schema definitions, display configuration, localization settings, and metadata. Used for attribute definition management, UI generation, and understanding attribute capabilities.

The response includes all configuration details needed to:

  • Create attribute values based on this description
  • Generate appropriate user interfaces
  • Display attributes with proper formatting
  • Understand attribute constraints and capabilities

Essential for building attribute management systems and ensuring proper attribute handling across applications.

Possible errors:

  • ATTRIBUTE_DESCRIPTION_NOT_FOUND: Attribute description with the specified ID does not exist
attributeDescription(
  id: String!
): AttributeDescription!

Arguments​

attributeDescription.id ● String! non-null scalar​

Unique identifier of the attribute description to retrieve.

Must be a valid UUID format representing an existing attribute description in the system. The description must be accessible within the current context and permissions.

Type​

AttributeDescription object​

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.