AttributeDescription

No description

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

Autogenerated ID of the AttributeDescription

AttributeDescription.name ● String! non-null scalar

Descriptive identifier for this AttributeDescription

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

The human readable description of the attribute's name. This is a language specific value.

AttributeDescription.units ● [LocalizedString!] list object

Attribute unit per language

AttributeDescription.attributeClass ● AttributeDescriptionClass! non-null enum

The class for this attribute. One of: [PRODUCT, CATEGORY, CLUSTER, CUSTOMER, CONTACT, COMPANY]

AttributeDescription.type ● AttributeType! non-null enum

The type of the attribute. One of: [PRODUCT, CATEGORY, CLUSTER, CUSTOMER, CONTACT, COMPANY]

AttributeDescription.valuesetId ● Int scalar

The ID of the connected valueset to use when type is ENUM

AttributeDescription.group ● String scalar

The group this attribute belongs to, generally linked to a valueset.

AttributeDescription.isSearchable ● Boolean! non-null scalar

Flags whether this attribute should be used when generating catalog page filters

AttributeDescription.isPublic ● Boolean! non-null scalar

Flags whether this attribute should be used when generating product specifications.

AttributeDescription.isSystem ● Boolean! non-null scalar

When true, only admin users can access the attribute and its values

AttributeDescription.isHidden ● Boolean! non-null scalar

Flags whether this attribute is hidden and should only be used for background operations.

AttributeDescription.createdAt ● DateTime! non-null scalar

Attribute description creation date

AttributeDescription.lastModifiedAt ● DateTime! non-null scalar

Attribute description last modified date

AttributeDescription.createdBy ● Int scalar

The ID of the user that created the attribute description

AttributeDescription.lastModifiedBy ● Int scalar

The ID of the user that last modified the attribute description

AttributeDescription.defaultValue ● AttributeValue! non-null interface

The default value for this attribute

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