Related Documents
Document Properties
Kbid
A29769
Last Modified
23-Mar-2021
Added to KB
22-Jan-2021
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10

Reference - Search Index API 1.0.0


Product Version

7.10

Product To Version


Status

final


Download Specification 

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

Introduction

OpenAPI Version: 3.0.1
Search Index Version: 1.0.0

Search Index API

The Search Index API contains search index related endpoints for the back office.

This API can be used to retrieve information about individual search indexes as well as filters within a search index and their assigned categories and subcategories.

Search Index API

/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

LocationNameFormatDefaultExampleDescription
in pathSearchIndexResourceKeystringRequired | 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.

Search Indexes API

/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

LocationNameFormatDefaultExampleDescription
in pathSearchIndexResourceKeystringRequired | The ID of a search index
in pathSearchFilterResourceKey stringRequired | The ID of a search filter
in pathSearchFilterResourceKeystringExampleKeyRequired | The key or UUID to resolve a single item
in querystartCategorystringcatalogA/categoryBThe 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

Request and Response Object Schemata

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 object. This is normally a constant that can be used to differentiate objects 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 object. This is normally a constant that can be used to differentiate objects 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 object. This is normally a constant that can be used to differentiate objects 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 object. This is normally a constant that can be used to differentiate objects by their type.
}

Disclaimer

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.

Customer Support
Knowledge Base
Product Resources
Tickets