Search Provider (REST)

In Relativity, search providers let the user to search across documents in the workspace. By default, Relativity supports the following search providers: 

  • Keyword search provider
  • dtSearch provider
  • Analytics search provider

The Search Provider API service provides an API for the developers to interact with these Search Providers programmatically.

You can also use the Search Provider API services through the .NET interfaces. These interfaces support the same functionality as available through REST. For more information, see Search Provider API.

Create a search provider

To create a new search provider, send a POST request to the following URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{workspaceID}/searchproviders

Set {workspaceID} to the Artifact ID of the workspace where you want to add a new search provider. See the following sample URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders

When the request is successful, the response contains the Artifact ID of the new search provider. It also returns the status code of 200.

Update a search provider

To update a search provider, send a PUT request to the following URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{workspaceID}/searchproviders/{RelativitySearchProviderID}

Set {workspaceID} to the Artifact ID of the workspace containing the search provider. Set {RelativitySearchProviderID} to the Artifact ID of the search provider. See the following sample URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513

When the request is successful, it returns the status code of 200.

Retrieve search provider metadata

To retrieve search provider metadata, send a GET request to the following URL: 

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{workspaceID}/searchproviders/{RelativitySearchProviderID}

Set {workspaceID} to the Artifact ID of the workspace containing the search provider. Set {RelativitySearchProviderID} to the Artifact ID of the search provider. See the following sample URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513

Delete a search provider

To delete a search provider, send a DELETE request to the following URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{workspaceID}/searchproviders/{RelativitySearchProviderID}

Set {workspaceID} to the Artifact ID of the workspace containing the search provider. Set {RelativitySearchProviderID} to the Artifact ID of the search provider. See the following sample URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513

When the request is successful, it returns the status code of 200.

Retrieve a list of dependencies

To retrieve a list of objects with dependencies to the specified search provider, send a GET request to the following URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{workspaceID}/{RelativitySearchProviderID}/dependencyList

Set {workspaceID} to the Artifact ID of the workspace containing the search provider. Set {RelativitySearchProviderID} to the Artifact ID of the search provider. See the following sample URL:

Copy 
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513/dependencyList