Query

POST

/api/apps/{appID}/things/query

A request to perform a query.

The request is composed of the following information:

• thingQuery: A JSON object that contains:
• clause: The clause for the query. The details are explained in below.
• orderBy: The field used for aligning the query result. This field is optional.
• descending: A boolean field indicating whether the things should be sorted in a descending or ascending order. This field works in pair with the "orderBy" and has no effect if the "orderBy" is not provided. This field is optional. If not provided, the field will be set to false by default.
• paginationKey: The pagination key for getting the next page of the query result. The key will be provided when the result is returned in the paginated manner.
• bestEffortLimit: The maximum number of things to retrieve in one response.

• eq: Equality clause. Check if a field in the thing has the specified value.
  The additional fields required for this clause are as follows:
• field: The name of the field.
• value: The value that the specified thing field should have.
• prefix: Prefix clause. Only valid for string fields. Check if a string field starts with a specified prefix.
  The additional fields required for this clause are as follows:
• field: The name of the field.
• prefix: The prefix that the specified thing field should start.
• and: Boolean clause that concatenates a list of clauses with an "AND" connector.
  The additional field for this clause is as follows:
• clauses: An array of clauses.
• or: Boolean clause that concatenates a list of clauses with an "OR" connector.
  The additional field for this clause is as follows:
• clauses: An array of clauses.
• all: All clause. This clause returns all things in the application. This clause cannot be nested in other clauses (e.g., boolean clause or not clause).
• range: Range clause. Check if the value in the thing field is in the specified range of values.
  The additional fields required for this clause are as follows (either the upper or the lower limit can be omitted, but not both):
• field: The name of the field.
• upperLimit: The upper limit of the range.
• upperIncluded: Boolean field that indicates if the upper limit is included in the range. The default value is "true".
• lowerLimit: The lower limit of the range.
• lowerIncluded: Boolean field that indicates if the lower limit is included in the range, The default value is "true".
• in: In clause. Check if the thing field has one of the specified values.
  The additional fields for this clause are as follows:
• field: The name of the field.
• values: The list of values to match.
• not: Not clause. Returns all the things that do not match with a given clause.
  The additional field for this clause is as follows:
• clause: The clause the things should not match.
• hasField: "Has Field" clause. Check if the thing has a value for a specified field.
  The additional fields for this clause are as follows:
• field: The name of the field.
• fieldType: Type of the field. The possible values are "STRING", "INTEGER", "DECIMAL", and "BOOLEAN"
• contains: "Contains Value" clause. Allows to filter the things owned by a given user or group.
  The additional fields for this clause are as follows:
• field: Two possible values: "userOwners" in case of looking for things owned by a given user, or "groupOwners" when looking for things owned by a group.
• value: The userID or groupID owner of the things

{
  "thingQuery": "[ThingQuery]",
  "paginationKey": "[string]",
  "bestEffortLimit": "[string]"
}