Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Query description

The Preview Query is sent when clicking the “Open preview” link of a document, for example the second link below:

image-20240619-082754.png

GET https://[DATAFARI_BASE_URL]/datafariui/preview?parameters

Example https://datafariui.datafari.com/datafariui/preview?parameters

Query parameters:

Parameter

Value

Description

Data Type

docPos

position in the list

The position of the document in the result list. Starting from 0.

number

docId

document ID

The ID of the document for which you want a preview. This ID is from the search query used to display the list of documents (response.docs[x].id).

String

q

User input (default: *:*)

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

String

fl

List from ui-config.json

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

String

sort

score desc

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

String

q.op

AND

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

String

rows

10

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

number

start

Computed value

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

number

aggregator

From ui-config.json

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

boolean

facet

true

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

boolean

facet.field

{!ex=field_name}field_name

made from ui-config.json

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

String multiple

facet.query

{!key=id_index}query

made from ui-config.json

Same as Search Query (https://datafari.atlassian.net/wiki/spaces/DATAFARI/pages/3230531596/Search+Query#Query-parameters%3A)

String multiple

action

OPEN_PREVIEW

Fixed value

String

Header Parameters:

Nothing

Request Body Parameters:

Nothing

Path Parameters:

Nothing

Response description

To come

Examples

To come

  • No labels