Dimension Object

id

0.6required when...

name is not set

string

The system-defined internal object ID (in UUID canonical string format).

If both the id and name fields are present, then the id field should take precedent to avoid ambiguity in cases where the ID and name could be mismatched.

name

0.6required when...

id is not set

string

The name used to identify the dimension to external systems, which must be unique within the set of dimensions belonging to the same owner.

If both the id and name fields are present, then the id field should take precedent to avoid ambiguity in cases where the ID and name could be mismatched.

0.6 min length: 1

0.6 max length: 255

label

0.6optional

LocalizedString

Human-readable, descriptive text shown to users instead of the machine-readable or cryptic id/name fields. The value may vary based on the requesting user's language and locale preferences (subject to available content).

locales

0.6optional

array of string

List of locales (language + optional region + optional variants) that are configured for this dimension. Generally, localized content (e.g. label) should be available for each distinct value in this list.

Locale strings must conform to IETF BCP-47: Tags for Identifying Languages.

defaultLocale

0.6optional

string

The default locale that will be used by this Dimension when there is no other suitable locale available. The value of this field must appear in the list of locales specified by the locales field.

labels

0.6optional

array of LocalizedString

List of all the human-readable, descriptive text strings that describe this Dimension. This list should contain one entry for each locale listed in the locales field, but may contain supplemental entries.

For instance, a dimension configured for three(3) languages English (en = 'Colors'), Spanish (es = 'Colores'), and French (fr = 'Couleurs') may also have a fourth region-specific label for British English (en-GB = 'Colours') to accomodate the appropriate spelling.

rootAspect

0.6optional

DimensionAspect

Describes and identifies the Aspect that contains the rootNode of this Dimension; this Aspect always logically exists.

rootNode

0.6optional

DimensionNode

Describes and identifies the single Root Node for this Dimension; this Node always logically exists.

aspects

0.6optional

array of DimensionAspect

List of all the explicitly configured Aspects in this Dimension.

The special Root Aspect is intrinsic to the dimension and implicitly defined; as such, it has its own rootAspect field and does not appear in this list.

nodeAttributes

0.6optional

array of AttributeDefinition

List of all Node-level Attribute Definitions in this Dimension. Each definition describes the type of data (and any type-specific constraints for that type) that can be stored for that attribute. These definitions are metadata; the actual attribute values must be associated with and stored on individual Nodes in the dimension.

Fields

Related API Resources

Example 1

id 0.6required when... `name` is not set string	The system-defined internal object ID (in UUID canonical `string` format). If both the `id` and `name` fields are present, then the `id` field should take precedent to avoid ambiguity in cases where the ID and name could be mismatched.
name 0.6required when... `id` is not set string	The name used to identify the dimension to external systems, which must be unique within the set of dimensions belonging to the same owner. If both the `id` and `name` fields are present, then the `id` field should take precedent to avoid ambiguity in cases where the ID and name could be mismatched. 0.6 min length: `1` 0.6 max length: `255`
label 0.6optional LocalizedString	Human-readable, descriptive text shown to users instead of the machine-readable or cryptic `id`/`name` fields. The value may vary based on the requesting user's language and locale preferences (subject to available content).
locales 0.6optional array of string	List of locales (language + optional region + optional variants) that are configured for this dimension. Generally, localized content (e.g. `label`) should be available for each distinct value in this list. Locale strings must conform to IETF BCP-47: Tags for Identifying Languages.
defaultLocale 0.6optional string	The default locale that will be used by this Dimension when there is no other suitable locale available. The value of this field must appear in the list of locales specified by the `locales` field.
labels 0.6optional array of LocalizedString	List of all the human-readable, descriptive text strings that describe this Dimension. This list should contain one entry for each locale listed in the `locales` field, but may contain supplemental entries. For instance, a dimension configured for three(3) languages English (en = 'Colors'), Spanish (es = 'Colores'), and French (fr = 'Couleurs') may also have a fourth region-specific label for British English (en-GB = 'Colours') to accomodate the appropriate spelling.
rootAspect 0.6optional DimensionAspect	Describes and identifies the Aspect that contains the `rootNode` of this Dimension; this Aspect always logically exists.
rootNode 0.6optional DimensionNode	Describes and identifies the single Root Node for this Dimension; this Node always logically exists.
aspects 0.6optional array of DimensionAspect	List of all the explicitly configured Aspects in this Dimension. The special Root Aspect is intrinsic to the dimension and implicitly defined; as such, it has its own `rootAspect` field and does not appear in this list.
nodeAttributes 0.6optional array of AttributeDefinition	List of all Node-level Attribute Definitions in this Dimension. Each definition describes the type of data (and any type-specific constraints for that type) that can be stored for that attribute. These definitions are metadata; the actual attribute values must be associated with and stored on individual Nodes in the dimension.