Dimension Service API 2.0.0

as of version:

DimensionAspect Object

since: 0.6

An aspect represents a collection of zero or more nodes with a uniform type, purpose, or "granularity" of detail. Some examples of aspects within common dimensions are:

Location dimension: continent, country, region, state, city
Time dimension: year, quarter, month, week, day
Product dimension: category, group, sub-group, sku

Fields

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 this Aspect to external systems, which must be unique within the Dimension that contains this Aspect. 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).
labels 0.6optional array of LocalizedString	List of all the human-readable, descriptive text strings that describe this Aspect. This list should contain one entry for each locale configured in the owning Dimenson, but may contain entries for additional locales. See: Dimension.locales

Related API Resources

Related API Objects

Dimension

Example 1

{
  "id"     :"5289492c-f082-346c-a4a6-eec9f72f1ec3",
  "name"   :"WORLD",
  "label"  :{
    "locale":"en",
    "value" :"The World"
  }
}