Dimension Service API  2.0.0
api index

SearchQuery Object

since: 0.32
The query to use as part of the search.

Fields

query
0.32required
string
The search terms, consisting of one or more substrings, words, or phrases.
attribute
0.32optional
string
Specifies the attribute definition to search. Only those dimension nodes that contain attribute values matching the query will be returned.

Note that the attribute must be of type text.

When this field is omitted, the name and/or labels are used to match the query.

Related API Objects

Example - Search the name or labels fields

{
  "query": "US-TX"
}

Example - Search dimension nodes that have an attribute value within the 'FOUNDER' attribute definition matching 'Augustus'

{
  "query": "Augustus",
  "attribute": "FOUNDER"
}