This document defines the available Hierarchy API methods available for Hawksearch version 4.0 and the associated objects. This documentation is intended for clients’ development teams to create and maintain the Hawksearch v4.0 indexes.
Table of Contents
Domains
Hawksearch has three environments available: Development, Test and a load-balanced Production. When using the search API methods in this document, the following domains can be used to access each environment after your engine has been set-up in that environment.
Development
Configurations for an engine in this location are maintained in the Hawksearch Workbench at dev.hawksearch.net.
Test
Configurations for an engine in this location are maintained in the Hawksearch Workbench at test.hawksearch.net.
Production
Configurations for an engine in this location are maintained in the Hawksearch Workbench at manage.hawksearch.com.
Hierarchy API Methods
Upsert
The Upsert method is used to insert hierarchy records. The hierarchy records are often categories or departments. There is a limit of 125 hierarchy objects that can be sent in a request. This method can be called multiple times to accommodate more than 125. After all hierarchy objects have been sent, the hierarchy/rebuild method can be used.
Rebuild
The Rebuild method is used to initialize hierarchy mapping.
Delete All
The method removes all hierarchy items. After all hierarchy objects have been removed, the hierarchy/rebuild method can be used.
Delete Items
The Delete Items method removes multiple documents from a specific hierarchy based on ids. After hierarchy objects have been removed, the hierarchy/rebuild method can be used.
Retrieve Hierarchy
This method can be used to verify the hierarchy that has been created.
Objects
Hierarchy Object
Description
Object | Data Type | Always | Description |
---|---|---|---|
HierarchyId | String | Yes | Unique identifier for the hierarchy entry |
Name | String | Yes | Display name for the hierarchy entry |
ParentHierarchyId | String | Yes | The HierarchyId of the parent hierarchy for this hierarchy entry. If this hierarchy entry is a top-level, the value passed should be "0". |
IsActive | Boolean | No | Indicates if the hierarchy entry is active and should be displayed. It is not required to send inactive hierarchies, but some product systems generate them for sending. |
SortOrder | Number | No | Integer to use for sorting the hierarchy entries for display |
Custom | String | No | Placeholder for custom implementation use |
Hierarchy API Examples
Please follow this page for details - Hierarchy API Examples