Skip to main content

ClusterFieldName

Fields available for cluster CSV mapping and data import.

Defines the complete set of cluster properties that can be mapped from CSV files during bulk cluster import operations. Each field corresponds to a specific cluster attribute with validation requirements and data type constraints.

enum ClusterFieldName {
  LANGUAGE
  NAMES
  DESCRIPTIONS
  SHORT_DESCRIPTIONS
  CODE
  CLUSTER_CONFIG_ID
  CLUSTER_ID
  SOURCE_NAME
  SOURCE_ID
  CATEGORY_ID
  CATEGORY_SOURCE_NAME
  CATEGORY_SOURCE_ID
  METADATA_TITLE
  METADATA_DESCRIPTION
  METADATA_KEYWORDS
  METADATA_CANONICAL_URL
  HIDDEN
}

Values

`ClusterFieldName.LANGUAGE`

[Required][String] Cluster default language

`ClusterFieldName.NAMES`

[Required][String] Cluster name

`ClusterFieldName.DESCRIPTIONS`

[Optional][String] Cluster description

`ClusterFieldName.SHORT_DESCRIPTIONS`

[Optional][String] Cluster short description

`ClusterFieldName.CODE`

[Optional][String] Cluster code

`ClusterFieldName.CLUSTER_CONFIG_ID`

[Required][String] Cluster config id

`ClusterFieldName.CLUSTER_ID`

[Optional][String] Cluster id, use either CLUSTER_ID or a combination of SOURCE_NAME and SOURCE_ID

`ClusterFieldName.SOURCE_NAME`

[Optional][String] Cluster source name, use either CLUSTER_ID or a combination of SOURCE_NAME and SOURCE_ID

`ClusterFieldName.SOURCE_ID`

[Optional][String] Cluster source id, use either CLUSTER_ID or a combination of SOURCE_NAME and SOURCE_ID

`ClusterFieldName.CATEGORY_ID`

[Optional][String] The id of the category the cluster should be created in

`ClusterFieldName.CATEGORY_SOURCE_NAME`

[Optional][String] Name of the parent category source, only required when using combination SOURCE_NAME and SOURCE_ID

`ClusterFieldName.CATEGORY_SOURCE_ID`

[Optional][String] Parent category source id, only required when using combination SOURCE_NAME and SOURCE_ID

`ClusterFieldName.METADATA_TITLE`

[Optional][String] [SEO] Localized metadata title

`ClusterFieldName.METADATA_DESCRIPTION`

[Optional][String] [SEO] Localized metadata description

`ClusterFieldName.METADATA_KEYWORDS`

[Optional][String] [SEO] Localized metadata keywords

`ClusterFieldName.METADATA_CANONICAL_URL`

[Optional][String] [SEO] Localized metadata canonical URL

`ClusterFieldName.HIDDEN`

[Optional][Enum] The hidden status of the cluster, must be one of the following: [Y, N. Defaults to N

Member Of

ClusterCsvMapping input