Skip to main content

Search

Search items using ContexQL query.

info

Available in Contextal Platform 1.0 and later.

Request​

  • Path: /api/v1/search
  • Verb: GET
    • URL parameters:
      • q: the ContexQL query string
      • getobjects: requests the query to return objects rather than works (optional, default false)
      • maxitems: the maximum number of items to return (optional, default 1000, max 1000)
  • Verb: POST or PUT
    • Content-Type: application/json
    • Body: JSON object with the same content as the URL parameters above

Reply​

On success:

  • Status: 200 - Ok
  • Content-Type: application/json
  • Body: A JSON array containing the matching items (works or objects)

On failure:

  • Status: 400
    • Content-type: text/plain
note

This indicates an error in the HTTP request e.g. wrong content-type, broken json, etc

  • Content-type: application/json
note

This indicates either a compile time or runtime error; the kind key of the object in the body will clarify what the problem was.

  • Status: 5xx

    Platform is in trouble, try again later.