In Relativity, search providers let the user to search across documents in the workspace. By default, Relativity supports the following search providers:
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.
This page contains the following information:
To create a new search provider, send a POST request to the following URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{{workspaceID}}/searchproviders
Set the {{workspaceID}} variable to the Artifact ID of the workspace where you want to add a new search provider. See the following sample URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders
The request contains the following fields:
{ "Active":false, "AvailableForSearching":true, "RankCacheMultiplier":1, "MinRank":0, "MaxRank":100, "Order":10, "Name":"DtSearchIndex - Incremental-updated", "DLL":"kCura.EDDS.dtSearchProvider.dll", "Parameters":"" }
When the request is successful, the response contains the Artifact ID of the new search provider. It also returns the status code of 200.
To update a search provider, send a POST request to the following URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{{workspaceID}}/searchproviders/{{RelativitySearchProviderID}}
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the search provider. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the search provider. See the following sample URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513
When the request is successful, it returns the status code of 200.
To retrieve search provider metadata, send a GET request to the following URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{{workspaceID}}/searchproviders/{{RelativitySearchProviderID}}
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the search provider. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the search provider. See the following sample URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513
{ "Active": true, "AvailableForSearching": true, "ArtifactID": 1113513, "RankCacheMultiplier": 1, "MinRank": 0, "MaxRank": 100, "Order": 1, "Name": "DtSearchIndex - Incremental", "DLL": "kCura.EDDS.dtSearchProvider.dll", "Parameters": "" }
To delete a search provider, send a DELETE request to the following URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{{workspaceID}}/searchproviders/{{RelativitySearchProviderID}}
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the search provider. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the search provider. See the following sample URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513
When the request is successful, it returns the status code of 200.
To retrieve a list of objects with dependencies to the specified search provider, send a GET request to the following URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/{{workspaceID}}/{{RelativitySearchProviderID}}/dependencyList
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the search provider. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the search provider. See the following sample URL:
<host>/Relativity.Rest/API/Relativity.SearchProviders/workspace/1018294/searchproviders/1113513/dependencyList
[ { "ObjectType":{ "Secured":false, "Value":"Search Index" }, "Action":"Delete", "Count":{ "Secured":false, "Value":1 }, "Connection":{ "Secured":false, "Value":"Parent" }, "HierarchicLevel":0 }, { "ObjectType":{ "Secured":false, "Value":"Search Terms Report" }, "Action":"Unlink", "Count":{ "Secured":false, "Value":1 }, "Connection":{ "Secured":false, "Value":"Field: Index" }, "HierarchicLevel":0 }, { "ObjectType":{ "Secured":false, "Value":"Search / View" }, "Action":"Unlink", "Count":{ "Secured":false, "Value":1 }, "Connection":{ "Secured":false, "Value":"Field: SearchProviderID" }, "HierarchicLevel":0 } ]
Community Updates |
|||
Aero Developer FAQ | Evolving the Platform | Most recent release notes | |
Learn more | Learn more | Learn more |
Additional Resources |
|||
![]() |
![]() |
||
Access Third-Party Tools with GitHub | Create .NET Apps Faster with NuGet | ||
Visit github | visit nuget |