Dimension Service API  2.0.0
api index

DimensionAspectRef Object

since: 0.6
Used to refer to a DimensionAspect by ID or name. In some cases the Dimension of the referenced Aspect may be implied by the context of its use. Otherwise, it may be required to explicitly identify the Aspect's Dimension using the dimID and/or dimName fields.

Fields

aspectID
0.6required when...
aspectName is not set
string
The system-defined internal ID (in UUID canonical string format) of an existing Aspect within the referenced (or implied) Dimension.

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

aspectName
0.6required when...
aspectID is not set
string
The name used to identify (to external systems) an existing Aspect within the referenced (or implied) Dimension.

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

dimID
0.6optional
string
The system-defined internal ID (in UUID canonical string format) of an existing Dimension that contains the referenced Aspect.

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

dimName
0.6optional
string
The name used to identify (to external systems) an existing Dimension that contains the referenced Aspect.

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

Related API Objects

Example - dimension implied by context

{
  "aspectID"  : "d66b4d40-00af-11e3-b778-0800200c9a66",
  "aspectName": "SomeAspectName"
}
  

Example - dimension explicitly referenced

{
  "aspectID"  : "d66b4d40-00af-11e3-b778-0800200c9a66",
  "aspectName": "SomeAspectName",
  "dimID"     : "0e15ca40-00b0-11e3-b778-0800200c9a66",
  "dimName"   : "MyDimension"
}