Query

Resolves an ORD and returns the results as a table.

Request example

Some real examples:


{"requests":[ {
    "message": "Query",
    "node": "slot:/",
    "query": "bql:select * from nAnalytics:AnalyticsNumericInput"
}]}

Request elements

Request element Value Description
message text Query
Node or node (required) ORD (defaults to a relative ORD slot, which is resolved against the config space to which the Px view is assigned) Defines the ORD to the desired slot.
query ORD Any ORD.

Response example

{ "responses" : [
{
  "message" : "Query",
  "node" : "slot:/",
  "query" : "bql:select * from nAnalytics:AnalyticsNumericInput",
  "columns" : [
    {
      "name" : "Slot Path",
      "type" : "string"
    },
    {
      "name" : "To String",
      "type" : "string"
    },
    {
      "name" : "Resolved Value Ord",
      "type" : "baja:Ord"
    },
    {
      "name" : "Fault Cause",
      "type" : "string"
    },
    {
      "name" : "Facets",
      "type" : "baja:Facets"
    },
    {
      "name" : "Poll Mode",
      "type" : "enum"
    },
    {
      "name" : "History Is Cov",
      "type" : "boolean"
    },
    {
      "name" : "History",
      "type" : "string"
    },
    {
      "name" : "Visible",
      "type" : "boolean"
    },
    {
      "name" : "Priority",
      "type" : "numeric"
    },
    {
      "name" : "Value",
      "type" : "numeric"
    },
    {
      "name" : "Degrade Mode",
      "type" : "enum"
    },
    {
      "name" : "Definition",
      "type" : "string"
    },
    {
      "name" : "Poll On Demand",
      "type" : "boolean"
    },
    {
      "name" : "History Id",
      "type" : "history:HistoryId"
    },
    {
      "name" : "Value Ord",
      "type" : "string"
    },
    {
      "name" : "Poll Queue",
      "type" : "string"
    }
    {
      "name" : "seriesName",
      "type" : "string"
    }
  ],
  "rows" : [
    [
      "slot:/nAnalytics/templates/CVAHU_Template/SpaceTemp",
      "0.0 °F {ok}",
      "null",
      "",
      "units=u:fahrenheit;°F;(K);*0.5555555555555556+255.37222222222223;
             |precision=i:1|min=d:55.0|max=d:85.0",
      "Poll Value Ord",
      false,
      "/%attr.Facility%/%parent.name%_%name%",
      false,
      17.0,
      0.0,
      "Disable",
      "definition:Analytics/HVAC/Temperature/Air/Zone$20Air$20Temp",
      true,
      "",
      "slot:/Drivers/NiagaraNetwork/%attr.Facility%
            /points/%parent.name%/%name%",
      "Poll History"
    ]
}

Response elements

In addition to the following, the system echoes back all request elements in the response.

Response element Value Description
Columns List of column definitions If the ORD resolves to a BITable, returns this list of column definitions.
Rows List of row lists If the ORD resolves to a BITable, each row list returns a value for each column, otherwise each row has exactly one value.