This class has the ability to return information about Search Term associations ie Landing pages
com.ibm.commerce.rest.search.handler.SearchTermAssociationHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/search_term_association?q={q} | Run a search term association query. See individual queries for details. |
GET | /store/{storeId}/search_term_association?q=byAssociationType | Finds search term associations by association type |
Run a search term association query. See individual queries for details.
querySearchTermAssociation
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Finds search term associations by association type
byAssociationType
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
associationType | The Association type eg (SearchForInstead,AlsoSearchFor,Synonym,LandingPageURL) can also be represented using values 1-4 | query | string | true | false |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
search_term_association-IBM_Admin_Summary
GET /wcs/resources/store/10001/search_term_association?q=byAssociationType&associationType=LandingPageURL&profileName=IBM_Admin_Summary&responseFormat=json&pageSize=4&pageNumber=1
200
{ "recordSetComplete": true, "recordSetCount": 5, "recordSetStartNumber": 0, "recordSetTotal": 5, "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/search_term_association?q=byAssociationType&associationType=LandingPageURL&profileName=IBM_Admin_Summary&responseFormat=json&pageSize=4&pageNumber=1", "resourceName": "search_term_association", "resultList": [ { "associationTerms": "GenericStaticContentPageLayoutView?pageName=SiteMapPage", "associationType": "LandingPageURL", "languageIdentifier": "-1", "searchTermAssociationId": "10001", "searchTerms": "map", "storeId": "10001" }, { "associationTerms": "GenericStaticContentPageLayoutView?pageName=SiteMapPage", "associationType": "LandingPageURL", "languageIdentifier": "-1", "searchTermAssociationId": "10002", "searchTerms": "help", "storeId": "10001" }, { "associationTerms": "StoreView", "associationType": "LandingPageURL", "languageIdentifier": "-1", "searchTermAssociationId": "10003", "searchTerms": "home", "storeId": "10001" }, { "associationTerms": "GenericStaticContentPageLayoutView?pageName=PrivacyPolicyPage", "associationType": "LandingPageURL", "languageIdentifier": "-1", "searchTermAssociationId": "10004", "searchTerms": "privacy", "storeId": "10001" }, { "associationTerms": "GenericStaticContentPageLayoutView?pageName=ContactUsPage", "associationType": "LandingPageURL", "languageIdentifier": "-1", "searchTermAssociationId": "10005", "searchTerms": "contact", "storeId": "10001" } ] }
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
resultList | search_term_association-IBM_Admin_Summary_item array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
languageIdentifier | string | false |
associationTerms | string | false |
searchTermAssociationId | string | false |
associationType | string | false |
storeId | string | false |
searchTerms | string | false |