Usage of Query Criteria

QueryCriteria is a general purpose container in order to specify resource, scope, search, sorting and other information while querying on a resource.

Specify scope with Filters

Filters

There are 3 kind of filters to specify the scope in QueryCriteria:

filters

A list of Filter, indicates including all the resources which meets any of filters. [OR operator]

extraFilters

A list of Filter, indicates including the resource which meets all of filters. [AND operator]

extraNotFilters

A list of Filter, indicates excluding the resource which meets any of filters. [AND NOT operator]

Structure of a Filter

Type	Value	Example
AP	apMac	{AP, 11:22:33:44:55:66}
APGROUP	apGroupId	{APGROUP, 758b6970-032a-11e7-9e78-0a0027000000}
CLIENT	clientMac	{CLIENT, AB:CD:00:00:00:03}
DOMAIN	domainId	{DOMAIN, 8b2081d5-9662-40d9-a3db-2a3cf4dde3f7}
INDOORMAP	indoorMapId	{INDOORMAP, 08733520-0a32-11e7-89a3-0a0027000000}
WLAN	wlanId	{WLAN, 1}
ZONE	zoneId	{ZONE, 91fa3fe0-03da-11e7-8d82-0a0027000000}

{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "Domain1Id"
      "operator": "eq"
    },
    {
      "type": "DOMAIN",
      "value": "Domain2Id"
      "operator": "eq"
    },
    {
      "type": "DOMAIN",
      "value": "Domain3Id"
      "operator": "eq"
    },
    {
      "type": "ZONE",
      "value": "Zone4Id"
      "operator": "eq"
    }
}

Filter Examples

Example 1: Get specific resource which is in Domain1 or Domain2 or Domain3 or Zone4

{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "Domain1Id",
      "operator": "eq"
    },
    {
      "type": "DOMAIN",
      "value": "Domain2Id",
      "operator": "eq"
    },
    {
      "type": "DOMAIN",
      "value": "Domain3Id",
      "operator": "eq"
    },
    {
      "type": "ZONE",
      "value": "Zone4Id",
      "operator": "eq"
    }
}

Example 2: Get specific resource which is in (Domain1 or Domain2) and syncedStatus is Online (AP for example)

{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "Domain1Id",
      "operator": "eq"
    },
    {
      "type": "DOMAIN",
      "value": "Domain2Id",
      "operator": "eq"
    }
  ],
  "extraFilters": [
    {
      "type": "SYNCEDSTATUS",
      "value": "Online",
      "value": "eq"
    }
  ]
}

Example 3: Get specific resource which in in (Domain1 or Domain2) and NOT in IndoorMap:indoorMapId

{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "Domain1Id",
      "operator": "eq"
    },
    {
      "type": "DOMAIN",
      "value": "Domain2Id",
      "operator": "eq"
    }
  ],
  "extraNotFilters": [
    {
      "type": "INDOORMAP",
      "value": "indoorMapId",
      "value": "eq"
    }
  ]
}

Full text search

Note that not all columns of entities support full text search.

Example: Search with all fields

"fullTextSearch": 
  {
    "type": "AND",
    "value": "keyword"
  },

Example: Search with specific fileds

"fullTextSearch": 
  {
    "type": "AND",
    "value": "keyword",
    "fields": [
      "apMac",
      "syncedDeviceName"
    ]
  },

Sort

Example:

"sortInfo": 
  {
    "sortColumn": "deviceName",
    "dir": "ASC"
  },

JSON Schema

Please refer to the request info of each URI.