Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Relativity

Relativity Versioned Imaging Module v1 API

The Versioned Imaging Module v1 API from Relativity — 20 operation(s) for versioned imaging module v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Relativity Versioned Imaging Module v1 API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Versioned Imaging Module v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 26 operations across 20 paths, and defines 36 schemas. It is described by OpenAPI 3.0.1, at version V1.

Requests are made against a single base URL, /Relativity.REST/api.

26 operations 20 paths 36 schemas 4 DELETE7 GET15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 26

Across 20 paths, the API surfaces 26 operations — 4 DELETE, 7 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.

Versioned Imaging Module v1 26
GET
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.ReadAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.UpdateAsync 3 params body → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.CreateAsync 2 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/documents/{documentID}/status
[Public] IDocumentStatusManager -
Relativity.Imaging.Services.Interfaces.V1.IDocumentStatusManager.GetStatusAsync 3 params → 200
DELETE
/relativity-imaging/v1/environment/jobs/inactive-jobs
[Public] IImagingEnvironmentManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingEnvironmentManager.CleanupInactiveJobsAsync 1 param → 200
GET
/relativity-imaging/v1/environment/jobs/mass-imaging-max-size
[Public] IImagingEnvironmentManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingEnvironmentManager.GetMaxMassImagingJobSizeAsync 1 param → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/run
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.RunImagingSetAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/retry-errors
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.RetryImagingSetErrorsAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/jobs/{imagingJobID}/stop
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.StopImagingJobAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/documents/{documentArtifactID}/image
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.ImageDocumentAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/documents/mass-image
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.MassImageDocumentsByMassProcessIdAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/jobs/{imagingJobID}/priority
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.UpdateJobPriorityAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/basic
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.CreateBasicImagingProfileAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/native
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.CreateNativeImagingProfileAsync 2 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.ReadAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.UpdateAsync 3 params body → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.CreateAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.UpdateAsync 3 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.ReadAsync 3 params → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/release-images
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.ReleaseImagingSetAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/hide-images
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.HideImagingSetAsync 3 params → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/status
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.GetStatusAsync 3 params → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/native-types/{nativeTypeID}
[Public] INativeTypeManager -
Relativity.Imaging.Services.Interfaces.V1.INativeTypeManager.ReadAsync 3 params → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are ImagingSetStatusResponse (20 properties), SpreadsheetOptions (17 properties), ImagingProfile (14 properties), ImagingProfileUpdateRequest (13 properties). Each schema is shown below with its type and property counts.

NativeType
object
8 properties
DocumentStatusResponse
object
4 properties
ImagingSetUpdateRequest
object
4 properties
NativeImagingEngineOptions
object
8 properties
NativeTypeRef
object
2 properties
DocumentError
object
2 properties
ApplicationFieldCodeRequest
object
5 properties
ImagingProfileRef
object
2 properties
ImageOnTheFlyRequest
object
4 properties
HtmlOptions
object
1 property
ImagingSet
object
6 properties
ImagingProfile
object
14 properties
PresentationOptions
object
2 properties
EmailOptions
object
9 properties
BasicImagingEngineOptions
object
9 properties
NativeImagingProfileCreateRequest
object
12 properties
SpreadsheetOptions
object
17 properties
MassImageRequest
object
4 properties
UpdateJobPriorityRequest
object
2 properties
ImagingSetResponse
object
1 property
WordProcessingOptions
object
3 properties
DocumentWarning
object
2 properties
MassImagingResponse
object
1 property
UpdateJobPriorityResponse
object
2 properties
ApplicationFieldCode
object
7 properties
ImagingSetCreateRequest
object
4 properties
ImagingProfileUpdateRequest
object
13 properties
ApplicationFieldCodeRef
object
2 properties
ImagingSetRequest
object
2 properties
StopImagingJobRequest
object
1 property
ImagingSetStatusResponse
object
20 properties
ImageOnTheFlyResponse
object
1 property
ImagingSetStatus
object
7 properties
StopImagingJobResponse
object
2 properties
BasicImagingProfileCreateRequest
object
5 properties
FieldRef
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-versioned-imaging-module-v1-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
AE Profile APIs.io
Relativity ArchiveJobs API
AE Profile APIs.io
Relativity ARM Module v1 API
AE Profile APIs.io
Relativity ARM Module v3 API
AE Profile APIs.io
Relativity BillableSummaryReports API
AE Profile APIs.io
Relativity BillingConfiguration API
AE Profile APIs.io
Relativity BillingInsights API
AE Profile APIs.io
Relativity Client Side Libraries Module API
AE Profile APIs.io
Relativity ColdStorage API
AE Profile APIs.io
Relativity CollectAPI API
AE Profile APIs.io
Relativity Conceptual Analytics v1 API
AE Profile APIs.io
Relativity Directory API
AE Profile APIs.io
#Versioned Imaging Module v1
← Back to R APIs
API Details
ID
relativity:relativity-versioned-imaging-module-v1-api
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Docs
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
Provider
Relativity
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network