/
HU
hubmapconsortium
/
HuBMAP Search API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1h ago · Updated 1y ago
Details
Filter operations
get
Reindex for a given UUID of dataset. Use this method to obtain a list of valid indices within the search-api endpoint. These index names are used in some of the subsequent calls made to the endpoint.
post
Executes an Elasticsearch DSL query JSON via POST and returns hits that match the query.
post
Executes an Elasticsearch DSL query JSON via POST and returns hits that match the query. The response is limited to hits against the specified index_name parameter. Values for index_name can be obtained by calling the /indices endpoint.
get
Executes an Elasticsearch DSL query JSON via GET and returns hits that match the query.
put
Reindex for a given UUID of dataset
post
Retrieves multiple documents by their IDs in a single request.
post
Retrieves multiple documents by their IDs in a single request.
get
Exposes Elasticsearch's `_mapping` endpoint to return details regarding the default index. Defaults to using the consortium index.
get
Exposes Elasticsearch's `_mapping` endpoint to return details regarding the specified index.
put
Update a specific document with the passed in UUID
put
Update a specific document with the passed in UUID and index
put
Update a specific document with the passed in UUID, Index, and Scope
post
Add a specific document with the passed in UUID
post
Create a specific document with the passed in UUID and index
post
Update a specific document with the passed in UUID, Index, and Scope
post
Clear all docs for the given index
post
Clear all docs for the given uuid within the index
post
Clear all docs for the given uuid within the index and scope
post
Use the OpenSearch scroll API (https://opensearch.org/docs/latest/api-reference/scroll/) to open a scroll which will be navigated in the specified time when scroll_id is not provided, retrieve more results when a scroll_id is provided, and close a scroll when zero is the specified time.
Clear all docs for the given index
post
/clear-docs/{index}
Path parameters
index
string
required
Response
The request has been accepted and document clearing is in process
Changes