A stored filter defines reusable query criteria for paginated list endpoints.
Create a filter via POST /rest/filters with a JSON or XML body describing
the target entity, expressions, and sort order. The returned filterId can then
be passed as a query parameter to any list endpoint that supports filtering.
Filters are scoped to the authenticated user and deduplicated by content digest.
POST
/filters
Create a new filter.
Persists the filter and returns it with the assigned filterId.
If an identical filter already exists for the current user (same content digest),
the existing filter is returned instead of creating a duplicate.
Parameters
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
setDefaults |
matrix | false |
boolean | when true, populates default criteria (e.g., deleted = false) before persisting |
Request Body
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Filter | the filter body containing the target entity wrapper, expressions, and ordering |
application/xml |
Filter |
Response Codes
| Code | Condition |
|---|---|
| 200 | the filter was created (or an existing duplicate was returned) |
| 400 | validation failed (invalid filter structure) |
Response Body
Request (XML)
<f----->
<filterId>...</filterId>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</expressionDisjunction>
<expressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</expressionConjuction>
<lJexpressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</lJexpressionSimple>
<lJexpressionIsNull>
<property>...</property>
</lJexpressionIsNull>
<lJbetweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</lJbetweenExpression>
<lJexpressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</lJexpressionContain>
<lJexpressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</lJexpressionDisjunction>
<lJexpressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</lJexpressionConjuction>
<order>
<property>...</property>
<direction>...</direction>
</order>
</f----->
Request (JSON)
{
"FilterPrime" : {
"filterId" : "...",
"criteria" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"leftJoinCriteria" : [ {
"lJexpressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"lJexpressionIsNull" : {
"property" : "..."
}
}, {
"lJbetweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"lJexpressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"lJexpressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"lJexpressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"ordering" : {
"order" : [ {
"property" : "...",
"direction" : "..."
}, {
"property" : "...",
"direction" : "..."
} ]
}
}
}
Response (XML)
<f----->
<filterId>...</filterId>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</expressionDisjunction>
<expressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</expressionConjuction>
<lJexpressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</lJexpressionSimple>
<lJexpressionIsNull>
<property>...</property>
</lJexpressionIsNull>
<lJbetweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</lJbetweenExpression>
<lJexpressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</lJexpressionContain>
<lJexpressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</lJexpressionDisjunction>
<lJexpressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</lJexpressionConjuction>
<order>
<property>...</property>
<direction>...</direction>
</order>
</f----->
Response (JSON)
{
"FilterPrime" : {
"filterId" : "...",
"criteria" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"leftJoinCriteria" : [ {
"lJexpressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"lJexpressionIsNull" : {
"property" : "..."
}
}, {
"lJbetweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"lJexpressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"lJexpressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"lJexpressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"ordering" : {
"order" : [ {
"property" : "...",
"direction" : "..."
}, {
"property" : "...",
"direction" : "..."
} ]
}
}
}
GET
/filters
List all filters for the current user. Returns a paginated list of stored filters owned by the authenticated user.
Parameters
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
Response Codes
| Code | Condition |
|---|---|
| 200 | the filters were retrieved successfully |
Response Body
Response (XML)
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
Response (JSON)
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
GET
/filters/{filterId}
Get a single filter by its id. Returns the full filter body including all expressions and ordering.
Parameters
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
filterId |
required | path | int | the unique identifier of the filter |
Response Codes
| Code | Condition |
|---|---|
| 200 | the filter was retrieved successfully |
| 404 | filter not found for the given id |
Response Body
Response (XML)
<f----->
<filterId>...</filterId>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</expressionDisjunction>
<expressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</expressionConjuction>
<lJexpressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</lJexpressionSimple>
<lJexpressionIsNull>
<property>...</property>
</lJexpressionIsNull>
<lJbetweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</lJbetweenExpression>
<lJexpressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</lJexpressionContain>
<lJexpressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</lJexpressionDisjunction>
<lJexpressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</lJexpressionConjuction>
<order>
<property>...</property>
<direction>...</direction>
</order>
</f----->
Response (JSON)
{
"FilterPrime" : {
"filterId" : "...",
"criteria" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"leftJoinCriteria" : [ {
"lJexpressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"lJexpressionIsNull" : {
"property" : "..."
}
}, {
"lJbetweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"lJexpressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"lJexpressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"lJexpressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"ordering" : {
"order" : [ {
"property" : "...",
"direction" : "..."
}, {
"property" : "...",
"direction" : "..."
} ]
}
}
}
PUT
/filters/{filterId}
Update an existing filter.
Replaces the filter body with the provided data. The filterId remains unchanged.
Parameters
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
filterId |
required | path | int | the unique identifier of the filter to update |
Request Body
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Filter | the updated filter body containing expressions and ordering |
application/xml |
Filter |
Response Codes
| Code | Condition |
|---|---|
| 200 | the filter was updated successfully |
| 404 | filter not found for the given id |
Response Body
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
Request (XML)
<f----->
<filterId>...</filterId>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</expressionDisjunction>
<expressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</expressionConjuction>
<lJexpressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</lJexpressionSimple>
<lJexpressionIsNull>
<property>...</property>
</lJexpressionIsNull>
<lJbetweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</lJbetweenExpression>
<lJexpressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</lJexpressionContain>
<lJexpressionDisjunction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionConjuction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionDisjunction/>
</expressionConjuction>
</lJexpressionDisjunction>
<lJexpressionConjuction>
<expressionSimple>
<value>...</value>
<op>...</op>
<property>...</property>
</expressionSimple>
<expressionIsNull>
<property>...</property>
</expressionIsNull>
<betweenExpression>
<property>...</property>
<minValue>...</minValue>
<maxValue>...</maxValue>
</betweenExpression>
<expressionContain>
<property>...</property>
<negation>...</negation>
<list>
<String>...</String>
</list>
</expressionContain>
<expressionDisjunction>
<expressionSimple/>
<expressionIsNull/>
<betweenExpression/>
<expressionContain/>
<expressionConjuction/>
</expressionDisjunction>
</lJexpressionConjuction>
<order>
<property>...</property>
<direction>...</direction>
</order>
</f----->
Request (JSON)
{
"FilterPrime" : {
"filterId" : "...",
"criteria" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"leftJoinCriteria" : [ {
"lJexpressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"lJexpressionIsNull" : {
"property" : "..."
}
}, {
"lJbetweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"lJexpressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"lJexpressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionConjuction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionDisjunction" : { }
} ]
}
} ]
}
}, {
"lJexpressionConjuction" : {
"expressions" : [ {
"expressionSimple" : {
"value" : "...",
"op" : "...",
"property" : "..."
}
}, {
"expressionIsNull" : {
"property" : "..."
}
}, {
"betweenExpression" : {
"property" : "...",
"minValue" : "...",
"maxValue" : "..."
}
}, {
"expressionContain" : {
"property" : "...",
"negation" : true,
"list" : [ "...", "..." ]
}
}, {
"expressionDisjunction" : {
"expressions" : [ {
"expressionSimple" : { }
}, {
"expressionIsNull" : { }
}, {
"betweenExpression" : { }
}, {
"expressionContain" : { }
}, {
"expressionConjuction" : { }
} ]
}
} ]
}
} ],
"ordering" : {
"order" : [ {
"property" : "...",
"direction" : "..."
}, {
"property" : "...",
"direction" : "..."
} ]
}
}
}
DELETE
/filters/{filterId}
Delete a filter permanently. Removes the stored filter from the database. This cannot be undone.
Parameters
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
filterId |
required | path | int | the unique identifier of the filter to delete |
Response Codes
| Code | Condition |
|---|---|
| 204 | the filter was deleted successfully |
| 404 | filter not found for the given id |
Response Body
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|