Relativity.Processing.SDK 13.29.310

API Differences between 13.29.310 and 12.5.870

355 Additions 20 Removals

Relativity.Processing.Services.Interfaces.V1.DTOs

public class CountOperationRequest
public class DefaultProcessingDataSourceOptionsResponse
public class DiscoveredFileSelection
public class FileData
public class GetProcessedFilesToDeleteResponse
public class HealthCheckOperationRequest
public class ProcessingDocumentErrorHistoryResponse
public class ProcessingDocumentErrorInfo
public class ProcessingOcrLanguage
public class TimedOperationRequest

Relativity.Processing.Services.Interfaces.V2.DTOs

public enum AdvancedOptionsFlag
- EnableMDSKepler = 1
- None = 0
public class ProcessingLogicalIdResults
- public string FilterUuid { get; set; }
- public List<string> Results { get; set; }
- public int TotalCount { get; set; }
- public ProcessingLogicalIdResults()
public class ProcessingStorageItem
- public Guid DocumentUuid { get; set; }
- public bool HasDiscoverError { get; set; }
- public ICollection<string> LogicalIds { get; set; }
- public long Size { get; set; }
- public string StoredAs { get; set; }
- public ProcessingStorageItem()

Relativity.Processing.V1.Services

public interface IFieldMappingManager : IDisposable
- Task<bool> ValidateFieldObjectsAsync(int workspaceID, ExternalMapping model, MappableSourceField sourceField)
public interface IFileDeletionManager : IDisposable
- Task<GetProcessedFilesToDeleteResponse> ProcessFilesToDeleteAsync(int fileRequestSize)
- Task<GetProcessedFilesToDeleteResponse> ProcessFilesToDeleteAsync(int fileRequestSize)
public interface IProcessingDataSourceManager : IDisposable
- Task<DefaultProcessingDataSourceOptionsResponse> RetrieveDefaultsFromProcessingProfile(int workspaceID, int profileId)
- Task<DefaultProcessingDataSourceOptionsResponse> RetrieveDefaultsFromProcessingProfile(int workspaceID, int profileId)
public interface IProcessingDocumentManager : IDisposable
public interface IProcessingFilterManager : IDisposable

Relativity.Processing.V1.Services.Interfaces.DTOs

public class CancelJob : ProcessingJob
public class CountOperationRequest
- public string Message { get; set; }
- public string MetricName { get; set; }
- public int UserID { get; set; }
- public int WorkspaceID { get; set; }
- public CountOperationRequest()
public class DiscoveryJob : ProcessingJob
public class DefaultProcessingDataSourceOptionsResponse
- public int DefaultDestinationFolder { get; set; }
- public int? DefaultStartNumber { get; set; }
- public string DocumentNumberingPrefix { get; set; }
- public Guid NumberingType { get; set; }
- public List<string> OcrLanguages { get; set; }
- public int TimeZone { get; set; }
- public DefaultProcessingDataSourceOptionsResponse()
public class DiscoveredFileSelection
- public string Expression { get; set; }
- public long[] FileIds { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public DiscoveredFileSelection()
public class FileData
- public string FilePath { get; set; }
- public int FolderDepth { get; set; }
- public FileData()
public class GetDiscoveredDocumentListRequest
- public string Culture { get; set; }
- public bool IncludeDuplicateHash { get; set; }
public class GetDiscoveredDocumentsRequest
- public bool IncludeDuplicateHash { get; set; }
public class GetDiscoveredDocumentsWithPivotOnResponse
- public string GroupByArtifactId { get; set; }
- public string PivotOnArtifactId { get; set; }
public class InventoryJob : ProcessingJob
public class GetProcessedFilesToDeleteResponse
- public IReadOnlyCollection<FileData> Files { get; set; }
- public Guid RequestGuid { get; set; }
- public int WorkspaceId { get; set; }
- public GetProcessedFilesToDeleteResponse()
public class HealthCheckOperationRequest
- public Dictionary<string, object> customData { get; set; }
- public Exception Exception { get; set; }
- public bool IsHealthy { get; set; }
- public string Message { get; set; }
- public string MetricName { get; set; }
- public int WorkspaceID { get; set; }
- public HealthCheckOperationRequest()
public class MassReplaceQueueRequest
- public string AgentName { get; set; }
- public string MatchedIDs { get; set; }
- public string UserEmails { get; set; }
- public int WorkspaceID { get; set; }
- public string ZipPath { get; set; }
- public MassReplaceQueueRequest()
public class ProcessingDocumentErrorHistoryResponse
- public List<ProcessingDocumentErrorInfo> DocumentErrorHistory { get; set; }
- public int TotalCount { get; set; }
- public ProcessingDocumentErrorHistoryResponse()
public class ProcessingDocumentErrorInfo
- public string Category { get; set; }
- public string ErrorMessage { get; set; }
- public string ErrorPhase { get; set; }
- public string RetryStatus { get; set; }
- public DateTime TimeStamp { get; set; }
- public ProcessingDocumentErrorInfo()
public class ProcessingFilterResult
- public string LogicalId { get; set; }
- public string ParentLogicalId { get; set; }
- public string ProcessingDupeHash { get; set; }
public class ProcessingJob
public class ProcessingOcrLanguage
- public string DisplayName { get; set; }
- public OcrLanguage LanguageEnum { get; set; }
- public Guid LanguageGuid { get; set; }
- public int NuanceId { get; set; }
- public ProcessingOcrLanguage(Guid languageGuid, string displayName, int nuanceId, OcrLanguage languageEnum)
- public static List<ProcessingOcrLanguage> GetAll()
public class ProcessingRetryDeleteDocumentRequest
- public string Expression { get; set; }
- public long[] ProcessingFileIds { get; set; }
- public int WorkspaceArtifactId { get; set; }
- public ProcessingRetryDeleteDocumentRequest()
public enum Property
- LogicalId = 41
- ParentLogicalId = 43
- ProcessingDupeHash = 42
public class PublishJob : ProcessingJob
public class TimedOperationRequest
- public string Message { get; set; }
- public string MetricName { get; set; }
- public double MillisecondsElapsed { get; set; }
- public int UserID { get; set; }
- public int WorkspaceID { get; set; }
- public TimedOperationRequest()
public class WorkspaceStatistics

Relativity.Processing.V2.Services

public interface IProcessingDocumentManager : IDisposable
- Task<ProcessingDocumentErrorHistoryResponse> GetDocumentErrorHistoryAsync(int workspaceID, string logicalID, int skip, int top)
- Task<ProcessingMetadataResponse> GetDocumentMetadataAsync(int workspaceID, string logicalID)
- Task<PublishJobErrorInfoResponse> GetPublishJobErrorsAsync(int workspaceID, ProcessingDocumentsRequest documentsRequest)
- Task PublishDocumentsAsync(int workspaceID, ProcessingDocumentsRequest documentsRequest)
- Task<long> RetrievePublishableDocumentCountAsync(int workspaceID, ProcessingDocumentsRequest documentsRequest)
- Task RetryDeleteDocumentAsync(int workspaceID, ProcessingDocumentsRequest documentsRequest)
- Task RetryDocumentErrorsAsync(int workspaceID, ProcessingDocumentsRequest documentsRequest)
public interface IProcessingFilterManager : IDisposable
- Task<long> ApplyFilterAsync(int workspaceID, long filterID, ApplyProcessingFilterRequest request)
- Task<ProcessingFilter> CreateExpressionFilterAsync(int workspaceID, CreateProcessingExpressionFilterRequest request)
- Task DeleteFilterAsync(int workspaceID, long filterID)
- Task<IKeplerStream> DownloadDiscoveredDocumentListAsync(int workspaceID, GetDiscoveredDocumentListRequest request)
- Task<ProcessingLogicalIdResults> GetDiscoveredDocumentIdsAsync(int workspaceID, GetDiscoveredDocumentsRequest request)
- Task<ProcessingFilterData> GetDiscoveredDocumentsAsync(int workspaceID, GetDiscoveredDocumentsRequest request)
- Task<ProcessingFilterData> GetFilterResultAsync(int workspaceID, long filterID, int skip, int top)
- Task<List<ProcessingFilter>> GetFiltersAsync(int workspaceID)
- Task<List<ProcessingFilter>> GetFiltersByDataSourceAsync(int workspaceID, int dataSourceID)
- Task<List<GetDiscoveredDocumentsWithPivotOnResponse>> PivotOnDiscoveredDocumentsAsync(int workspaceID, GetDiscoveredDocumentsWithPivotOnRequest request)
- Task<ProcessingFilter> UpdateExpressionFilterAsync(int workspaceID, long filterID, UpdateProcessingExpressionFilterRequest request)

Relativity.Processing.V2.Services.Interfaces.DTOs

public class ExportColumn
- public string Header { get; set; }
- public Property Property { get; set; }
- public ExportColumn()
public class GetDiscoveredDocumentListRequest
- public AdvancedOptionsFlag? AdvancedOptionsFlag { get; set; }
- public List<ExportColumn> Columns { get; set; }
- public string Culture { get; set; }
- public string Expression { get; set; }
- public bool IncludeDuplicateHash { get; set; }
- public List<string> LogicalIDs { get; set; }
- public List<SortOption> SortingOptions { get; set; }
- public GetDiscoveredDocumentListRequest()
public class GetDiscoveredDocumentsRequest
- public AdvancedOptionsFlag? AdvancedOptionsFlag { get; set; }
- public int AuditedSourceID { get; set; }
- public bool ExcludeTotalCount { get; set; }
- public string Expression { get; set; }
- public bool IncludeDuplicateHash { get; set; }
- public int NumberOfResults { get; set; }
- public List<SortOption> SortingOptions { get; set; }
- public int StartingPointOfResult { get; set; }
- public GetDiscoveredDocumentsRequest()
public class GetDiscoveredDocumentsWithPivotOnRequest
- public AdvancedOptionsFlag? AdvancedOptionsFlag { get; set; }
- public string Expression { get; set; }
- public PivotOnOption PivotOnOption { get; set; }
- public GetDiscoveredDocumentsWithPivotOnRequest()
public class GetDiscoveredDocumentsWithPivotOnResponse
- public string GroupByArtifactId { get; set; }
- public string GroupByIdentifier { get; set; }
- public string PivotOnArtifactId { get; set; }
- public string PivotOnIdentifier { get; set; }
- public int ResultCount { get; set; }
- public GetDiscoveredDocumentsWithPivotOnResponse()
public interface IProcessingFilterExpressionModel
- string Type { get; }
public enum Ordering
- Ascending = 1
- Descending = 0
public class PivotOnOption
- public int GroupByCount { get; set; }
- public Property GroupByProperty { get; set; }
- public int PivotOnCount { get; set; }
- public Property? PivotOnProperty { get; set; }
- public PivotOnOption()
public class ProcessingDocumentErrorHistoryResponse
- public List<ProcessingDocumentErrorInfo> DocumentErrorHistory { get; set; }
- public int TotalCount { get; set; }
- public ProcessingDocumentErrorHistoryResponse()
public class ProcessingDocumentErrorInfo
- public string Category { get; set; }
- public string ErrorMessage { get; set; }
- public string ErrorPhase { get; set; }
- public string RetryStatus { get; set; }
- public DateTime TimeStamp { get; set; }
- public ProcessingDocumentErrorInfo()
public class ProcessingDocumentsRequest
- public string Expression { get; set; }
- public List<string> LogicalIds { get; set; }
- public ProcessingDocumentsRequest()
public class ProcessingFileOperationRequest
- public AdvancedOptionsFlag? AdvancedOptionsFlag { get; set; }
- public string Expression { get; set; }
- public List<string> LogicalIds { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public ProcessingFileOperationRequest()
public class ProcessingFilterCompositeExpression : IProcessingFilterExpressionModel
- public IProcessingFilterExpressionModel[] Expressions { get; set; }
- public ProcessingFilterOperator Operator { get; set; }
- public string Type { get; }
- public ProcessingFilterCompositeExpression()
public class ProcessingFilterConditionalExpression : IProcessingFilterExpressionModel
- public ProcessingFilterConstraint Constraint { get; set; }
- public Property Property { get; set; }
- public string Type { get; }
- public string Value { get; set; }
- public ProcessingFilterConditionalExpression()
public enum ProcessingFilterConstraint
- BeginsWith = 12
- Between = 20
- DoesNotBeginWith = 13
- DoesNotEndWith = 15
- EndsWith = 14
- Is = 0
- IsAfter = 18
- IsAfterOrOn = 19
- IsBefore = 16
- IsBeforeOrOn = 17
- IsGreaterThan = 8
- IsGreaterThanOrEqualTo = 9
- IsIn = 2
- IsLessThan = 6
- IsLessThanOrEqualTo = 7
- IsLike = 10
- IsNot = 1
- IsNotIn = 3
- IsNotLike = 11
- IsNotSet = 5
- IsSet = 4
- NotBetween = 21
public class ProcessingFilterData
- public List<ProcessingFilterResult> Results { get; set; }
- public int TotalCount { get; set; }
- public string Uuid { get; set; }
- public ProcessingFilterData()
public class ProcessingFilterEmptyExpression : IProcessingFilterExpressionModel
- public string Type { get; }
- public ProcessingFilterEmptyExpression()
public enum ProcessingFilterOperator
- And = 0
- Or = 1
public class ProcessingFilterResult
- public string ContainerExtension { get; set; }
- public long ContainerID { get; set; }
- public string ContainerName { get; set; }
- public int CustodianArtifactId { get; set; }
- public string CustodianName { get; set; }
- public int DataSourceArtifactId { get; set; }
- public string DataSourceName { get; set; }
- public string DedupeStatus { get; set; }
- public long DiscoverGroupId { get; set; }
- public string DocumentUuid { get; set; }
- public string ErrorCategory { get; set; }
- public string ErrorMessage { get; set; }
- public string ErrorPhase { get; set; }
- public string ErrorStatus { get; set; }
- public string ExtractedTextLocation { get; set; }
- public string FileExtension { get; set; }
- public string FileName { get; set; }
- public long FileSize { get; set; }
- public string FileType { get; set; }
- public string FolderPath { get; set; }
- public string ImportSource { get; set; }
- public bool IsContainer { get; set; }
- public bool IsDeleted { get; set; }
- public bool IsEmbedded { get; set; }
- public bool IsPublished { get; set; }
- public string LogicalId { get; set; }
- public string LogicalPath { get; set; }
- public string MD5Hash { get; set; }
- public bool OfficeEmbeddedItems { get; set; }
- public string OriginalPath { get; set; }
- public long ParentId { get; set; }
- public string ParentLogicalId { get; set; }
- public string ProcessingDupeHash { get; set; }
- public long ProcessingFileId { get; set; }
- public string SenderDomain { get; set; }
- public string Severity { get; set; }
- public string SHA1Hash { get; set; }
- public string SHA256Hash { get; set; }
- public DateTime? SortDate { get; set; }
- public string SourceId { get; set; }
- public string StorageId { get; set; }
- public string TextExtractionMethod { get; set; }
- public string UniqueId { get; set; }
- public bool Unprocessable { get; set; }
- public string VirtualPath { get; set; }
- public ProcessingFilterResult()
public class ProcessingMetadataResponse
- public List<string> Errors { get; set; }
- public string LogicalID { get; set; }
- public string MetadataJson { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public ProcessingMetadataResponse()
public class ProcessingMultipleFileDownload
- public long Count { get; set; }
- public Guid Id { get; set; }
- public string Message { get; set; }
- public ProcessingFileOperationRequest Request { get; set; }
- public long TotalFileCount { get; set; }
- public long TotalSize { get; set; }
- public ProcessingMultipleFileDownload()
public enum Property
- ContainerExtension = 6
- ContainerID = 0
- ContainerName = 5
- CustodianArtifactId = 27
- CustodianName = 29
- DataSourceArtifactId = 28
- DataSourceName = 30
- DedupeStatus = 39
- DiscoverGroupId = 4
- DocumentErrorMessage = 16
- DocumentUuid = 43
- ErrorCategory = 35
- ErrorMessage = 34
- ErrorPhase = 36
- ErrorStatus = 37
- ExtractedTextLocation = 8
- FileExtension = 10
- FileName = 9
- FileSize = 2
- FileType = 11
- FolderPath = 12
- ImportSource = 13
- IngestionError = 7
- IsContainer = 22
- IsDeleted = 33
- IsEmbedded = 23
- IsPublished = 26
- JobId = 38
- LogicalId = 47
- LogicalPath = 14
- MD5Hash = 15
- OfficeEmbeddedItems = 24
- OriginalPath = 17
- ParentFileId = 3
- ParentId = 44
- ParentLogicalId = 48
- ProcessingFileId = 1
- RootId = 45
- SenderDomain = 31
- Severity = 41
- SHA1Hash = 18
- SHA256Hash = 19
- SortDate = 32
- SourceId = 42
- StorageId = 40
- TextExtractionMethod = 20
- UniqueId = 46
- Unprocessable = 25
- VirtualPath = 21
public class PublishJobErrorInfoResponse
- public List<int> ErrorArtifactIds { get; set; }
- public long ErroredJobCount { get; set; }
- public long GroupIdsCheckedCount { get; set; }
- public List<long> GroupIdsWithJobErrors { get; set; }
- public PublishJobErrorInfoResponse()
public class SortOption
- public Ordering Order { get; set; }
- public Property Property { get; set; }
- public SortOption()