ISearchTermsReportManager Interface

Relativity Search Terms Report Manager API
Exposes methods for running Search Term Reports

Namespace:  Relativity.SearchTermsReport.Interfaces
Assembly:  Relativity.SearchTermsReport.Interfaces (in Relativity.SearchTermsReport.Interfaces.dll) Version: 11.3.0.0
Syntax

C#
public interface ISearchTermsReportManager : IDisposable

The ISearchTermsReportManager type exposes the following members.

Methods

  NameDescription
Public methodCode exampleCreateTerms
Creates a series of Search Term Results associated with the specified Search Term Report.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodCode exampleGetProgress
Gets build progress for the specified Search Terms Report
Public methodCode exampleGetReportURL
Builds the URL used for generating a report for a specified Search Terms Report
Public methodCode exampleGetResultsURL
Builds the URL used for navigating to the Search Terms Result tab with the appropriate filter criteria for this search terms report.
Public methodCode exampleGetStatus
Gets the current status of the requested Search Terms Report object. Note: This endpoint is intended to only be used for Relativity Automated Workflows. For an alternative, use the GetProgress(Int32, Int32) endpoint.
Public methodCode exampleRetryErrors
Queues a Retry Errors job for the specified Search Terms Report
Public methodCode exampleRunAllTerms
Queues a Run All Terms job for the specified Search Terms Report
Public methodCode exampleRunPendingTerms
Queues a Run Pending Terms job for the specified Search Terms Report
Public methodCode exampleUpdateTerms
Updates the list of Search Term Results terms to have the specified updated text and color changes from the upddate request.
Top
See Also

Reference