References¶
References in the system represent the reference of an entity in the system as Hypermedia as the Engine of Application State (HATEOS). Each reference position is represented by an object pair pkid and href.
device: A list of one device that relates the resource to a device resource in the system.
owner: The owner reference would exist if the current resource was created by a Domain Model (feature model)
self: A list of containing a reference to the current resource.
parent (reserved for hierarchy): An entry containing the parent in the hierarchy: zero for root node, one for other resources.
children (reserved for hierarchy): A list of zero or more children in the hierarchy tree below the resource.
For example:
"references": {
"device": [{
"pkid": "",
"href": ""
}],
"owner": [{
"pkid": "",
"href": ""
}],
"self": [{
"pkid": "5135fc0f31790a3000a83b2b",
"href": "/api/data/CallManager/5135fc0f31790a3000a83b2b"
}],
"children": [],
"parent": [{
"pkid": "5135fb8331790a2ffee7d7ab",
"href": "/api/data/HierarchyNode/5135fb8331790a2ffee7d7ab"
}]
}