Get Element State for Queried Elements from NB (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/elements/bulk_config_state/query

Get the element configuration/state information for queried elements from NB.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query Details

aggregate Aggregate

The aggregate number of queried elements.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

Field

name string

The name of the query response.

operator string

Possible values: [max, count, min, avg, sum]

Operator

statistic string

QoS application aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number of queried elements deleted for a time frame.

group_by string[]

Group the elements state for the query.

id string

List the element by ID.

last_query_ts int64

Return the ID of a specified query in the current session.

limit int32

The query limit.

next_query object

The limit.

query_params object
retrieved_fields string[]

Retrieve information from a field.

retrieved_fields_mask boolean

List the fields to query.

sort_params object
total_count int64

The total number of query parameters.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

items object[]

List items in the query.

tenant_id string

The tenant ID.

total_count int64

Total number.

Example (from schema)

{
  "count": 0,
  "id": "string",
  "items": [
    {}
  ],
  "tenant_id": "string",
  "total_count": 0
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_TENANT_API_VERSION"
      }
    ]
  }
}

Loading...