JSON format for model contents
The JSON structure has the following objects:
Key | Required? | Description |
|---|---|---|
nodes | Yes | Object containing information for nodes. |
rels | No | Object containing information for relationships. If not specified, the system finds all the pertinent relationships between the input nodes. |
collections | No | Objects containing information for collections. |
Nodes object
The nodes object is a mapping from hexadecimal node id to an object with the following members. Since all members are optional, it is valid for the node object to be empty.
Key | Required? | Description |
|---|---|---|
removed | No | If true, the node has been explicitly excluded from the model. |
collection_id | No | The id of a collection in the collections object. |
root | No | If true, the node was a root node that the user started from (provided by the topology API). |
depth | No | The depth from the root node (provided by the topology API). |
extra_data | No | An object of opaque data that is stored associated with the node. |
Rels object
rels is an object mapping from hexadecimal relationship id to objects with the following members. Since all members are optional, it is valid for the relationship object to be empty.
Key | Required? | Description |
|---|---|---|
src_id | No | Hexadecimal node id that the relationship impacts from (must be present in the nodes object) as an optimization and sanity check. If not specified, the system can look it up in the datastore. |
tgt_id | No | Hexadecimal node id that the relationship impacts to (must be present in the nodes object) as an optimization and sanity check. If not specified, the system can look it up in the datastore. |
removed | No | If true, the relationship has been explicitly excluded from the model (only for SAM models). |
Collections object
collections is a mapping from collection id to objects with the following members. This information is provided in the topology data.
Key | Required? | Description |
|---|---|---|
name | Yes | Name of the collection. |
short_name | Yes | Short name of the collection. |
type | Yes | Type of collection (currently either "group", meaning group of nodes, or "link", meaning a multi-hop group of nodes and relationships presented as a single link). |
expanded | No | If true, the collection has been expanded in the UI, so the separate members are visible. |
removed | No | If true, the whole collection has been explicitly excluded from the model (only for SAM models). |