Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
https://yoursite.com/web/searchretrieve/v1/json

(As mentioned Postman is a free tool able of POSTing.)


Search Query

...

YAML

The examples here are written as in YAML, but also JSON is also supported. In general, YAML is quicker and clearer to read and write (when you know it) and therefore useful when trying out and can be written quickly which makes it useful when doing search queries by hand. JSON is the more logical choice when serializing an object for the search query in your code ( or when if you are simply more comfortable with using it).

This YAML:


Code Block
search:
  ids: 
  - M123
  - P12345
  languages:
  - nl


...translates to this JSON:


Code Block
{
  "search": {
    "ids": [
      "M123",
      "P12345"
    ],
    "languages": [
      "nl"
    ]
  }
}


Compare the two for a few seconds... (1... 2... 3...) The Notice that the content of an object (map) is on a separate level in the YAML with example and that its own indent level and list items are denoted by hyphens ("-"). No brackets, commas and quotes needed. That's about what you need to know about YAML to read the examples. (On json2yaml.com you You can easily convert between the these two formats at json2yaml.com.)

Query syntax

See the examples above and Search Parameters for a list of all valid parameters and a detailed description on each one of them.

...