Searching SPARC Dataset Indices
Last updated
Last updated
The SPARC metadata APIs are provided via an ElasticSearch endpoint.
Access to the metadata API is provided via an 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
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
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
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.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
index*
String
For SPARC datasets this is SPARC_Algolia_pr
apikey*
String
Your API key to access the services
data
String
JSON query body
index*
String
For SPARC datasets this is SPARC_Algolia_pr
q
String
Search string
apikey*
String
Your API key to access the services
SPARC_Algolia_pr
Production index for SPARC datasets