Interface: ClusterOption

Defined in: type/ClusterOption.ts:8

Object class for ClusterOption

Properties

clusterId

clusterId: number

Defined in: type/ClusterOption.ts:41

Reference to the cluster that owns the option.

---

clusterOptionId

clusterOptionId: number

Defined in: type/ClusterOption.ts:12

The classID of the cluster that represents this cluster

---

createdAt

createdAt: string

Defined in: type/ClusterOption.ts:33

Timestamp marking when the cluster option was created, in UTC ISO 8601 format.

---

createdBy

createdBy: number

Defined in: type/ClusterOption.ts:35

Identifier of the user account that created the cluster option.

---

defaultProduct?

optional defaultProduct?: Product

Defined in: type/ClusterOption.ts:18

defaultProduct field

---

defaultProductId?

optional defaultProductId?: number

Defined in: type/ClusterOption.ts:43

Identifier of the product preselected as the default choice for the option.

---

descriptions

descriptions: LocalizedString[]

Defined in: type/ClusterOption.ts:24

descriptions field

---

hidden?

optional hidden?: YesNo

Defined in: type/ClusterOption.ts:16

Indicates whether an option is hidden or not

---

id

id: number

Defined in: type/ClusterOption.ts:10

id field

---

isRequired?

optional isRequired?: YesNo

Defined in: type/ClusterOption.ts:14

Indicates whether an option is required or not

---

lastModifiedAt

lastModifiedAt: string

Defined in: type/ClusterOption.ts:37

Timestamp marking the last modification of the cluster option, in UTC ISO 8601 format.

---

lastModifiedBy

lastModifiedBy: number

Defined in: type/ClusterOption.ts:39

Identifier of the user account that last modified the cluster option.

---

names

names: LocalizedString[]

Defined in: type/ClusterOption.ts:22

names field

---

products?

optional products?: Product[]

Defined in: type/ClusterOption.ts:20

products field

---

shortDescriptions

shortDescriptions: LocalizedString[]

Defined in: type/ClusterOption.ts:26

shortDescriptions field

---

sortOrder?

optional sortOrder?: number

Defined in: type/ClusterOption.ts:45

Sort order within the cluster

---

sources

sources: Source[]

Defined in: type/ClusterOption.ts:47

Pairs of external system names and the identifiers each system assigned to the cluster option.

---

tenant

tenant: string

Defined in: type/ClusterOption.ts:31

Identifier of the tenant the cluster option belongs to.

---

uuid

uuid: string

Defined in: type/ClusterOption.ts:29

Globally unique identifier for the cluster option.