Search Terms Report Services in REST

The Search Terms Report Services API provides functionality for generating a search terms report, adding terms to an existing search terms report, retrying any errors, and viewing the build progress of a specific search terms report.

Search terms reports provide the ability to identify documents containing specific keywords or terms. You can enter multiple terms and generate a report listing the number of hits for each term in a document. To run a search terms report, you must select an active dtSearch index with the terms you wish to search added. To learn more, visit Search terms report.

The following sample use cases illustrate how you can use this service with a search terms report:

The Search Terms Report Services API also provides functionality for managing search terms reports. For more information, see Search Terms Report Services API.

This page contains the following information:

Client code sample

You can use the Search Terms Report Service by sending an HTTP request that makes a POST method call. See the following base URL for this service:

<host>/Relativity.REST/api/Relativity.SearchTermsReport/

You can use the following .NET code as a REST client for making calls with the Search Terms Report service. This code illustrates how to perform the following tasks:

Run all terms in a search terms report

Use the RunAllTerms endpoint to queue a Run All Terms job for the specified search terms report. This generates counts for each term and can be used the first time you generate a report or to regenerate the count for a report that has already been run. Send a POST request to this URL for the Search Terms Report service:

<host>/Relativity.REST/api/Relativity.SearchTermsReport/workspace/<workspaceID>/SearchTermsReport/<searchTermsReportID>/runAllTerms

The following fields on the request object are required:

The response does not contain any data. Success or failure is indicated by the HTTP status code. One of the following status codes may display:

Status Description
200 Success.
404 Invalid Workspace ID - Not Found.
500 Invalid Search Terms Report ID - Search Terms Report not found in workspace.

To learn more about other status codes which might display, visit HTTP status code.

Run pending terms in a search terms report

You can use the RunPendingTerms endpoint to queue a Run Pending Terms job for the specified search terms report. This allows you to add terms to the report by updating any terms that have a pending status. Send a POST request to this URL for the Search Terms Report service:

<host>/Relativity.REST/api/Relativity.SearchTermsReport/workspace/<workspaceID>/SearchTermsReport/<searchTermsReportID>/runPendingTerms

The following fields on the request object are required:

The response does not contain any data. Success or failure is indicated by the HTTP status code. One of the following status codes may display:

Status Description
200 Success.
404 Invalid Workspace ID - Not Found.
500 Invalid Search Terms Report ID - Search Terms Report not found in workspace.

To learn more about other status codes which might display, visit HTTP status code.

Retry errors in a search terms report

Use the RetryErrors endpoint to queue a Retry Errors job for the specified search terms report. This attempts to regenerate the report for search terms that returned error messages. Send a POST request to this URL for the Search Terms Report service:

<host>/Relativity.REST/api/Relativity.SearchTermsReport/workspace/<workspaceID>/SearchTermsReport/<searchTermsReportID>/retryErrors

The following fields on the request object are required:

The response does not contain any data. Success or failure is indicated by the HTTP status code. One of the following status codes may display:

Status Description
200 Success.
404 Invalid Workspace ID - Not Found.
500 Invalid Search Terms Report ID - Search Terms Report not found in workspace.

To learn more about other status codes which might display, visit HTTP status code.

View the build progress of a search terms report

You can use the GetProgress endpoint to view the build progress for the specified search terms report as well as some statistics about the search. Send a POST request to this URL for the Search Terms Report service:

<host>/Relativity.REST/api/Relativity.SearchTermsReport/workspace/<workspaceID>/SearchTermsReport/<searchTermsReportID>/getProgress

The following fields on the request object are required:

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