ids-query.asciidoc 602 B

12345678910111213141516171819202122232425262728
  1. [[query-dsl-ids-query]]
  2. === IDs
  3. ++++
  4. <titleabbrev>IDs</titleabbrev>
  5. ++++
  6. Returns documents based on their IDs. This query uses document IDs stored in
  7. the <<mapping-id-field,`_id`>> field.
  8. ==== Example request
  9. [source,console]
  10. --------------------------------------------------
  11. GET /_search
  12. {
  13. "query": {
  14. "ids" : {
  15. "values" : ["1", "4", "100"]
  16. }
  17. }
  18. }
  19. --------------------------------------------------
  20. [[ids-query-top-level-parameters]]
  21. ==== Top-level parameters for `ids`
  22. `values`::
  23. (Required, array of strings) An array of <<mapping-id-field, document IDs>>.