This API specification is available for download as an Open API 3.0 YAML file:
/searchindexes/{SearchIndexResourceKey}
This operation returns details of a search index in the backoffice by its ID.
public com.intershop.application.backoffice.catalog.internal.resourceobject.SearchIndexRO com.intershop.application.backoffice.catalog.internal.restresource.SearchIndexResource.getSearchIndex()
Location | Name | Format | Description |
---|---|---|---|
in path | SearchIndexResourceKey | string | Required | The ID of a search index |
200 - OK
404 - Not Found
/searchindexes/{SearchIndexResourceKey}/filters/{SearchFilterResourceKey}
This operation returns details of a search filter in the back office based on its ID. Included are the categories assigned to it and the list of children of 'startCategory' with information about whether they contain subcategories assigned to the filter.
In case 'startCategory' is omitted, the root catalogs are used.
public com.intershop.application.backoffice.catalog.internal.resourceobject.SearchFilterRO com.intershop.application.backoffice.catalog.internal.restresource.SearchFilterResource.getFilter(java.lang.String)
Location | Name | Format | Description |
---|---|---|---|
in path | SearchIndexResourceKey | string | Required | The ID of a search index |
in path | SearchFilterResourceKey | string | Required | The ID of a search filter |
in path | SearchFilterResourceKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in query | startCategory | string | The path to the category whose subcategories will be analyzed for assigned descendants. If not set, the root catalogs are used. | Example: catalogA/categoryB |
200 - OK
404 - Not Found
AssignableRO
objects. A list of categories that are assigned to this search filterAssignableRO
: A list of categories with information about whether they contain subcategories that are assigned to this search filterAssignableRO
objects. A list of categories with information about whether they contain subcategories that are assigned to this search filterAssignableRO
: A list of categories with information about whether they contain subcategories that are assigned to this search filterThe information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.