new module:api/ContentSearchApi(apiClient)
Constructs a new ContentSearchApi.
Parameters:
| Name |
Type |
Description |
apiClient |
module:ApiClient
|
Optional API client implementation to use,
default to module:ApiClient#instance if unspecified. |
- Source:
Methods
getContentSearch(opts) → {Promise}
Provides keyword and refinement search functionality for content assets. The search result contains only content that is online and assigned to a folder.
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Optional parameters
Properties
| Name |
Type |
Description |
q |
String
|
The query phrase to search for. |
refine |
Array.<String>
|
Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = "|"). Value ranges can be specified like this: refine=foo=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementType=type1|type2|type3. The following system refinement attribute ids are supported: fdid: Allows to refine per single content folder id. Multiple folder ids are not supported. |
sort |
Array.<String>
|
Parameter that represents a sorting attribute/value(s) pair. Sorting attribute id and value are separated by '='. The value describes the sort direction. Possible values are 'asc' and 'desc', for ascending or descending sort direction. I.e. sort=c_myAttribute=desc. Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes. |
start |
Number
|
The result set index to return the first instance for. Default value is 0. |
count |
Number
|
The maximum number of instances per request. Default value is 25. |
locale |
String
|
The locale context. |
|
- Source:
Returns:
-
Type
-
Promise
getContentSearchWithHttpInfo(opts) → {Promise}
Provides keyword and refinement search functionality for content assets. The search result contains only content that is online and assigned to a folder.
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Optional parameters
Properties
| Name |
Type |
Description |
q |
String
|
The query phrase to search for. |
refine |
Array.<String>
|
Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = "|"). Value ranges can be specified like this: refine=foo=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementType=type1|type2|type3. The following system refinement attribute ids are supported: fdid: Allows to refine per single content folder id. Multiple folder ids are not supported. |
sort |
Array.<String>
|
Parameter that represents a sorting attribute/value(s) pair. Sorting attribute id and value are separated by '='. The value describes the sort direction. Possible values are 'asc' and 'desc', for ascending or descending sort direction. I.e. sort=c_myAttribute=desc. Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes. |
start |
Number
|
The result set index to return the first instance for. Default value is 0. |
count |
Number
|
The maximum number of instances per request. Default value is 25. |
locale |
String
|
The locale context. |
|
- Source:
Returns:
-
Type
-
Promise