Coveo for Sitecore 5 is now available!

Understanding the REST Endpoint Pipelines

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

They are somewhat 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
coveoProcessParsedRestResponse REST response processing Used to customize REST response received from the local search REST endpoint. Coveo.SearchProvider.Rest.Processors.CoveoProcessParsedRestResponse.ResolveResultClickableUriProcessor
getSearchUserIdentities REST query processing

Used to define which user identities are performing the search query (see Creating a Processor for the getSearchUserIdentities Pipeline).

Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddVirtualGroups

Coveo for Sitecore (December 2016) Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddEveryoneRoleWhenNoIdentities

Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddUserMembers (disabled)
Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddActiveDirectoryIdentity (disabled)

Coveo for Sitecore (October 2016) getUserMembers 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.Connectors.Sitecore2.SitecoreWebService.Pipelines.GetUserMembers.SitecoreEmailProcessor
Coveo for Sitecore (October 2016) 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
httpRequestBegin HTTP request routing Used to route REST requests to the local search REST endpoint, so that they are not processed by Sitecore. Coveo.SearchProvider.Rest.Processors.HttpRequestBegin.TransferCoveoRestSearchRequest
Recommended Articles