Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section

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

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

indexing-dev.hawksearch.net/

Configurations for an engine in this location are maintained in the Hawksearch Workbench at dev.hawksearch.net.

Test

indexing-test.hawksearch.net/

Configurations for an engine in this location are maintained in the Hawksearch Workbench at test.hawksearch.net.

Production

indexingapi-na.hawksearch.com/

Configurations for an engine in this location are maintained in the Hawksearch Workbench at managedashboard-na.hawksearch.com.

Hierarchy API Methods

Upsert

...

Expand
titleParameters

Name

Data Type

Required

Description

IndexName

string

required

Name of the index in which the hierarchy is being built

Hierarchies

Array of objects

required

See Hierarchy Object section.

Rebuild

The Rebuild method is used to initialize hierarchy mapping. 

...

Expand
titleParameters

Name

Data Type

Required

Description

IndexName

string

required

Name of the index in which the hierarchy is being built

Delete All

The method removes all hierarchy items. After all hierarchy objects have been removed, the hierarchy/rebuild method can be used.

...

Expand
titleParameters

Name

Data Type

Required

Description

IndexName

string

required

Name of the index in which the hierarchy is being built

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.

...