The Controlled Vocabulary Concepts Search resource defines the set Controlled Vocabulary terms associated with a list of Controlled Vocabulary Concepts that match a set of search criteria.
The scope of the terms returned can be limited by using the type query parameter.
The search query (q parameter) must contain at least one string or one attr.
A string in the search query will search for all concepts with that string in its description or gedcomxUri (example: q=string:"some description"). The given string can match anywhere in the description and is case insensitive. A given string of "Male" will match "Female", "Male", and "Male Cousin".
An attr in the search query will search for all concepts with that attribute with that value (example q=attr.12:"value1").
It is also possible to redact an attr by placing a dash (-) in front of attr. A redacted attr in the search query will not return any all concepts with that attribute with that value (example q=-attr.17:"value2").
An attr is separated into two parts. The attribute id follows a period and must come first. The attribute value follows the colon and must be surrounded by double quotes. The search on attribute values returns only exact matches, however it is case insensitive. It is possible to leave off either the attribute id or the attribute value. The search will simply match on what it is given. It is possible to send multiple attrs. The search will return only concepts that have all of the supplied attributes.
Valid Query String Examples
| Query Parameter | Result |
|---|---|
| q=string:"some description" attr.1:"some value" attr.2:"a different value" | Returns concepts with that description and those two attributes |
| =attr.2:"some value" | Returns concepts that have an attribute with and id of 2 with that value |
| q=attr.1 attr:"a different value" | Returns concepts that have an attribute with an id of 1 and a potentially different attribute with the given value |