Mapping API Methods

Upsert

The Upsert method is used to insert mapping records. The mapping records are often categories or departments. There is a limit of 125 mapping objects that can be sent in a request. This method can be called multiple times to accommodate more than 125.

Endpoint	Method	Header Key

Endpoint	Method	Header Key
api/mapping/upsert	POST	Content-Type: application/json

Name		Data Type	Required	Description

Name		Data Type	Required	Description
IndexName		string	required	Name of the index in which the mapping is being built
Mappings		Array of objects	required	See mapping Object section.

Retrieve Mapping

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

Endpoint	Method	Header Key

Endpoint	Method	Header Key
api/mapping	GET	Content-Type: application/json

Name		Data Type	Required	Description

Name		Data Type	Required	Description
IndexName		string	required	Name of the index from which to retrieve mapping
Field		string	optional	A name of a field to narrow down the mapping results

Object	Data Type	Description

Object	Data Type	Description
Mapping	Array of strings	The object encapsulating the mapping information
> Field	string	Field name used in the mapping
> Label	string	Display label of the mapping
> SortOrder	string	Custom sort order
Field	string	Field name used in the mapping
Value	string	Facet value

Objects

Mapping Object

Object	Data Type	Required	Description
Field	string	required	Field name used in the mapping
Label	string	required	Display label of the mapping
Value	string	required	Facet value
SortOrder	integer	required	Custom sort order

Mapping API Examples

Please follow this page for details - Mapping API Examples

Hawksearch Knowledge Base

Hawksearch v4.0 - Mapping API