Preview Query
- Guylaine BASSETTE
Query description
The Preview Query is sent when clicking the “Open preview” link of a document, for example the second link below:
The result page is the preview of the selected document:
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 ( | String |
q | User input (default: *:*) | Same as Search Query (Search Query | Query parameters:) | String |
fl | List from ui-config.json | Same as Search Query (Search Query | Query parameters:) | String |
sort | score desc | Same as Search Query (Search Query | Query parameters:) | String |
q.op | AND | Same as Search Query (Search Query | Query parameters:) | String |
rows | 10 | Same as Search Query (Search Query | Query parameters:) | number |
start | Computed value | Same as Search Query (Search Query | Query parameters:) | number |
aggregator | From ui-config.json | Same as Search Query (Search Query | Query parameters:) |
boolean |
facet | true | Same as Search Query (Search Query | Query parameters:) | boolean |
facet.field | {!ex=field_name}field_name made from ui-config.json | Same as Search Query (Search Query | Query parameters:) | String multiple |
facet.query | {!key=id_index}query made from ui-config.json | Same as Search Query (Search Query | Query parameters:) | 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