Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Current »

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

https://indexing-dev.hawksearch.net/

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

Test

https://indexing-test.hawksearch.net/

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

Production

https://indexingapi.hawksearch.com/

Configurations for an engine in this location are maintained in the Hawksearch Workbench at dashboard-na.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.

 Request

Endpoint

Method

Header Key

api/hierarchy/upsert

POST

Content-Type: application/json

 Parameters

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. 

 Request

Endpoint

Method

Header Key

api/hierarchy/rebuild

POST

Content-Type: application/json

 Parameters

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.

 Request

Endpoint

Method

Header Key

api/hierarchy/delete-all

POST

Content-Type: application/json

 Parameters

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.

 Request

Endpoint

Method

Header Key

api/hierarchy/delete-items

POST

Content-Type: application/json

 Parameters

Name

Data Type

Required

Description

IndexName

string

required

Name of the index in which the hierarchy is being built

Ids

Array of strings

required

Each string contains the document id of an item that suppose to be delete

Retrieve Hierarchy

This method can be used to verify the hierarchy that has been created.

 Request

Endpoint

Method

Header Key

api/hierarchy/

POST

Content-Type: application/json

 Parameters

Name

Data Type

Required

Description

IndexName

string

required

Name of the index from which to retrieve hierarchy

 Response

Object

Data Type

Description

Mapping

Array of strings

The object encapsulating the mapping information

    > Field

String

Field name used in the hierarchy

    > Path

String

A slash-separated value indicating the nested hierarchy 

    > Code

String

SEO friendly code for the hierarchy

    > Label

String

Display label of the hierarchy

Field

String

Field name used in the hierarchy

Value

String

Facet value 

Url

String

Url of the page representing the hierarchy (optional)

ImageUrl

String

Url of the image representing the hierarchy (optional)

Objects

Hierarchy Object

Hierarchy Object


Description

ObjectData TypeAlwaysDescription

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

  • No labels