Common Request Parameters

A set of common request parameters is required for each Search Filter operation. The following table lists all of the Search Filter parameters. For more information on the parameters, view the TIBCO LogLogic® Appliance user interface for search filters as well as the online help.

Search Filter Operation common request parameters
Parameter Description Values Required Type
authToken

Token string returned from the authentication service or the “username/password”.

  yes string
applianceIp The managed Appliance on which you perform the operation.

If the value is blank, it retrieves the Appliance IP address from the local Appliance.

This parameter is available only for Management Station Appliances using operations with Remote in the name.

(for xxxx Remote operations only)

IP address of a managed Appliance. To specify an IP address, use the standard IP address format. For example:

10.1.2.3

yes

(for xxxx Remote operations only)

string
searchFilterName Name of the search filter. Any text up to 64 characters in length. yes string
searchFilterType Type of search filter.
  • Use Words
  • Use Exact Phrase
  • Regular Expression or Boolean Search
yes string
description Description of the search filter name (searchFilterName parameter) Any text up to 255 characters in length. yes string
sharedWith
OtherUsers Identifies if this search filter is available to other users. If yes, it is shared with others. no, Read Only, and Read Write yes string
expression1 The actual search terms for the search filter. Any valid search criteria up to 276 characters in length. yes string
expression2 The actual search terms for the search filter.

expression2 is required for Use Words search only.

Any valid search criteria up to 270 characters in length. yes string
expressionOperator The actual search terms for the search filter. Possible values: AND, OR.

expressionOperator is required only for the Use Words searchFilterType.

  yes string
changeNameTo New name of the search filter.

If empty, the object name is unchanged.

Any text up to 64 characters in length. yes

(for updateSearch
Filter and updateSearch
FilterRemote only)

string