This API specification is available for download as an Open API 3.0 YAML file:
References
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
API Specification
/searchindexes/{SearchIndexResourceKey}
GET: Returns details of a search index
Description
This operation returns details of a search index in the backoffice by its ID.
Java Method
public com.intershop.application.backoffice.catalog.internal.resourceobject.SearchIndexRO com.intershop.application.backoffice.catalog.internal.restresource.SearchIndexResource.getSearchIndex()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | SearchIndexResourceKey | string | | | Required | The ID of a search index |
Response
200 - OK
SearchIndexRO application/json
404 - Not Found - A search index with this ID could not be found.
/searchindexes/{SearchIndexResourceKey}/filters/{SearchFilterResourceKey}
GET: Returns details of a search filter
Description
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.
Java Method
public com.intershop.application.backoffice.catalog.internal.resourceobject.SearchFilterRO com.intershop.application.backoffice.catalog.internal.restresource.SearchFilterResource.getFilter(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | 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 | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | startCategory | string | | catalogA/categoryB | The path to the category whose subcategories will be analyzed for assigned descendants. If not set, the root catalogs are used. |
Response
200 - OK
SearchFilterRO application/json
404 - Not Found
SearchFilterRO application/json
{"id":
string
The ID of the search filter
"uri":
string
The URI of the search filter
"displayName":
string
The display name of the search filter
"assignedCategories":
array
An array of AssignableRO
objects. A list of categories that are assigned to this search filter
[
AssignableRO
:
A list of categories with information about whether they contain subcategories that are assigned to this search filter{
"id":
string
The ID of the assignable
"uri":
string
The URI of the assignable
"displayName":
string
The display name of the assignable
"domainId":
string
The domain ID of the assignable
"assigned":
boolean
Indicates whether this assignable is assigned to the specific object
"hasChildren":
boolean
Indicates whether this assignable has any children
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
"hasAssignedDescendants":
boolean
Indicates whether this assignable has any descendents that are assigned to the specific object
"name":
string
The name of an element
}
]
"assignableCategoriesHierarchy":
array
An array of AssignableRO
objects. A list of categories with information about whether they contain subcategories that are assigned to this search filter
[
AssignableRO
:
A list of categories with information about whether they contain subcategories that are assigned to this search filter{
"id":
string
The ID of the assignable
"uri":
string
The URI of the assignable
"displayName":
string
The display name of the assignable
"domainId":
string
The domain ID of the assignable
"assigned":
boolean
Indicates whether this assignable is assigned to the specific object
"hasChildren":
boolean
Indicates whether this assignable has any children
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
"hasAssignedDescendants":
boolean
Indicates whether this assignable has any descendents that are assigned to the specific object
"name":
string
The name of an element
}
]
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
"name":
string
The name of an element
}SearchIndexRO application/json
{"id":
string
The ID of the search index
"name":
string
The name of an element
"description":
string
The description of the search index
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
}The 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.