Searching SPARC Dataset Indices

Introduction

The SPARC metadata APIs are provided via an ElasticSearch endpoint.

Access to the metadata APIs

Access to the metadata API is provided via an Elasticsearch pass-through.

Elasticsearch Pass-Through

POST https://api.scicrunch.io/elastic/v1/SPARC_Algolia_pr/_search

The pass-through is accessible at https://scicrunch.org/api/1/elastic. Similar to standard Elasticsearch APIs you must then supply an index and an action. In this case the SPARC Portal Dataset metadata (SPARC_Algolia_pr) and the search command (_search). Documentation on the Elasticsearch Search API is available at https://www.elastic.co/guide/en/elasticsearch/reference/6.8/search.html

Path Parameters

Headers

Request Body

Elasticsearch Pass-Through

GET https://api.scicrunch.io/elastic/v1/SPARC_Algolia_pr/_search

The pass-through is accessible at https://scicrunch.org/api/1/elastic. Similar to standard Elasticsearch APIs you must then supply an index and an action. In this case the SPARC Portal Dataset metadata (SPARC_Algolia_pr) and the search query parameter. Documentation on the Elasticsearch Search API is available at https://www.elastic.co/guide/en/elasticsearch/reference/6.8/search.html

Path Parameters

Query Parameters

Headers

SPARC metadata indices

Management of indices is accomplished via Elasticsearch aliases. Three index aliases are provided:

Using aliases will allow for testing on updates and enhancements to the metadata index structure. If needed additional aliases can be constructed for specialized testing.

Last updated