About the REST Endpoint Pipelines

This is for:

Developer System Administrator
Warning
Legacy feature

This article pertains to the Coveo Hive framework which is now in maintenance mode.

Choose one of Coveo’s more modern, lightweight, and responsive libraries for any future search interface development. See the search interface Implementation guide for more details.

The search REST endpoint pipelines let you handle, process, and customize REST requests sent by the local search REST endpoint deployed by Coveo for Sitecore.

They’re less frequently customized than the indexing and search pipelines. You can find them in the /configuration/sitecore/pipelines section of the Coveo.SearchProvider.Rest.config file.

The following table is a summary of all those pipelines:

Pipeline Purpose Description Processors included by default Is typically customized?

coveoProcessRestJsonResponse

REST response processing

Used to process REST responses received from the local search REST endpoint.

Coveo.SearchProvider.Rest.Processors.CoveoProcessRestJsonResponse.ParseJsonRestSearchResponseProcessor

x

coveoProcessParsedRestResponse

REST response processing

Used to customize REST response received from the local search REST endpoint.

Coveo.SearchProvider.Rest.Processors.CoveoProcessParsedRestResponse.ResolveResultClickableUriProcessor

x

getSearchUserIdentities

REST query processing

Used to define which user identities are performing the search query (see Add User Identities to a Search Request).

Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddVirtualGroups
Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddEveryoneRoleWhenNoIdentities
Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddUserMappings (disabled)
Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddActiveDirectoryIdentity (disabled)

x

getUserMappings

REST query processing

Used by the Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddUserMembers processor to map identities of various types to the active Sitecore user.

Coveo.SearchProvider.Rest.Processors.GetUserMappings.AddSitecoreUserEmailIdentity

x

httpRequestBegin

HTTP request routing

Used to route REST requests to the local search REST endpoint, so that they’re not processed by Sitecore.

Coveo.SearchProvider.Rest.Processors.HttpRequestBegin.TransferCoveoRestSearchRequest

x