General

All requests lists below are JSON requests.  HTML requests will work for these URL's but may return different data.  To guarantee a json request append .json to the end of the url (but not the query string).

Authentication

Authentication is required to access all methods listed below.

POST login (authenticate)

POST /omk/opCharts/login

Authenticate to opCharts. 

Request

Successful Response

A cookie is created and sent with the response.  This must be saved and passed with all requests below.  

Nodes

Nodes are gathered from the NMIS installation on the existing server.  Each node has a list of resources.  Each resource can either be indexed or non-indexed.  If non-indexed each resource contains a list of datasets (which are individual data points over time, eg. avgbusy5).  If indexed, the resource contains an array, each element in that array contains datasets.

GET nodes (fetch list of nodes)

GET /omk/opCharts/nodes/

Retrieves the nodes available to opCharts.  No parameters are accepted.

Successful Response

Returns an array of strings containing the node names 

[
  "odin",
  "sparkle",
  "maverick",
]

GET node resources (fetch resources for a single node)

GET /omk/opCharts/nodes/[node]/resources/

Retrieves all resources for the specified node.  A resource is required when requesting specific datasets or indexed datasets.

Successful Response

Returns an array of resource objects. Each resource object has a value it can be identified by(which can be used in later requests) and a url that the resource value can be appended to in order to fetch information about this resource and it's name which can be displayed to users.

[
  {
    value: "nodehealth",
    url: "/omk/opCharts/nodes/asgard/resources",
    name: "nodehealth"
  },
  {
    value: "mib2ip",
    url: "/omk/opCharts/nodes/asgard/resources",
    name: "mib2ip"
  },
  {
    value: "interface",
    url: "/omk/opCharts/nodes/asgard/resources",
    name: "interface"
  },
  ....
]

GET node resource datasets (fetch datasets for a single node & resource)

GET /omk/opCharts/nodes/[node]/resources/[resource]/

Retrieves all datasets for the specified node & resource.

Successful Response

An array of dataset objects. Each dataset object lists it's resource, the value it can be identified by, a url that the value can be appended to (if not ending in .json), tokens used for searching and it's name which can be used for displaying to users.

Non-indexed:

[
  {
    indexed: "",
    resource_id: "mib2ip",
    value: "ipInAddrErrors",
    url: "/omk/opCharts/nodes/asgard/resources/mib2ip/datasets",
    tokens: [
      "ipInAddrErrors",
      "mib2ip"
    ],
    name: "ipInAddrErrors"
  },
  ...
]

If a dataset is indexed it must be accessed through one of the indexes provided by the resource.  This list can be found using the url listed in the dataset object.

Indexed: 

[
  {
    indexed: "1",
    resource_id: "interface",
    value: "ifOperStatus",
    url: "/omk/opCharts/nodes/asgard/resources/interface/indicies.json",
    tokens: [
      "ifOperStatus",
      "interface"
    ],
    name: "ifOperStatus"
  },
  ...
]

GET node resource indexes (fetch indexes for a node resource)

GET /omk/opCharts/nodes/[node]/resources/[resource]/indicies.json

Retrieve all indexes available from a resource.  This is only required if the dataset you wish to load is indexed.

Successful Response

Returns a hash, with the name of the resource.  A datum array of index objects, these hold the data you are likely looking for.  The value attribute holds the identifier for this object.  Name is the attribute which can be displayed to users.

The list of datasets available for the specified resource along with the list of indexes create an N x M matrix of possible datasets.

{
  name: "interface",
  datum: [
    {
      resource_id: "interface",
      value: "2",
      url: "/omk/opCharts/nodes/asgard/resources/interface/datasets",
      tokens: [
        "WAN/DSL",
        "FastEthernet0/1",
        "2"
      ],
      name: "WAN/DSL -- FastEthernet0/1 -- 2"
    },
    {
      resource_id: "interface",
      value: "1",
      url: "/omk/opCharts/nodes/asgard/resources/interface/datasets",
      tokens: [
        "Opmantek LAN",
        "FastEthernet0/0",
        "1"
      ],
      name: "Opmantek LAN -- FastEthernet0/0 -- 1"
    }
  ],
  header: "interface"
}

Data

GET node resource dataset (fetch data for a single dataset from a node resource)

GET /omk/opCharts/data_model_view/new?requestData=[JSON object]

Request data from a dataset.  The request structure for this 

Request