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.

This page contains the following information:

• Prerequisites for a development environment
• Services API materials available in the SDK Installer
• Set up a project in Visual Studio

See these related pages:

• Connect to the Services API
• Build your first Services API client
• Best practices for the Services API

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.
• Obtain a copy of the Relativity SDK Installer and see the Development environment guidelines.

Services API materials available in the SDK Installer

When you run the Relativity SDK Installer, its add a folder containing Services API materials in the default location:

  \Program Files\kCura Corporation\Relativity SDK\Services API        

The Services API folder has the following subfolders with their related contents:

• Client – contains the kCura.Relativity.Client.dll, which must be reference by a Visual Studio project used for development with the Services API.
• Documentation – contains the Relativity - Services API.chm file with the Services API class library.
• Samples – includes various subfolders with sample code. In the kCura.Relativity.Client.APISamples folder, you will find a project containing sample class files in both VB.NET and C#. For more information, see Relativity SDK samples

Set up a project in Visual Studio

1. To run the installer, double-click the kCura.Relativity.SDK.Setup.msi, and follow the instructions in the installation wizard.
2. Create a new project in Visual Studio.
3. Open the Solution Explorer.

   

4. 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.)

   

5. 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, or in the Services API\Client folder of the SDK installation directory:

   

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