You can filter results using string matching or numeric comparison operations. A filter comprises one or more subexpressions drawn from the following set of operators.

When using filtering with the API, the following conditions apply:

■

All collection APIs use standardized filtering.

■

Only one query parameter is supported for filtering named as "filter".

■

Filter expressions use the following format: filter={expression}

Note

Only the Service Controller APIs (/api/sc/plans and /api/sc/instances) support filter expressions.

Supported Filter Operators

Operator

Example

Operation

==

attribute==value

Matches

The example evaluates to true if attribute has a value that matches value in a case-sensitive comparison.

Note

Asterisk (*) characters that appear anywhere in value are treated as wildcards that match any character string. When value includes wildcards, the comparison with attribute becomes case insensitive.

!=

attribute!=value

Does not match

The example evaluates to true if attribute has a value that does not match value in a case-sensitive comparison. Wildcard characters are not allowed.

;

attribute1==value1;attribute2!=value2

Logical AND

The example evaluates to true only if attribute1 has a value that matches value1 and attribute2 has a value that does not match value2 in a case-sensitive comparison.

,

attribute1==value1,attribute2==value2

Logical OR

The example evaluates to true if attribute1 has a value that matches value1 or attribute2 has a value that matches value2 in a case-sensitive comparison.