Skip to main content

Interface: AttributeDescription

Defined in: type/AttributeDescription.ts:8

Object class for AttributeDescription

Properties​

attributeClass​

attributeClass: AttributeDescriptionClass

Defined in: type/AttributeDescription.ts:19

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

createdAt​

createdAt: string

Defined in: type/AttributeDescription.ts:38

Attribute description creation date

createdBy?​

optional createdBy?: number

Defined in: type/AttributeDescription.ts:42

The ID of the user that created the attribute description

descriptions​

descriptions: LocalizedString[]

Defined in: type/AttributeDescription.ts:15

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

group?​

optional group?: string

Defined in: type/AttributeDescription.ts:25

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

id​

id: string

Defined in: type/AttributeDescription.ts:10

Autogenerated ID of the AttributeDescription

isHidden​

isHidden: boolean

Defined in: type/AttributeDescription.ts:36

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

isPublic​

isPublic: boolean

Defined in: type/AttributeDescription.ts:31

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

isSearchable​

isSearchable: boolean

Defined in: type/AttributeDescription.ts:28

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

isSystem​

isSystem: boolean

Defined in: type/AttributeDescription.ts:33

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

lastModifiedAt​

lastModifiedAt: string

Defined in: type/AttributeDescription.ts:40

Attribute description last modified date

lastModifiedBy?​

optional lastModifiedBy?: number

Defined in: type/AttributeDescription.ts:44

The ID of the user that last modified the attribute description

name​

name: string

Defined in: type/AttributeDescription.ts:12

Descriptive identifier for this AttributeDescription

type​

type: AttributeType

Defined in: type/AttributeDescription.ts:21

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

units?​

optional units?: LocalizedString[]

Defined in: type/AttributeDescription.ts:17

Attribute unit per language

valuesetId?​

optional valuesetId?: number

Defined in: type/AttributeDescription.ts:23

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