rest-api-spec.api.async_search.get.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.17.0

{
  "async_search.get":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html",
      "description": "Retrieves the results of a previously submitted async search request given its ID."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_async_search/{id}",
          "methods":[
            "GET"
          ],
          "parts":{
            "id":{
              "type":"string",
              "description":"The async search ID"
            }
          }
        }
      ]
    },
    "params":{
      "wait_for_completion_timeout":{
        "type":"time",
        "description":"Specify the time that the request should block waiting for the final response"
      },
      "keep_alive": {
        "type": "time",
        "description": "Specify the time interval in which the results (partial or final) for this search will be available"
      },
      "typed_keys":{
        "type":"boolean",
        "description":"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"
      }
    }
  }
}