opCharts Latest Data API

Latest Data API 

This opCharts API provides access to the Latest Data collection in a JSON format. This collection holds the raw values collected in the "data" section and all "stats" data in the "derived_data" section, the properties found in these sections are dynamic and are defined by the model used for the node. Each document in the collection has a link's to its associated inventory_id and a subconcept array. Each entry in the suboncepts array holds a document with the subconcept name as well as a data and derived_data sub documents. There is a single record per inventory_id and the record holds the most recent readings/calculations for that piece of inventory.

The Latest Data API is available in opCharts from version 4.8.0

Authentication is required to access all methods below. See opCharts REST API Reference.

Public API for opCharts Latest Data "http[s]://server/omk/opCharts/v2/latest_data"

We can view opCharts Latest Data below using these endpoints - http[s]://server/omk/opCharts/v2/latest_data

API Routes

Request Modifiers (query parameters)

The properties request modifier tells opCharts which properties you would like listed, query limits the requested resources to only those that match all criteria given. This collection can paginated, it is also limited to 25 results by default (this could be subject to change in future opCharts versions) use the limit query parameter to request more nodes

Not all requests will use all request modifiers.

Examples of how to use the request modifiers can be found in the response blocks below.  In general, the queries will look something like this: 

GET of opcharts/v2/latest_data for List

GET /omk/opCharts/v2/latest_data

You will get a list of all the Status records in your database.

Successful Response

Unsuccessful Response

Example

GET HTTP://server/omk/opCharts/v2/status.json

Output:- List of first 25 status objects, sorted by id
[
	{
		"id": "648a0e4ca44a3ab377278383",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
	{
		"id": "648a0e4ca44a3ab377278389",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
	{
		"id": "648a0e4ca44a3ab37727838c",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
	{
		"id": "648a0e4ca44a3ab377278542",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
    . . .
]

GET of opcharts/v2/latest_data/id 

GET /omk/opCharts/v2/latest_data/id

You will get a single objects for the given id in your database.

You can use Request Modifiers (see above) for filtering, pagination, and selecting properties.

Successful Response

Unsuccessful Response

Example