Skip to main content

Get Search Results

26/03/2026

Parameters

Name

In

Type

Required

Description

configId

path

integer(int32)

true

The ID of the configuration to use for retrieving search results.

input

body

(raw)

string

false

The search query.

selectedFacets

body

(raw)

array

false

An array of objects, each representing a single facet serving as a search filter.

» field

body

(raw)

string

false

The ID of the facet to filter by.

» label

body

(raw)

string

false

The label of facet item to filter by.

» value

body

(raw)

string

false

The URI of the facet item to filter by.

start

body

(raw)

integer(int32)

false

The number of search results to skip (used for pagination).

Note

application/json is a mandatory content type for operations with a request body.

Example Body
{
  "input": "pinot noir",
  "selectedFacets": [
    {
      "field": "http://schema.semantic-web.at/Harmonizer/Wines",
      "label": "Wines",
      "value": "http://schema.semantic-web.at/Harmonizer/Wines"
    }
  ],
  "start": 0
}

Responses

Status

Meaning

Description

200

OK 

Information about facets and documents

201

Created 

Created

401

Unauthorized 

Unauthorized

403

Forbidden 

Forbidden

404

Not Found 

Not Found