Suggest item keywords for auto-completion of default search
get
/content/management/api/v1.1/items/suggest
Suggestion of item keywords for auto-completion of search terms in a default search.
For example to get suggested auto completion keywords/phrase for the term "Race", the following API :
/items/suggest?kw=Race&limit=10&repositoryId= will return a collection of suggested keywords/phrases to auto complete search term.
Query Parameters :
For example to get suggested auto completion keywords/phrase for the term "Race", the following API :
/items/suggest?kw=Race&limit=10&repositoryId=
Query Parameters :
Parameter Name | Required | Description |
---|---|---|
kw | No | Partial search term. Defaults to empty string "". |
language | No | Language tag with variants."". |
limit | No | This parameter limits size of the results.Defaults to 10 |
repositoryId | No | This parameter limits results to specific repository.Defaults to ALL. |
links | No | This parameter accepts a comma-separated list of link names. By default,this parameter gives all the links applicable. Possible values are: self, canonical, describedby |
Request
Query Parameters
-
kw(optional): string
Partial search term
-
language(optional): string
This parameter accepts a language tag along with variants(e.g. en-US) to filter keyword suggestions in a specific language
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of keywords suggested for auto-completion.Default Value:
10
-
links(optional): string
Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby Example: links=self,canonical will only return the links with the rel property self or canonical.
-
repositoryId(optional): string
This parameter accepts a repository id and result will contain only items belonging to the specified repository. This is an optional parameter and by default returns results from all repositories.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ItemSuggestKeywords
Type:
object
ItemSuggestKeywords
Show Source
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object ItemKeyword
ItemKeyword.
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : ItemKeyword
Type:
object
ItemKeyword.
Show Source
-
keyword:
string
Keyword suggestions for an item
-
links(optional):
array links
Links
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.