Imaging

Create static images from native documents. This page aims to collect and centralize any useful information on the Imaging business domain.

Current Imaging API content

.NET API

REST services

Version History

Release Notes
  • Imaging SDK update for latest Imaging RAP compatibility
Supported Relativity Version Range
Lowest Version Highest Version
12.2.99.22 Latest
Supported RAP Version Range
Lowest Version Highest Version
12.3.1 Latest
Release Notes
  • Imaging SDK update for Relativity 12.2 compatibility
Supported Relativity Version Range
Lowest Version Highest Version
12.2.99.22 Latest
Supported RAP Version Range
Lowest Version Highest Version
12.2.99.22 Latest
Release Notes
  • The Imaging API is a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Imaging.Services.Interfaces.V1. The URLs used through REST also include these updates, as exemplified by relativity-imaging/v1.
  • The Imaging API includes the following enhancements
    • IDocumentStatusManager interface – this new interface contains the GetStatusAsync() method, which retrieves status information about the imaging job for a document.
    • IImagingEnvironmentManager interface - this new interface contains the CleanupInactiveJobsAsync() method for cleaning up inactive imaging jobs, and the GetMaxMassImagingJobSizeAsync() method for retrieving the size of a mass imaging job.
    • IImagingJobManager interface – includes the new MassImageDocumentsByMassProcessIdAsync(), which submits a mass imaging job.
    • New methods to replace the SaveAsync() methods on various interfaces as follows:
      • IImagingProfileManager interface – includes the following new methods: CreateBasicImagingProfileAsync(), CreateNativeImagingProfileAsync(), and UpdateAsync().
      • IImagingSetManager interface – includes the new CreateAsync() and UpdateAsync() methods.
      • IApplicationFieldCodeManager interface - includes the new CreateAsync() and UpdateAsync() methods.
Supported Relativity Version Range
Lowest Version Highest Version
12.1.137.19 Latest
Supported RAP Version Range
Lowest Version Highest Version
11.2.199.24 Latest