Skip to main content

Attribute

Base interface for all attribute types across different entity classes.

Attributes provide extensible metadata and properties for various entities in the system. Each attribute is associated with a specific entity type and contains typed values based on its attribute description schema.

interface Attribute {
id: String!
value: AttributeValue!
createdAt: DateTime!
lastModifiedAt: DateTime!
createdBy: Int
lastModifiedBy: Int
attributeDescription: AttributeDescription
}

Fields

Attribute.id ● String! non-null scalar

Unique identifier for this attribute instance.

Auto-generated UUID that serves as the primary key for this specific attribute. Used to reference and manage individual attribute instances.

Attribute.value ● AttributeValue! non-null interface

The actual value data stored in this attribute.

Contains the attribute value in the appropriate format based on the attribute description's type definition. The value structure varies depending on the attribute type (text, enum, color, etc.).

Attribute.createdAt ● DateTime! non-null scalar

Timestamp when this attribute was originally created.

Records the exact date and time when this attribute instance was first created in the system. Used for audit trails and data lifecycle management.

Attribute.lastModifiedAt ● DateTime! non-null scalar

Timestamp when this attribute was last modified.

Records the most recent date and time when any changes were made to this attribute's value or configuration. Updated automatically on each modification.

Attribute.createdBy ● Int scalar

Identifier of the user who created this attribute.

References the user account that originally created this attribute instance. May be 0 for system-generated attributes or when user information is not available.

Attribute.lastModifiedBy ● Int scalar

Identifier of the user who last modified this attribute.

References the user account that made the most recent changes to this attribute. May be 0 for system modifications or when user information is not available.

Attribute.attributeDescription ● AttributeDescription object

Retrieve the attribute description that defines this attribute's schema and behavior.

Returns the complete attribute description containing metadata, type definitions, display configuration, and localization settings. This description serves as the template that defines how this attribute should behave and be presented.

Essential for understanding attribute constraints, available operations, and presentation requirements. Used by client applications for form generation, validation, and display formatting.

Returned By

attribute query ● attributeCreate mutation ● attributeUpdate mutation

Member Of

AttributeResponse object ● AttributeResult object

Implemented By

CategoryAttribute object ● ClusterAttribute object ● CompanyAttribute object ● ContactAttribute object ● CustomerAttribute object ● ProductAttribute object