Documentation Center

Delete search filters

Delete unnecessary search filters based on their ID.

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

  • DELETE 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), and the key, having one of the following values: projectGroupFilters, rowsPerPageOptions, or defaultFilter

Request example

<protocol>://<ws-host>:<ws-port>/ws-api/v1/searchFilters/<filterId>?token=<sessionId>&key=projectGroupFilters

Response

OK or Error.

Error messages

MessageStatus code
You cannot perform the requested action because you do not have permissions on other users' filters400 Bad Request
No session token provided or invalid token401 Unauthorized
The provided filter Id is not a valid number500 Internal Server Error
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