Suggest - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

This web service returns matching publications and topics based on suggestions entered by end-users.

This web service suggests only the titles of book topics, not those of article topics.

Method

Endpoint

POST

/api/khub/suggest

User rights are taken into account when the Authorization header is provided, otherwise only public results are returned.

Input Example

{
"input": "suggesti",
"contentLocale": "en-US",
"filters": [
{
"key": "$FACET_ID",
"values": ["$FACET_VALUE_1", "$FACET_VALUE_2"]
},
...
],
"sort": [
{
"key": "$FACET_ID",
"order": "DESC|ASC"
},
...
],
"maxCount": 5
}

With the following parameters:

Parameter

Cardinality

Description

input

Mandatory

Expects the string query used to return suggestions.

contentLocale

Mandatory

Expects the content language ISO code.

filters

Optional

Enables to filter the results on some metadata values. When multiple values are given, they are combined with an AND or an OR operator depending on the metadata descriptor type. Defaults to empty list.

sort

Optional

Enables to specify a custom sort on any metadata. A special keyword is provided to sort by relevance : ft:relevance. Defaults to the standard sorting order.

maxCount

Optional

Declares maximum number of returned suggestions. Limited to 1000 replies at most on server-side. Defaults to 5.

Output Example

{
"suggestions": [
{
"type": "MAP",
"editorialType": "BOOK",
"value": "This is a Book suggestion"
},
{
"type": "MAP",
"editorialType": "ARTICLE",
"value": "This is an Article suggestion"
},
{
"type": "TOPIC",
"value": "This is a book Topic suggestion"
},
{
"type": "DOCUMENT",
"value": "This is a Unstructured Document suggestion",
"filenameExtension": "docx",
"mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
}
]
}

With the following parameters:

Parameter

Description

value

The string displayed in the suggestion box.

type

Indicates the type of object the suggestion comes from:

  • MAP: a structured publication title.
  • TOPICS: a book topic title.
  • DOCUMENT: an unstructured document title.

editorialType

Indicates, for MAP types only, if the suggested structured publication is a BOOK or an ARTICLE.

mimetype

Indicates, for DOCUMENT types only, the mimetype of the suggestion.

filenameExtension

Indicates, for DOCUMENT types only, the filename extension of the suggestion.