Filtering parameters. To define a filter in a query, an array of filtering conditions is passed in the filter object:

1. Each item of this array indicates the name of the field to be used for filtering and the filter conditions.
2. If no filtering conditions are defined (there is no object filtering array or it is empty), all objects of the specific type are returned.
3. To configure filtering in a query, the filter object containing an array of conditions is defined. An item of this array can be either a condition or a group of conditions in the form of a conditions array. The maximum nesting of groups is three levels (including the first).
4. Each condition can have the following parameters:
   • field (required) - object field name from the table of fields of the specific object type in camelCase. Subparameters are indicated after a colon (example - IP address of the source field: "source:ipAddress").
   • condition(optional) - condition for the field value. Supported options:
     • "=" - equals. This is also used if this parameter is not defined.
     • "<>" - does not equal.
     • ">" - the value of field is larger than value. Applicable only to numerical and time values.
     • ">=" - the value of field is larger than or equal to value. Applicable only to numerical and time values.
     • "<" - the value of field is less than value. Applicable only to numerical and time values.
     • "<=" - the value of field is less than or equal to value. Applicable only to numerical and time values.
     • "IsEmpty" - the value of field is empty. Value is ignored.
     • "IsOneOf" - the value of field is empty or is equal to one of the values in the value array. Value contains an array of possible values.
   • value - value or values that are compared.
     • Members of enums are indicated as strings in the English locale without spaces, special characters, or anything indicated in brackets. Examples: "DPI", "Warning", "EngineeringWorkstation".
     • Dates are indicated in ISO_8601 format with full indication of all parts of the date and time. Example: "2020-10-25T17:32:25.707Z".
   • operator - logical operation that merges this condition with other conditions and groups of conditions at the specific level. The operator of the first top-level condition is ignored. The operator of the first condition in a group is considered to be the operator of this group. Supported options:
     • "and" - the condition is added by AND. It is also used if this parameter is not defined.
     • "or" - the condition is added by OR.
   • Parsing of the values of parameters and all comparisons are not case sensitive.
   • If an unsupported parameter value is defined, the "Incorrect parameters" error is returned with the name and value of the parameter.

Example of a simple condition with an AND conjunction.

{
        "query":
        {
            ...
            "filter":
            [
                {
                    "field": "propName3",
                    "condition": "isOneOf",
                    "value": ["DPI", "NIC", "CC"],
                },
                {
                    "field": "propName4",
                    "condition": ">=",
                    "value": "2020-10-27T17:32:25.806Z"
                }
            ]
        }
}

Example of a set of conditions with a nested conditions group in which the conditions are merged by OR, while the top-level conditions are merged by AND:

{
        "query":
        {
            ...
            "filter":
            [
                [
                    {
                        "field": "propName1",
                        "condition": ">=",
                        "value": 10
                    },
                    {
                        "field": "propName1",
                        "value": 1,
                        "operator": "or"
                    }
                ],
                {
                    "field": "propName3",
                    "condition": "isOneOf",
                    "value": ["DPI", "NIC", "CC"]
                },
                {
                    "field": "propName4",
                    "condition": ">=",
                    "value": "2020-10-27T17:32:25.806Z"
                }
            ]
        }     
}

Sorting results. The list of columns that can participate in sorting depends on the type of requested data. A full list is provided in the description of the corresponding paging method.

0-based index of the item in the full list where the results must begin. If no offset is specified, the results return the data beginning at the start of the full list.