Relativity.Productions.SDK 12.6.1

API Differences between 12.6.1 and 12.1.13

454 Additions 0 Removals

Relativity.Productions.Services.Interfaces.V1.DTOs

public enum PlaceholderType
- PDF = 2

Relativity.Productions.Services.Interfaces.V2.DTOs

public class BrandingError
- public int DocumentID { get; set; }
- public string DocumentName { get; set; }
- public string ErrorMessage { get; set; }
- public int FileID { get; set; }
- public BrandingError()
public class CancelJobResult
- public bool CancelSuccessfullySent { get; }
- public List<string> Errors { get; set; }
- public int JobID { get; set; }
- public int ProductionID { get; set; }
- public int WorkspaceID { get; set; }
- public CancelJobResult()
public class ChoiceFieldValue
- public int ID { get; set; }
- public string Name { get; set; }
- public ChoiceFieldValue()
public class ClawbackDetails
- public string BatesSuffix { get; set; }
- public string Delimiter { get; set; }
- public int NumberOfDigitsForSuffix { get; set; }
- public int ReproductionJobId { get; set; }
- public bool StartNumberingOnSecondPage { get; set; }
- public ClawbackDetails()
public enum ContinueMessageType
- CannotContinue = 2
- Continue = 0
- OverrideAndContinue = 1
public enum DataSourceReadMode
- DataSourcesAndPlaceholders = 2
- None = 0
- OnlyDataSources = 1
public class DocumentFieldNumbering : ProductionNumberingBase, IDocumentPageNumberFields
- public string BatesPrefix { get; set; }
- public string BatesSuffix { get; set; }
- public string DocumentNumberPageNumberSeparator { get; set; }
- public bool IncludePageNumbers { get; set; }
- public FieldRef NumberingField { get; set; }
- public int NumberOfDigitsForPageNumbering { get; set; }
- public bool StartNumberingOnSecondPage { get; set; }
- public DocumentFieldNumbering()
public class DocumentLevelNumbering : PageLevelNumbering, IDocumentPageNumberFields
- public string DocumentNumberPageNumberSeparator { get; set; }
- public bool IncludePageNumbers { get; set; }
- public int NumberOfDigitsForPageNumbering { get; set; }
- public bool StartNumberingOnSecondPage { get; set; }
- public DocumentLevelNumbering()
public class DuplicateDocument
- public List<string> DataSourceNames { get; set; }
- public string Name { get; set; }
- public DuplicateDocument()
public class ExistingProductionNumbering : ProductionNumberingBase
- public ClawbackDetails ClawbackDetails { get; set; }
- public ProductionRef ExistingProduction { get; set; }
- public bool MergeWithExistingSet { get; set; }
- public ReproductionType ReproductionType { get; set; }
- public ExistingProductionNumbering()
public class HeaderFooter
- public string AdvancedFormatting { get; set; }
- public FieldRef Field { get; set; }
- public string FreeText { get; set; }
- public string FriendlyName { get; set; }
- public HeaderFooterType Type { get; set; }
- public HeaderFooter(string friendlyName)
public enum HeaderFooterType
- AdvancedFormatting = 6
- DocumentIdentifierAndPageNumber = 5
- Field = 2
- FreeText = 3
- None = 0
- OriginalImageNumber = 4
- ProductionBatesNumber = 1
public interface IDocumentPageNumberFields
- string DocumentNumberPageNumberSeparator { get; set; }
- bool IncludePageNumbers { get; set; }
- int NumberOfDigitsForPageNumbering { get; set; }
- bool StartNumberingOnSecondPage { get; set; }
public class ImageFile
- public int DocumentID { get; set; }
- public string FileGuid { get; set; }
- public int FileID { get; set; }
- public bool HasRedactions { get; set; }
- public int PageNumber { get; set; }
- public ImageFile()
public class ImageFilesResult
- public int Count { get; }
- public List<string> Errors { get; set; }
- public List<ImageFile> ImageFiles { get; set; }
- public ImageFilesResult()
public class MarkupSetRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public MarkupSetRef()
- public MarkupSetRef(int artifactID)
public class MassCancelResult
- public List<CancelJobResult> CancelJobResults { get; set; }
- public List<string> Errors { get; set; }
- public int NumberOfJobsCancelWasRequestedSuccessfully { get; set; }
- public int NumberOfJobsRequestedForCancel { get; set; }
- public MassCancelResult()
public enum NumberingType
- DocumentField = 4
- DocumentLevel = 1
- ExistingProduction = 3
- OriginalImage = 2
- PageLevel = 0
public class OriginalImageNumbering : ProductionNumberingBase
- public OriginalImageNumbering()
public class PagedImageFilesResult
- public List<string> Errors { get; set; }
- public List<ImageFile> ImageFiles { get; set; }
- public string NextPage { get; set; }
- public string PreviousPage { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultSet { get; set; }
- public PagedImageFilesResult()
public class PageLevelNumbering : ProductionNumberingBase
- public string BatesPrefix { get; set; }
- public int BatesStartNumber { get; set; }
- public string BatesSuffix { get; set; }
- public int NumberOfDigitsForDocumentNumbering { get; set; }
- public PageLevelNumbering()
public enum PlaceholderImageFormat
- Jpeg = 1
- Tiff = 0
public enum PlaceholderType
- Custom = 0
- Image = 1
public class Production : ProductionRef
- public List<ProductionDataSource> DataSources { get; set; }
- public ProductionDetails Details { get; set; }
- public ProductionFooters Footers { get; set; }
- public ProductionHeaders Headers { get; set; }
- public string Keywords { get; set; }
- public string Notes { get; set; }
- public ProductionNumberingBase Numbering { get; set; }
- public ProductionMetadata ProductionMetadata { get; set; }
- public List<RelativityApplicationRef> RelativityApplications { get; set; }
- public bool ShouldCopyInstanceOnWorkspaceCreate { get; set; }
- public List<Sort> SortOrder { get; set; }
- public Production()
public class ProductionDataSource : ProductionDataSourceRef
- public int ArtifactTypeID { get; set; }
- public bool BurnNativeRedactions { get; set; }
- public bool BurnPdfRedactions { get; set; }
- public bool BurnRedactions { get; set; }
- public MarkupSetRef MarkupSet { get; set; }
- public FieldRef NativeRedactionTextField { get; set; }
- public ProductionPlaceholderRef Placeholder { get; set; }
- public byte[] PlaceholderFileData { get; set; }
- public int? PlaceholderFileID { get; set; }
- public string PlaceholderFilename { get; set; }
- public int PlaceholderFileSize { get; set; }
- public ProductionType ProductionType { get; set; }
- public SavedSearchRef SavedSearch { get; set; }
- public UseImagePlaceholderOption UseImagePlaceholder { get; set; }
- public ProductionDataSource()
public class ProductionDataSourceDefaultFieldValues
- public DefaultFieldValue<bool> BurnRedactions { get; set; }
- public DefaultFieldValue<ChoiceFieldValue> UseImagePlaceholder { get; set; }
- public ProductionDataSourceDefaultFieldValues()
public class ProductionDataSourceRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public ProductionDataSourceRef()
- public ProductionDataSourceRef(int artifactID)
public class ProductionDefaultFieldValue<T> : DefaultFieldValue<T>
- public ProductionDefaultFieldValue()
public class ProductionDefaultFieldValues
- public ProductionDefaultFieldValue<ChoiceFieldValue> BrandingFont { get; set; }
- public ProductionDefaultFieldValue<int> BrandingFontSize { get; set; }
- public ProductionDefaultFieldValue<bool> CopyProductionOnWorkspaceCreate { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> DocumentPageSeparator { get; set; }
- public ProductionDefaultFieldValue<bool> IncludePageNumbers { get; set; }
- public ProductionDefaultFieldValue<bool> MergeExistingSet { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> NumberingType { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> NumberOfDigitsForDocumentNumbering { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> NumberOfDigitsForPageNumbering { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> PlaceholderImageFormat { get; set; }
- public ProductionDefaultFieldValue<bool> ScaleBrandingFont { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> SortOrderAscDesc1 { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> SortOrderAscDesc2 { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> SortOrderAscDesc3 { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> SortOrderAscDesc4 { get; set; }
- public ProductionDefaultFieldValue<ChoiceFieldValue> SortOrderAscDesc5 { get; set; }
- public ProductionDefaultFieldValue<int> StartNumber { get; set; }
- public ProductionDefaultFieldValue<bool> StartNumberOnSecondPage { get; set; }
- public ProductionDefaultFieldValue<bool> WrapBrandingText { get; set; }
- public ProductionDefaultFieldValues()
public class ProductionDetails
- public string BrandingFont { get; set; }
- public int BrandingFontSize { get; set; }
- public DateTime DateProduced { get; set; }
- public string EmailRecipients { get; set; }
- public string FirstBatesValue { get; set; }
- public string LastBatesValue { get; set; }
- public PlaceholderImageFormat PlaceholderImageFormat { get; set; }
- public bool ScaleBrandingFont { get; set; }
- public bool WrapBrandingText { get; set; }
- public ProductionDetails()
public class ProductionDocumentConflicts
- public IEnumerable<int> DocumentIDs { get; set; }
- public bool HasOverridePermission { get; set; }
- public ProductionRestrictions ProductionRestrictions { get; set; }
- public ProductionDocumentConflicts()
public class ProductionFooters
- public HeaderFooter Center { get; set; }
- public HeaderFooter Left { get; set; }
- public HeaderFooter Right { get; set; }
- public ProductionFooters()
public class ProductionHeaders
- public HeaderFooter Center { get; set; }
- public HeaderFooter Left { get; set; }
- public HeaderFooter Right { get; set; }
- public ProductionHeaders()
public class ProductionJobRef
- public int JobID { get; set; }
- public int ProductionID { get; set; }
- public int WorkspaceID { get; set; }
- public ProductionJobRef()
public class ProductionJobResult
- public IEnumerable<string> Errors { get; set; }
- public int JobID { get; set; }
- public IEnumerable<string> Messages { get; set; }
- public int ProductionID { get; set; }
- public IEnumerable<string> Warnings { get; set; }
- public bool WasJobCreated { get; set; }
- public int WorkspaceID { get; set; }
- public ProductionJobResult()
public enum ProductionJobStatus
- Complete = 3
- Errored = 2
- NotRunning = 0
- Running = 1
public class ProductionJobStatusResult
- public List<string> BrandingErrors { get; set; }
- public ProductionJobStatus JobStatus { get; set; }
- public string LastRunError { get; set; }
- public string LastRunStatus { get; set; }
- public int NumberOfBrandingErrors { get; set; }
- public decimal PercentageImaging { get; set; }
- public decimal PercentageProducing { get; set; }
- public ProductionStatus Status { get; set; }
- public ProductionJobStatusResult()
public class ProductionMetadata
- public decimal BrandingPercentageComplete { get; set; }
- public bool DocumentsHaveRedactions { get; set; }
- public int DocumentsWithImages { get; set; }
- public int DocumentsWithNatives { get; set; }
- public int DocumentsWithPdfs { get; set; }
- public int DocumentsWithPlaceholders { get; set; }
- public int DocumentsWithRedactions { get; set; }
- public decimal ImagingPercentageComplete { get; set; }
- public bool Imported { get; set; }
- public string LastRunError { get; set; }
- public string LastRunStatus { get; set; }
- public bool LegacyProductionSet { get; set; }
- public SavedSearchRef ProductionSavedSearch { get; set; }
- public UserRef RestrictionOverrideBy { get; set; }
- public DateTime RestrictionOverrideOn { get; set; }
- public ProductionStatus Status { get; set; }
- public Securable<UserRef> SystemCreatedBy { get; set; }
- public Securable<DateTime> SystemCreatedOn { get; set; }
- public Securable<UserRef> SystemLastModifiedBy { get; set; }
- public Securable<DateTime> SystemLastModifiedOn { get; set; }
- public int TotalDocumentCount { get; set; }
- public int TotalImagesCount { get; set; }
- public int TotalProducedImageSize { get; set; }
- public ProductionMetadata()
public class ProductionNumberingBase
- public FieldRef AttachmentRelationalField { get; set; }
- public NumberingType NumberingType { get; set; }
- public ProductionNumberingBase()
public class ProductionPlaceholderRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public ProductionPlaceholderRef()
- public ProductionPlaceholderRef(int artifactID)
public class ProductionProgress
- public string BeginBates { get; set; }
- public long CurrentBrandingQueueLength { get; set; }
- public long DocumentsWithImages { get; set; }
- public long DocumentsWithNatives { get; set; }
- public long DocumentsWithPdfs { get; set; }
- public long DocumentsWithPlaceHolders { get; set; }
- public long DocumentsWithRedactions { get; set; }
- public string EndBates { get; set; }
- public long ImagesBranded { get; set; }
- public float ImageSizeInGb { get; set; }
- public long ImagesToBeBranded { get; set; }
- public long ImagesWithErrors { get; set; }
- public long NativesRedacted { get; set; }
- public long NativesToBeRedacted { get; set; }
- public long NativesWithErrors { get; set; }
- public long PdfsBranded { get; set; }
- public long PdfsErrored { get; set; }
- public long PdfsRemaining { get; set; }
- public DateTime ProductionRunDate { get; set; }
- public DateTime StartTime { get; set; }
- public string Status { get; set; }
- public long TotalBrandingQueueLength { get; set; }
- public long TotalDocuments { get; set; }
- public long TotalImages { get; set; }
- public long TotalNatives { get; set; }
- public ProductionProgress()
public class ProductionRef
- public string Name { get; set; }
- public int ProductionID { get; set; }
- public ProductionRef()
public class ProductionRestrictions
- public int SavedSearchID { get; set; }
- public string SavedSearchName { get; set; }
- public ProductionRestrictions()
public class ProductionRunCheckResult
- public bool CanContinue { get; set; }
- public string ConflictMessage { get; set; }
- public ContinueMessageType ContinueMessage { get; set; }
- public List<string> PlaceholderErrors { get; set; }
- public List<string> ProductionErrors { get; set; }
- public ProductionRunCheckResult()
public class ProductionSlim : ProductionRef
- public Dictionary<string, object> FieldValues { get; set; }
- public ProductionSlim()
public enum ProductionStatus
- Branding = 6
- Canceling = 16
- Error = 8
- ErrorStartingProduction = 22
- New = 0
- Produced = 7
- ProducedWithErrors = 9
- Producing = 5
- ProducingCleaningExistingFiles = 17
- ProducingCreatingAndApplyingBatesNumbers = 11
- ProducingCreatingBrandingQueueRecords = 12
- ProducingCreatingPlaceholderImages = 10
- QueuedForBranding = 20
- QueuedForProduction = 19
- QueuedForStaging = 18
- Staged = 2
- Staging = 1
- StagingCleaningUpData = 14
- StagingCreatingProductionInformationRecords = 15
- StagingError = 3
- StagingRunningSavedSearches = 13
- StartingProduction = 21
- Waiting = 4
public class ProductionStatusDetailsResult
- public Dictionary<string, object> StatusDetails { get; set; }
- public ProductionStatusDetailsResult()
public enum ProductionType
- ImagesAndNatives = 2
- ImagesOnly = 0
- NativesOnly = 1
- PdfsAndNatives = 4
- PdfsOnly = 3
public class RelativityApplicationRef
- public int ArtifactID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public RelativityApplicationRef()
public class ReproductionCandidate : ProductionRef
- public string BeginBates { get; set; }
- public string DateProduced { get; set; }
- public string EndBates { get; set; }
- public ReproductionCandidate()
public class ReproductionRef : ProductionRef
- public bool IsDeleted { get; set; }
- public ReproductionRef()
public enum ReproductionType
- ReplaceDocumentWithPlaceholder = 1
- ReplacePlaceholderWithDocument = 2
- ReproduceDocument = 0
public class SavedSearchRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public string SearchType { get; set; }
- public SavedSearchRef()
- public SavedSearchRef(int artifactID)
public class Sort
- public SortEnum Direction { get; set; }
- public FieldRef FieldIdentifier { get; set; }
- public int Order { get; set; }
- public Sort()
public enum SortEnum
- Ascending = 0
- Descending = 1
public class StagingErrors
- public List<DuplicateDocument> DuplicateDocuments { get; set; }
- public long ErroredDocumentCount { get; set; }
- public string ErrorMessage { get; set; }
- public StagingErrors()
public enum UseImagePlaceholderOption
- AlwaysUseImagePlaceholder = 2
- NeverUseImagePlaceholder = 1
- WhenNoImageExists = 0
public class UserRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public UserRef()

Relativity.Productions.Services.Interfaces.V2.DTOs.Serialization

public class ProductionNumberingSerializer : IModelSerializer<ProductionNumberingBase>, IModelSerializer, IModelSerializer<DocumentLevelNumbering>, IModelSerializer<PageLevelNumbering>, IModelSerializer<ExistingProductionNumbering>, IModelSerializer<OriginalImageNumbering>
- public ProductionNumberingSerializer()
- public ProductionNumberingBase TransformForDeserialize(object data)
- public object TransformForSerialize(ProductionNumberingBase model)
- public object TransformForSerialize(DocumentLevelNumbering model)
- public object TransformForSerialize(PageLevelNumbering model)
- public object TransformForSerialize(ExistingProductionNumbering model)
- public object TransformForSerialize(OriginalImageNumbering model)

Relativity.Productions.Services.Interfaces.Versioned.v2.Shared

public class DefaultFieldValue<T>
- public T DefaultValue { get; set; }
- public Guid Guid { get; set; }
- public int ID { get; set; }
- public DefaultFieldValue()

Relativity.Productions.Services.V1

public interface IProductionManager : IDisposable
- Task<IKeplerStream> GetProductionPreviewAsync(int workspaceID, int productionID)

Relativity.Productions.Services.V2

public interface IProductionDataSourceManager : IDisposable
- Task<int> CreateSingleAsync(int workspaceID, int productionID, ProductionDataSource dataSource)
- Task DeleteSingleAsync(int workspaceID, int dataSourceID)
- Task<ProductionDataSourceDefaultFieldValues> GetProductionDataSourceDefaultFieldValues(int workspaceID)
- Task<ProductionDataSource> ReadSingleAsync(int workspaceID, int dataSourceID, bool withPlaceholderImage = false)
- Task UpdateSingleAsync(int workspaceID, int productionID, ProductionDataSource dataSource)
public interface IProductionManager : IDisposable
- Task<MassCancelResult> CancelReproductionJobAsync(int workspaceID, int reproductionJobID)
- Task<int> CreateSingleAsync(int workspaceID, Production production)
- Task DeleteDocumentConflictsAsync(int workspaceID, int productionID)
- Task DeleteSingleAsync(int workspaceID, int productionID)
- Task<ProductionDocumentConflicts> DocumentConflictsAsync(int workspaceID, int productionID)
- Task<List<Production>> GetAllAsync(int workspaceID, int dataSourceReadMode = 1)
- Task<List<BrandingError>> GetBrandingErrorsAsync(int workspaceID, int productionID)
- Task<ProductionJobStatusResult> GetJobStatus(int workspaceID, int productionID, bool includePercentages = false, int numberOfBrandingErrors = 10)
- Task<List<ProductionSlim>> GetProducedProductionsFromDocumentsAsync(int workspaceID, IEnumerable<int> documentIDs, bool excludeNonReproducible = false)
- Task<List<ProductionSlim>> GetProducedProductionsFromDocumentsAsync(int workspaceID, string token, bool excludeNonReproducible = false)
- Task<ProductionDefaultFieldValues> GetProductionDefaultFieldValues(int workspaceID)
- Task<PagedImageFilesResult> GetProductionImagesAsync(int workspaceID, int productionID, string token, int top = 100, int skip = 0)
- Task<ImageFilesResult> GetProductionImagesAsync(int workspaceID, int productionID, List<int> documentIDs)
- Task<string> GetProductionImagesTokenAsync(int workspaceID, int productionID)
- Task<IKeplerStream> GetProductionPreviewAsync(int workspaceID, int productionID)
- Task<int> GetProductionRestrictionAsync(int workspaceID)
- Task<IEnumerable<ReproductionCandidate>> GetProductionsEligibleForReproductionAsync(int workspaceID, string databaseToken, int reproductionType)
- Task<ProductionStatusDetailsResult> GetProductionStatusDetails(int workspaceID, int productionID)
- Task<IEnumerable<ReproductionRef>> GetReproductionsAsync(int workspaceID, int productionID)
- Task<List<ProductionJobResult>> MassStageAndRunAsync(int workspaceID, List<int> productionIDs)
- Task<IEnumerable<ProductionJobResult>> MassStageAndRunProductionsAsync(int workspaceID, int reproductionJobID)
- Task<ProductionRunCheckResult> ProductionRunCheckAsync(int workspaceID, int productionID)
- Task<ProductionProgress> ProgressAsync(int workspaceID, int productionID)
- Task<Production> ReadSingleAsync(int workspaceID, int productionID, int dataSourceReadMode = 1)
- Task RerunProductionAsync(int workspaceID, int productionID)
- Task<ProductionJobResult> RunProductionAsync(int workspaceID, int productionID, bool suppressWarnings = false, bool overrideConflicts = false)
- Task SetProductionRestrictionsAsync(int workspaceID, int productionRestrictionSearchID)
- Task<ProductionJobResult> StageProductionAsync(int workspaceID, int productionID, bool automaticallyRun = false)
- Task<StagingErrors> StagingErrorsAsync(int workspaceID, int productionID)
public class ProductionMapperFactory
- public ProductionMapperFactory()
- public static string GetRouteForAction(int workspaceID, int productionID)