Sign in
Objects

Execute object query

Execute object query (specialized NXSL script) and return all matching objects along with additional data fields.

post/v1/objects/query

Request body

fieldsstring[]

List of additional fields to be retrieved.

inputFieldsobject[]

List of user input fields (will be available in query script via global variable $INPUT).

limitinteger

Optional limit on number of retrieved objects. Limit is applied after ordering.

orderBystring[]

List of object attributes to be used for ordering result.

querystring

Object query script

Example request

{
  "query": "type == NODE"
}

Response

Query successfully executed.

fieldsobject

Changes