Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
# no properties or query requested
# GET /omk/opCharts/v1/nodes/
[
	"$UUID1", # node1
	"$UUID2", # node2,
	...
	"$UUIDn"
]
 
# query only: query=["config.group","group_1","summary.roleType","core"]
# GET /omk/opCharts/v1/nodes/?query=["config.group","group_1","summary.roleType","core"]
[
	"$UUID2",
	"$UUD142"
]
 
# properties only: properties=["name","server_name"]
# GET /omk/opCharts/v1/nodes/?properties=["name","server_name"]
[
	{
		"node_id": "$UUID1",
		"name": "node_name_1",
		"server_name": "server_name"
	},
	...
]

 
# query and properties: query=["node_name","asgard"]&properties=["config.group"]
# GET /omk/opCharts/v1/nodes/?query=["node_name","asgard"]&properties=["config.group"]
[
  {
    "node_id": "C1135780-9AE1-11E4-A17D-1794FCA8A343",
    "config": {
      "group": "Branches"
    }
  }
]

...

Code Block
# no properties specified, all data is returned, this will have some common data structures and some specific to the node / model
# GET /omk/opCharts/v1/nodes/UUID1
{
	"node_id": "$UUID1",
	"name": "node1"
	"config": { ... full of info ... },
	"info": { ... full of info ... },
	"status": { ... full of info ... },
	...
}
# properties=["node_id","config.group","info.system.sysDescr"]
# GET /omk/opCharts/v1/nodes/UUID1?properties=["node_id","config.group","info.system.sysDescr"]
{
	"node_id": "$UUID1",
	"config": {
		group: "group1"
	},
	info: {
		system: {
			sysDescr: "something really long and full of great info"
		}
	}
}