Mindconnect API – Filtering¶
General¶
All endpoints with the parameter filter support basic filtering.
Wildcards are not supported. Timestamps must be in ISO-8601 format as follows: YYYY-MM-DDTHH:mm:ss.sssZ, e.g.: 2018-10-04T07:58:49.369Z.
When a filter has no matches, the response will be empty.
Filter functions¶
Function eq (equals)¶
{
"agentId": "3b27818ea09a46b48c7eb3fbd878349f"
}
or
{
"agentId": {
"eq": "3b27818ea09a46b48c7eb3fbd878349f"
}
}
Function in¶
The function in is very similar to equals, but instead matching to one value, it checks an array of values, and matches for any of them.
{
"agentId": {
"in": {
"value": ["3b27818ea09a46b48c7eb3fbd878349f", "9b27818ea09a46b48c7eb3fbd878349f"]
}
}
}
or
{
"agentId": {
"in": ["3b27818ea09a46b48c7eb3fbd878349f", "9b27818ea09a46b48c7eb3fbd878349f"]
}
}
Function endsWith¶
{
"message": {
"endsWith": "Successful."
}
}
Function startsWith¶
{
"message": {
"startsWith": "Dropped"
}
}
Function contains¶
{
"message": {
"contains": "Timeseries"
}
}
Function before¶
{
"timestamp": {
"before": "2018-01-01T00:00:00.00Z"
}
}
Function after¶
{
"timestamp": {
"after": "2018-01-01T00:00:00.00Z"
}
}
Function between¶
Checks if the value of the field is between the given range
Parentheses for inclusive date: [] Parentheses for exclusive date: ()
{
"timestamp": {
"between": "[2018-01-01T00:00:00.00Z, 2018-01-31T00:00:00.00Z)"
}
}
Filter operations¶
Operation not¶
{
"not": {
"message": {
"startsWith": "Accepted"
}
}
}
or
{
"not": {
"message":"Accepted"
}
}
Operation or¶
{
"message": {
"or": [
{"eq": "Data is Accepted"},
{"endsWith": "Accepted"}
]
}
}
or
{
"or": {
"message": {
"eq": null
},
"agentId": {
"startsWith": "3b27818ea09a46b48c7eb3fbd878349f"
}
}
}
Operation and¶
{
"agentId":"3b27818ea09a46b48c7eb3fbd878349f",
"message": null
}
or
{
"and":{
"message": {
"eq": null
},
"agentId": {
"startsWith": "3b27818ea09a46b48c7eb3fbd878349f"
}
}
}