/
HU
hubmapconsortium
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
get
/indices
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
/search
Executes an Elasticsearch DSL query JSON via POST and returns hits that match the query.
post
/{index_name}/search
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
/param-search/{entity_type}
Executes an Elasticsearch DSL query JSON via GET and returns hits that match the query.
put
/reindex/{identifier}
Reindex for a given UUID of dataset
get
/reindex-status
Retrieves a json containing information about the current reindex queue status. Including numbers in the queue at different priority levels
get
/reindex-status/{identifier}
Retrieves a json containing information about a particularitem in the queue including its priority level, and its position in the queue.
post
/mget
Retrieves multiple documents by their IDs in a single request.
post
/{index_name}/mget
Retrieves multiple documents by their IDs in a single request.
get
/mapping
Exposes Elasticsearch's `_mapping` endpoint to return details regarding the default index. Defaults to using the consortium index.
get
/{index_name}/mapping
Exposes Elasticsearch's `_mapping` endpoint to return details regarding the specified index.
put
/update/{uuid}
Update a specific document with the passed in UUID
put
/update/{uuid}/{index}
Update a specific document with the passed in UUID and index
put
/update/{uuid}/{index}/{scope}
Update a specific document with the passed in UUID, Index, and Scope
post
/add/{uuid}
Add a specific document with the passed in UUID
post
/add/{uuid}/{index}
Create a specific document with the passed in UUID and index
post
/add/{uuid}/{index}/{scope}
Update a specific document with the passed in UUID, Index, and Scope
post
/clear-docs/{index}
Clear all docs for the given index
post
/clear-docs/{index}/{uuid}
Clear all docs for the given uuid within the index
post
/clear-docs/{index}/{uuid}/{scope}
Clear all docs for the given uuid within the index and scope
post
/{index}/scroll-search
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.
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Add a specific document with the passed in UUID
post
/add/{uuid}
Apr 2, 2025
c727e6e09a1c
Revision changes
info
endpoint added