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 Production Module v1 API

The Versioned Production Module v1 API from Relativity — 41 operation(s) for versioned production module v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Relativity Versioned Production 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 Production 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 49 operations across 41 paths, and defines 56 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

49 operations 41 paths 56 schemas 4 DELETE23 GET20 POST2 PUT

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 49

Across 41 paths, the API surfaces 49 operations — 4 DELETE, 23 GET, 20 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Versioned Production Module v1 49
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/production-data-sources
[Public] IProductionDataSourceManager -
Relativity.Productions.Services.V1.IProductionDataSourceManager.CreateSingleAsync 3 params body → 200
PUT
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/production-data-sources
[Public] IProductionDataSourceManager -
Relativity.Productions.Services.V1.IProductionDataSourceManager.UpdateSingleAsync 3 params body → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/production-data-sources/{dataSourceID}
[Public] IProductionDataSourceManager -
Relativity.Productions.Services.V1.IProductionDataSourceManager.ReadSingleAsync 4 params → 200
DELETE
/relativity-productions/v1/workspaces/{workspaceID}/production-data-sources/{dataSourceID}
[Public] IProductionDataSourceManager -
Relativity.Productions.Services.V1.IProductionDataSourceManager.DeleteSingleAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/production-data-sources/defaults
[Public] IProductionDataSourceManager -
Relativity.Productions.Services.V1.IProductionDataSourceManager.GetProductionDataSourceDefaultFieldValues 2 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.CreateSingleAsync 2 params body → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetAllAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.ReadSingleAsync 4 params → 200
DELETE
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.DeleteSingleAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/staging-errors
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.StagingErrorsAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/progress
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.ProgressAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/document-conflicts
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.DocumentConflictsAsync 3 params → 200
DELETE
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/document-conflicts
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.DeleteDocumentConflictsAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/re-productions
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetReproductionsAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/database-tokens/{databaseToken}/reproduction-types/{reproductionType}/eligible-re-productions
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionsEligibleForReproductionAsync 4 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/prerun-check
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.ProductionRunCheckAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/defaults
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionDefaultFieldValues 2 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/reproduction-jobs/{reproductionJobID}/stage-and-run
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.MassStageAndRunProductionsAsync 3 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/stage-and-run
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.MassStageAndRunAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/branding-errors
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetBrandingErrorsAsync 3 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/stage
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.StageProductionAsync 4 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/run
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.RunProductionAsync 5 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/re-run
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.RerunProductionAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/job-status
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetJobStatus 5 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/produced-production
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProducedProductionsFromDocumentsAsync 4 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/tokens/{token}/produced-production
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProducedProductionsFromDocumentsAsync 4 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/status-details
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionStatusDetails 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/production-restriction
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionRestrictionAsync 2 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/production-restriction
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.SetProductionRestrictionsAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/production-images/token
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionImagesTokenAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/production-images/{token}
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionImagesAsync 6 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/production-images
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionImagesAsync 4 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/productions/reproduction-jobs/{reproductionJobID}/cancel
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.CancelReproductionJobAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/productions/{productionID}/production-preview
[Public] IProductionManager -
Relativity.Productions.Services.V1.IProductionManager.GetProductionPreviewAsync 3 params → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/production-placeholders
[Public] IProductionPlaceholderManager -
Relativity.Productions.Services.V1.IProductionPlaceholderManager.CreateSingleAsync 2 params body → 200
PUT
/relativity-productions/v1/workspaces/{workspaceID}/production-placeholders
[Public] IProductionPlaceholderManager -
Relativity.Productions.Services.V1.IProductionPlaceholderManager.UpdateSingleAsync 2 params body → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/production-placeholders/{placeholderID}
[Public] IProductionPlaceholderManager -
Relativity.Productions.Services.V1.IProductionPlaceholderManager.ReadSingleAsync 3 params → 200
DELETE
/relativity-productions/v1/workspaces/{workspaceID}/production-placeholders/{placeholderID}
[Public] IProductionPlaceholderManager -
Relativity.Productions.Services.V1.IProductionPlaceholderManager.DeleteSingleAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/production-placeholders/defaults
[Public] IProductionPlaceholderManager -
Relativity.Productions.Services.V1.IProductionPlaceholderManager.GetProductionPlaceholderDefaultFieldValues 2 params → 200
POST
/relativity-productions/v1/production-queue/mass-cancel
[Public] IProductionQueueManager -
Relativity.Productions.Services.V1.IProductionQueueManager.MassCancelAsync 2 params → 200
POST
/relativity-productions/v1/production-queue/mass-retry
[Public] IProductionQueueManager -
Relativity.Productions.Services.V1.IProductionQueueManager.MassRetryAsync 2 params → 200
POST
/relativity-productions/v1/production-queue/mass-prioritize
[Public] IProductionQueueManager -
Relativity.Productions.Services.V1.IProductionQueueManager.MassPrioritizeAsync 3 params → 200
POST
/relativity-productions/v1/production-queue/production-jobs/cancel
[Public] IProductionQueueManager -
Relativity.Productions.Services.V1.IProductionQueueManager.CancelJobAsync 1 param body → 200
POST
/relativity-productions/v1/production-queue/production-jobs/mass-cancel
[Public] IProductionQueueManager -
Relativity.Productions.Services.V1.IProductionQueueManager.MassCancelProductionJobsAsync 1 param body → 200
POST
/relativity-productions/v1/production-queue/production-jobs/mass-retry
[Public] IProductionQueueManager -
Relativity.Productions.Services.V1.IProductionQueueManager.RetryProductionJobsAsync 1 param body → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/re-productions/re-production-job
[Public] IReproductionJobManager -
Relativity.Productions.Services.V1.IReproductionJobManager.CreateReproductionJobAsync 3 params body → 200
POST
/relativity-productions/v1/workspaces/{workspaceID}/re-productions/re-production-job-with-documents
[Public] IReproductionJobManager -
Relativity.Productions.Services.V1.IReproductionJobManager.CreateReproductionJobAsync 3 params body → 201
GET
/relativity-productions/v1/workspaces/{workspaceID}/re-productions/{reproductionJobID}/status
[Public] IReproductionJobManager -
Relativity.Productions.Services.V1.IReproductionJobManager.GetReproductionStatusByReproductionJobIDAsync 3 params → 200
GET
/relativity-productions/v1/workspaces/{workspaceID}/re-productions/jobs
[Public] IReproductionJobManager -
Relativity.Productions.Services.V1.IReproductionJobManager.GetReproductionJobIDsAsync 2 params → 200

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are ProductionMetadata (22 properties), ProductionDefaultFieldValues (19 properties), ProductionProgress (17 properties), ProductionDataSource (13 properties). Each schema is shown below with its type and property counts.

ProductionDataSourceDefaultFieldValues
object
2 properties
ReproduceDocumentOptions
object
3 properties
ProductionDetails
object
9 properties
ReplacePlaceholderWithDocumentOptions
object
5 properties
ReproductionRef
object
3 properties
ProductionQueueResult
object
5 properties
HeaderFooter
object
5 properties
ReproductionCandidate
object
5 properties
ProductionDataSource
object
13 properties
ProductionStatusResult
object
2 properties
ProductionRestrictions
object
2 properties
ProductionNumberingBase
object
2 properties
ProductionProgress
object
17 properties
ReproductionOptions
object
4 properties
PagedImageFilesResult
object
6 properties
ProductionPlaceholderRef
object
2 properties
Byte
object
CancelJobResult
object
5 properties
BrandingError
object
4 properties
ProductionJobRef
object
3 properties
MassRetryResult
object
4 properties
Sort
object
3 properties
IKeplerStream
object
5 properties
ProductionDefaultFieldValue1
object
3 properties
ProductionPlaceholder
object
10 properties
RetryJobResult
object
5 properties
FieldRef
object
4 properties
ImageFilesResult
object
3 properties
MarkupSetRef
object
2 properties
ProductionJobStatusResult
object
8 properties
ProductionSlim
object
3 properties
ImageFile
object
5 properties
DefaultFieldValue1
object
3 properties
ProductionMetadata
object
22 properties
MassCancelResult
object
4 properties
Production
object
13 properties
Securable1
object
2 properties
ProductionStatusDetailsResult
object
1 property
ReproductionStatusResult
object
5 properties
ProductionDocumentConflicts
object
3 properties
InnerReproductionJobResult
object
5 properties
ReplaceDocumentWithPlaceholderOptions
object
2 properties
RelativityApplicationRef
object
3 properties
ProductionPlaceholderDefaultFieldValues
object
1 property
ProductionRunCheckResult
object
5 properties
DuplicateDocument
object
2 properties
ReproductionJobResult
object
7 properties
ProductionJobResult
object
7 properties
ProductionHeaders
object
3 properties
ProductionDefaultFieldValues
object
19 properties
ProductionFooters
object
3 properties
MassProductionQueueResult
object
4 properties
UserRef
object
2 properties
SavedSearchRef
object
3 properties
ChoiceFieldValue
object
2 properties
StagingErrors
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-versioned-production-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 Production Module v1
← Back to R APIs
API Details
ID
relativity:relativity-versioned-production-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