Dimension Service API  2.0.0
api index

DimensionNodeRef Object

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

Fields

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

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

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

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

aspectID
0.6optional
string
The system-defined internal ID (in UUID canonical string format) of an existing Aspect to which the referenced Node belongs.

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.6optional
string
The name used to identify (to external systems) an existing Aspect to which the referenced Node belongs.

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 both the referenced Node and 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 both the referenced Node and 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 Resources

Related API Objects

Example - both aspect and dimension implied by context

{
  "nodeID"  : "32b16534-406d-3436-b4c6-c61f24874650",
  "nodeName": "SomeNodeName"
}

Example - dimension implied by context

{
  "nodeID"  : "32b16534-406d-3436-b4c6-c61f24874650",
  "nodeName": "SomeNodeName",
  "aspectID"  : "d66b4d40-00af-11e3-b778-0800200c9a66",
  "aspectName": "SomeAspectName"
}

Example - aspect implied by context

{
  "nodeID"  : "32b16534-406d-3436-b4c6-c61f24874650",
  "nodeName": "SomeNodeName",
  "dimID"     : "0e15ca40-00b0-11e3-b778-0800200c9a66",
  "dimName"   : "MyDimension"
}

Example - both aspect and dimension explicitly referenced

{
  "nodeID"  : "32b16534-406d-3436-b4c6-c61f24874650",
  "nodeName": "SomeNodeName",
  "aspectID"  : "d66b4d40-00af-11e3-b778-0800200c9a66",
  "aspectName": "SomeAspectName",
  "dimID"     : "0e15ca40-00b0-11e3-b778-0800200c9a66",
  "dimName"   : "MyDimension"
}