Create search filters
Create search filters and assign them explicit criteria.
sessionId in the response is your session token. Use this token in all the other calls that you make.
Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to and then select your user type.
API call
Versioning notes
Starting with WorldServer 11.4, the requests to create search filters require different request bodies, depending on the API version that you use to make the request. For example, the body of the request made to v2 will be different from the body of the request made to v1, as shown in the examples presented later on in this topic.
Details
- POST method
- Content-Type in the header:
application/json - Mandatory parameters:
- the session token (as a query string parameter or as a key-value pair in the header)
- the key (as a query string parameter), having one of the following values:
projectGroupFilters,rowsPerPageOptions, ordefaultFilter - a JSON request body that includes at least the following: name, criterion (for v1) or filter (for v2), and resource (only for v2)
Request body example (v1)
Request body example (v2)
Response
The ID of the created search filter.
Error messages
| Message | Status code |
|---|---|
| Required request body is missing | 400 Bad Request |
| No session token provided or invalid token | 401 Unauthorized |
| Required String parameter 'key' is not present | 500 Internal Server Error |
| Null Pointer Exception (If the value of the key is not valid.) | 500 Internal Server Error |
| Criterion is not defined | 500 Internal Server Error |
| Filter name is not defined | 500 Internal Server Error |