Documentation Center

Create search filters

Create search filters and assign them explicit criteria.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The 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 Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/<api-version>/searchFilters?token=<sessionId>&key=<value>

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, or defaultFilter
    • 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)

A screen shot that shows a possible JSON request body for this call.

Request body example (v2)

A screen shot that shows a possible JSON request body for this call.

Response

The ID of the created search filter.

Error messages

MessageStatus code
Required request body is missing400 Bad Request
No session token provided or invalid token401 Unauthorized
Required String parameter 'key' is not present500 Internal Server Error
Null Pointer Exception (If the value of the key is not valid.)500 Internal Server Error
Criterion is not defined500 Internal Server Error
Filter name is not defined500 Internal Server Error