Dimension Service API  2.0.0
api index

DimensionNode Object

since: 0.6
A dimension node represents a single item within its assigned aspect; a node cannot be moved between aspects. Logically, a node may represent a collection of items in other aspects if such relationships are defined; however, a node is generally managed independently from its relations.

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 Node to external systems, which must be unique within this Node's owning Dimension.

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
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
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

aspect
0.6optional
A reference to the Aspect that contains this Dimension Node.
ancestors
0.6optional
List of zero or more references to other nodes within the same dimension that do (or could) act as ancestors within one or more hierarchical views of the dimension. The special root node is implied and SHOULD NOT be included. Each reference MUST point to a node in a different Aspect than this node and all references MUST point to different Aspects, that is any two elements MUST NOT refer to nodes in a common Aspect. The order of items in the list is undefined and subject to change.

As an optional field, consult the documentation for each individual operation to determine if this field must be defined with a value; most general requests SHOULD NOT require this field. Services MAY set this field in response to a query.

attributes
0.6optional
List of zero or more Attribute values assigned to or inherited by this Node. If an Attribute has no such value, but its Definition specifies a default value, that value will be used instead.

Certain operations may allow the client to select which attributes, if any, are retrieved as a part of that operation. Consult each operation's documentation to determine if Attribute values are required and/or whether the set of Attribute values will be partial or complete.

Related API Resources

Related API Objects

Example 1

{
  "id"     : "cc01e450-fe24-11e2-b778-0800200c9a60",
  "name"   : "US-TX-Houston",
  "label"  : {
    "locale":"en",
    "value" :"Houston"
  },
  "aspect" : {
    "aspectID"   : "85921462-8431-3951-97c0-558f7b5f8ffc",
    "aspectName" : "CITY"
  }
}