-
Get Started
Concepts
Secure Access
HTTP for API Transport
Resources and URI Structure
Resource Collections
Hypermedia APIs
Representation Profiles and Schemas
Versioning
Revisions
Resource Sets
Optimistic Locking and Concurrency
Error Responses and Error Representation
Markdown
OpenAPI Reference
Release Notes
Apiture API License Agreement
Searching
Text searching is expressed with ?q=text
. To search for types that contain either “deposit” or “interest”, use the query
?q=deposit%20interest
(Note that spaces must be URL encoded as %20
in query parameters.)
Within a text search, space separated words indicate different text strings.
The above will match all product types which have either "deposit"
or "interest"
in their name
, label
, or description
.
Word phrases may be quoted. To search for the two word phrase “demand deposit”, use the quoted phrase "demand deposit"
?q=%22demand%20deposit%22
(Note that the enclosing double quote characters "
must be URL encoded as %22
.)
The and
operator may be used if the search should match all query strings instead of any strings, such as "demand deposit" and interest
as in
?q=%22demand%20deposit%22%20and%20interest
For internationalization purposes, ?q=
is equivalent to secondary strength comparisons.
A search query may also be coded in a ?filter=
expression as search('"demand deposit" and interest')
which is URL encoded as
search('%22demand%20deposit%22%20and%20interest')
.