Update search filters

Make changes to existing search filters.

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/v1/searchFilters/<filterId>?token=<sessionId>

Details

  • PATCH 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 ID of the filter (as a URI parameter)
    • a JSON request body that includes at least the following: name, criterion

Request body example

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

Response

OK or Error.

Error messages

MessageStatus code
No session token provided or invalid token401 Unauthorized
You cannot perform the requested action because you do not have permission on other users filters400 Bad Request
Failed to convert value of type [...] (If the ID you entered is not a valid number.)500 Internal Server Error
Invalid search filter criterion for field translatedProgress (If the criterion is not defined correctly.)500 Internal Server Error
Search filter name is not provided500 Internal Server Error