Sign in

Executes an Elasticsearch DSL query JSON via POST and returns hits that match the query.

To execute a query, the POST method must provide 1) a request body that specifies an Elasticsearch Query DSL statement 2) a bearer token in the Authorization header supplied by HuBMAP. Results are limited to those authorized by the bearer token. Uses the <strong>entities</strong> index by default.

post/search

Query parameters

produce-clt-manifeststring

An optional parameter that, when set to "true", will make the endpoint return a text representation of a manifest file that corresponds with the datasets queried rather than the original response

Request body

object required

Response

Returns search hits from backend Elasticsearch that match the query defined in the request JSON

object required

Changes

Changed in 1 of the 5 revisions of this API.8

  • c727e6e09a1c8See the full diff
    • ○

      api operation id search-post removed and replaced with

      api-operation-id-removed

    • ○

      api tag search removed

      api-tag-removed

    • ○

      added the non-success response with the status 303

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 504

      response-non-success-status-added

    • ○

      added the success response with the status 200

      response-success-status-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog