As part of the Relativity Services API (RSAPI) Deprecation, content on this page referring to the RSAPI and the Patient Tracker application is in the process of being deprecated and will no longer be supported. For more information and alternative APIs, see RSAPI deprecation process.

Get started with the Services API

The Services API provides you with a set of web services for programmatically manipulating many of the object types available in Relativity. Depending on the object type, you have the option to create, read, update, delete, and query on it. You can use the functionality provided by the Services API to perform many of the same tasks that you can complete through a Relativity web UI.

See these related pages:

Prerequisites for a development environment

Complete the following tasks before you set up your development environment:

  • (Optional) Complete the configuration steps for the Services API only if you want to use HTTP, HTTPS, or TCP as the scheme, or customize the client and server configuration settings. See Configuration options.

    Note: You don't need to complete any configuration steps if you use Net.Pipe as installed on the IIS when you run the Relativity installer.

  • Confirm that you have .NET version 4.6.2 installed on your development machine.

Set up a project in Visual Studio

  1. Create a new project in Visual Studio.
  2. Open the Solution Explorer.

    setting project properties in Visual Studio

  3. Confirm that the Target framework is .NET Framework 4.6.2. (In the Solution Explorer, expand your project and right-click Properties. Click Open to display the Application tab in the left pane. Select .NET Framework 4.6.2 in the Target framework box.)

    selecting .NET 4.6.2 as the target framework

  4. Add a reference to kCura.Relativity.Client.dll, Relativity.Services.Interfaces.dll, Relativity.Services.ServiceProxy.dll, Relativity.Kepler.dll, and Relativity.Services.DataContracts.dll. (In the Solution Explorer, right-click References, and then click Add References to display the Reference Manager dialog. Click the Browse button and select the libraries.)

    You can find the libraries in a Relativity web server installation.

  5. Add references to the following .NET framework assemblies: System.Runtime.Serialization, and System.ServiceModel. (In the Reference Manager dialog, expand Assemblies and click Framework.)

    adding .NET framework assemblies for the Services API

  6. (Optional) Point the RelativityServices API Diagnostic Tool at your server to determine the endpoint configurations that are exposed.