Relativity.Productions.Services.Interfaces.V2.DTOs
Namespace with 58 public types
Classes
BrandingError
Represents a branding error for a document
CancelJobResult
Represents the results of cancel operation on a production job.
ChoiceFieldValue
Represents the choice for a field value
ClawbackDetails
Represents the clawback details for an Existing Production Numbering reproduction job.
DocumentFieldNumbering
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.
DocumentLevelNumbering
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.
DuplicateDocument
Duplicate document found in multiple data sources during staging.
ExistingProductionNumbering
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.
HeaderFooter
Represents the information on the headers and footers of produced pages.
ImageFile
DTO representing a production image file.
ImageFilesResult
Result containing requested and other metadata.
MarkupSetRef
A reference object for Relativity markup sets. The properties only include the markup set name and artifact ID.
MassCancelResult
Represents the results of a cancel operation on multiple production jobs, including the total number of jobs requested and successfully canceled.
OriginalImageNumbering
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.
PagedImageFilesResult
Paged result containing requested and other metadata.
PageLevelNumbering
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.
Production
Represents a Relativity production.
ProductionDataSource
Represents a datasource that holds documents to be included in the production.
ProductionDataSourceDefaultFieldValues
Default field values for new Production Data Source object.
ProductionDataSourceRef
A reference object for Relativity production data sources. The properties only include the data source name and artifact ID.
ProductionDefaultFieldValue`1
Default field value for Production
ProductionDefaultFieldValues
Default field values for new Production object.
ProductionDetails
Represents the details of a production as captured by the Production Details section on the Relativity UI.
ProductionDocumentConflicts
Document conflicts information of a Production.
ProductionFooters
Represents the set of footers on produced page. You can add a left footer, a right footer, and a center footer.
ProductionHeaders
Represents the set of headers on produced page. You can add a left header, a right header, and a center header.
ProductionJobRef
Represents a reference to a production job.
ProductionJobResult
Represents the result of an attempt to create a job when a production is run or staged.
ProductionJobStatusResult
Represents the result of an attempt to read the status of a production job.
ProductionMetadata
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.
ProductionNumberingBase
Base class that represents the numbering scheme for production documents.
ProductionPlaceholderRef
A reference object for Relativity production placeholders. The properties only include the placeholder name and artifact ID.
ProductionProgress
Progress details of a production.
ProductionRef
Represents a unique reference to a Relativity Production Set.
ProductionRestrictions
Production Restrictions on the Workspace.
ProductionRunCheckResult
Conflicts and errors indicating potential issues with running a production.
ProductionSlim
DTO containing a and a dictionary of FieldValue pairs, identified by Field name.
ProductionStatusDetailsResult
Representation of the result of an attempt to read the status of the production at each step
RelativityApplicationRef
Represents a unique reference to a Relativity Production Set.
ReproductionCandidate
Production eligible for reproduction.
ReproductionRef
Represents a unique reference to a Relativity Production Set produced as a Re-production.
SavedSearchRef
A reference object for saved search. The properties only include the saved search Name, SearchType and Artifact ID.
Sort
Represents a production sort.
StagingErrors
Error result of the staging step for a production
UserRef
Represents a User in a Workspace
Enumerations
ContinueMessageType
Message to indicate production continue options before proceed to run
DataSourceReadMode
The enum defines the valid modes of retrieving data sources and placeholders on datasources during Production API reads
HeaderFooterType
The enum defines valid values for production header and footer types.
NumberingType
The enum defines valid values for Relativity production numbering type.
PlaceholderImageFormat
The enum defines the valid values for placeholder image format
PlaceholderType
The enum defines valid values for placeholder types.
ProductionJobStatus
The enum defines valid values for Relativity production job status.
ProductionStatus
The enum defines valid values for Relativity production status.
ProductionType
The enum defines valid values for Relativity production types.
ReproductionType
This enum defines valid values for Existing Production Numbering reproduction types.
SortEnum
The enum defines the sort order of a field for Production sort.
UseImagePlaceholderOption
The enum defines valid values for Use Image Placeholder option
Interfaces
IDocumentPageNumberFields
The interface enables setting the page number properties for the document-level and document field production numbering schemes.