Relativity.Productions.Services Namespace

Relativity.Productions.API
The namespace contains the objects for interacting with Relativity productions.
Classes

  ClassDescription
Public classDocumentFieldNumbering
Represents the document field numbering scheme. The scheme allows you to use any fixed-length text field on the Document object for your numbering. For example, you could choose control number as the field and produce documents using the control number as the Bates field to maintain the original numbering of the documents.
Public classDocumentLevelNumbering
Represents the document-level numbering scheme. The scheme allows you to generate a new document number for each document. The number is branded on the images in your production.
Public classExistingProductionNumbering
Represents the numbering scheme based on an already existing production. The scheme allows you to re-use the Bates numbering fields from a previously-run production set. With existing production numbering you can change markup sets or header and footer designations without changing the Bates numbers. For example, you can use the scheme if a court order requires that your documents be produced without an already-applied confidential branding or if you need to redact already-produced documents for privilege.
Public classHeaderFooter
Represents the information on the headers and footers of produced pages.
Public classInnerReproductionJobResult
Represents the result of an attempt to create a specific reproduction of a production within a Reproduction Job set.
Public classMarkupSetRef
A reference object for Relativity markup sets. The properties only include the markup set name and artifact ID.
Public classOriginalImageNumbering
Represents the original image numbering scheme. The scheme allows you to retain the identifiers originally associated with your images. For example, you may want to retain the Bates or other numbers already assigned to images uploaded to Relativity. Relativity utilizes these values to create the production and attachment numbers.
Public classPageLevelNumbering
Represents the page-level numbering scheme. The scheme allows you to generate a new incremental number (also known as a Bates number) on every page across your document set. This number is branded on the images in your production.
Public classProduction
Represents a Relativity production.
Public classProductionDataSource
Represents a datasource that holds documents to be included in the production.
Public classProductionDataSourceRef
A reference object for Relativity production data sources. The properties only include the data source name and artifact ID.
Public classProductionDetails
Represents the details of a production as captured by the Production Details section on the Relativity UI.
Public classProductionFooters
Represents the set of footers on produced page. You can add a left footer, a right footer, and a center footer.
Public classProductionHeaders
Represents the set of headers on produced page. You can add a left header, a right header, and a center header.
Public classProductionJobResult
Represents the result of an attempt to create a job when a production is run or staged.
Public classProductionMetadata
Metadata for the production. Information in this object is created and updated by Relativity. Any information provided will be discarded on create and update of a Production object.
Public classProductionNumberingBase
Base class that represents the numbering scheme for production documents.
Public classProductionPlaceholder
Represents a production placeholder.
Public classProductionPlaceholderRef
A reference object for Relativity production placeholders. The properties only include the placeholder name and artifact ID.
Public classProductionProgressResult
Represents the result of a production progress check.
Public classProductionRef
A reference object for Relativity productions. The properties only include the production name and artifact ID.
Public classProductionSlim
DTO containing a ProductionRef and a dictionary of FieldValue pairs, identified by Field name.
Public classReplaceDocumentWithPlaceholderOptions
Defines options for creating a Reproduction job when using the ReproduceDocumentWithPlaceholder reproduction mode
Public classReplacePlaceholderWithDocumentOptions
Defines options for creating a Reproduction job when using the ReplacePlaceholderWithDocument reproduction mode
Public classReproduceDocumentOptions
Defines options for creating a Reproduction job when using the ReproduceDocument reproduction mode
Public classReproductionJobResult
Represents the result of an attempt to create a Reproduction job and all associated Production sets
Public classReproductionOptions
Options used for creating a Reproduction Job
Interfaces

  InterfaceDescription
Public interfaceIDocumentPageNumberFields
The interface enables setting the page number properties for the document-level and document field production numbering schemes.
Public interfaceIProductionDataSourceManager
The interface enables interaction with Relativity Production Data Sources.
Public interfaceIProductionManager
The interface enables interaction with Relativity Productions.
Public interfaceIProductionPlaceholderManager
The interface enables interaction with Relativity Production Placeholders.
Public interfaceIReproductionJobManager
This interface enables interaction with Relativity Reproductions.
Enumerations

  EnumerationDescription
Public enumerationDataSourceReadMode
The enum defines the valid modes of retrieving data sources and placeholders on datasources during Production API reads
Public enumerationHeaderFooterType
The enum defines valid values for production header and footer types.
Public enumerationNumberingType
The enum defines valid values for Relativity production numbering type.
Public enumerationPlaceholderImageFormat
The enum defines the valid values for placeholder image format
Public enumerationPlaceholderType
The enum defines valid values for placeholder types.
Public enumerationProductionJobStatus
The enum defines valid values for Relativity production job status.
Public enumerationProductionStatus
The enum defines valid values for Relativity production status.
Public enumerationProductionType
The enum defines valid values for Relativity production types.
Public enumerationReproduceNatives
The enum defines options for whether or not to include Natives when reproducing a document
Public enumerationReproductionStatus
This enum defines valid values for a reproduction job status.
Public enumerationReproductionType
This enum defines valid values for Existing Production Numbering reproduction types.
Public enumerationUseImagePlaceholderOption
The enum defines valid values for Use Image Placeholder option