OneStop API

---

The Search API

Table of Contents

• Intro
• SwaggerHub Generated Documentation
• Additional Search API Information

Intro

The Search API provides endpoints for OneStop data discovery. Either a POST (with a correctly formatted JSON request body) or GET request will work. All endpoints expect the same request schema format to be used but return data of the type specified from the URL.

SwaggerHub Generated Documentation

Our OpenAPI documents are available on SwaggerHub. This should list supported endpoints and parameters necessary.

• 3.0.0-RC1
• 2.4.0

Additional Search API Information

• Search Requests - What requests can be done on the Search endpoints.
• Search Query Syntax - In-depth on the ElasticSearch query syntax used by our Search API.
• Search Fields - Search fields you can reference in a search query.
• Search Responses - Format of the search response.