Zum Hauptinhalt springen

Search API

Search Configurations​

Currently the Registry Search API contains 3 different Search Configurations, that can be queried:

  1. Datacite: Optimized for overarching search for all resources in the Text+ Registry
  2. Edition: Optimized for the edition data model
  3. Collection: Optimized for the collection data model

Each configuration searches and aggregates different fields. The data model, allow various filters/facets. Some examples are listed below.

Datacite example:​

HTTP Request (POST)​

URL​
https://registry.text-plus.org/api/search/default
Body​
{
"query": "shakespeare",
"indices": ["edition", "collection", "lexical_resource"],
"filter": {"Resource.Formats.Format": "corpus", "Resource.Language": "eng"}
}, 
"aggregations": true

Uses a fulltext query, with the term "shakespeare" using the Datacite search configuration. Queries the data domains of Text+ and applies some filters as an example. Additionally, aggregations are returned. The Term Aggregations in the result view can be used to further filter the results.

Edition example​

HTTP Request (POST)​

URL​
https://registry.text-plus.org/api/search/edition
Body​
{
"query": "shakespeare",
"indices": ["edition"],
"filter": {"properties.languages.@reference": ["eng"],
            "properties.provenance.@reference": ["sahle"]}, 
"aggregations": true
}

Collection example​

HTTP Request (POST)​

URL​
https://registry.text-plus.org/api/search/collection
Body​
{
  "query": "shakespeare",
  "indices": ["collection"],
  "filter": {   "properties.datatype.@reference": ["corpus"]},
  "aggregations": true
}