The list
operation can be modified to return data you are looking for by applying the
search query parameter.
Default
search parameters
Typically, the
name and description fields are searched when specifying a search string. Refer
to each API section for the default search parameters permitted. For example, a
query parameter of
q=abc causes the list operation to return only
entries with a name or description containing
abc. The
search value for default parameters has the following behaviors and
restrictions:
Values:
- Are case-insensitive.
- Can be contained
anywhere in the parameter value.
- Can match any of the
default parameters.
- Cannot include SQL
wildcards. They are not supported.
- Must be URL encoded. For
example,
&
must be converted to
%26 so
that it is not treated as a separator for additional query parameters.
Advanced
search
Advanced search
parameters allow specific parameters to be searched. Refer to each API section
for the advanced search parameters permitted. Advanced search parameters can be
combined with a default search value. For example, applying the search query
parameter of
q=abc
routingType:1 to a dialed number list operation returns results
where the routingType is set to one, and one of the default search parameters
contains
abc.
Advanced search also has the following restrictions:
- Search terms must be
separated by a space.
- Search terms can be
specified in any order.
Advanced
departmental search
For APIs that
include a department reference, the following advanced search parameters are
allowed:
-
departments: Search for items that belong to the any of the
specified departments. For example:
q=departments:(dept1|dept2) search for items that
belong to a department whose name exactly matches
dept1
or
dept2.
The departments search must follow these guidelines:
- Department names must
match exactly.
- Departments are separated
by the pipe character.
- Up to 10 departments can
be specified.
-
globaldepartment: Specifies if the search should return
items from the global department. Values include:
- both: Return items from
the global department and those specified in the departments search.
- only: Return items from
the global department only. The departments search term is ignored.
- none: Do not return
items from the global department.