Relativity.API 17.0.4

API Differences between 17.0.4 and 10.0.161.8

212 Additions 2 Removals

Relativity.API

public interface IDBContext
- Task BeginTransactionAsync(CancellationToken cancelToken)
- Task ExecuteBulkCopyAsync(IDataReader source, ISqlBulkCopyParameters parameters, CancellationToken cancelToken)
- Task<DataTable> ExecuteDataTableAsync(IQuery query)
- Task<IEnumerable<T>> ExecuteEnumerableAsync<T>(IQuery query, Func<IDataRecord, CancellationToken, Task<T>> converter)
- Task<int> ExecuteNonQueryAsync(IQuery query)
- Task<T> ExecuteObjectAsync<T>(IQuery query, Func<IDataReader, CancellationToken, Task<T>> converter)
- Task<IDataReader> ExecuteReaderAsync(IQuery query)
- Task<T> ExecuteScalarAsync<T>(IQuery query)
- Task<IDbConnection> GetConnectionAsync(CancellationToken cancelToken)

Relativity.API.Context

public class ContextQuery : IQuery
- public CancellationToken CancellationToken { get; set; }
- public bool ExecuteAsStoredProcedure { get; set; }
- public int? ExecutionTimeout { get; set; }
- public IEnumerable<IDataParameter> Parameters { get; set; }
- public string SqlStatement { get; set; }
- public ContextQuery()
public interface IQuery
- CancellationToken CancellationToken { get; }
- bool ExecuteAsStoredProcedure { get; }
- int? ExecutionTimeout { get; }
- IEnumerable<IDataParameter> Parameters { get; }
- string SqlStatement { get; }

Relativity.API.Foundation

public enum AuditAction
- Update_Mass_Revert = 59
- Update_Revert = 58
public class ContextOptions : IContextOptions
- public string OnBehalfOfToken { get; set; }
- public ContextOptions()
public class ExportStatistics
- public enum ImageFileExportType
- public enum ImageLoadFileFormatType
- public enum ImagesToExportType
- public enum LoadFileFormat
- public bool AppendOriginalFilenames { get; set; }
- public int ArtifactTypeID { get; set; }
- public char Bound { get; set; }
- public bool CopyFilesFromRepository { get; set; }
- public int DataSourceArtifactID { get; set; }
- public char Delimiter { get; set; }
- public string DestinationFilesystemFolder { get; set; }
- public int DocumentExportCount { get; set; }
- public int ErrorCount { get; set; }
- public int ExportedTextFieldID { get; set; }
- public int ExportedTextFileEncodingCodePage { get; set; }
- public bool ExportImages { get; set; }
- public bool ExportMultipleChoiceFieldsAsNested { get; set; }
- public bool ExportNativeFiles { get; set; }
- public bool ExportTextFieldAsFiles { get; set; }
- public int[] Fields { get; set; }
- public int FileExportCount { get; set; }
- public string FilePathSettings { get; set; }
- public ImageFileExportType ImageFileType { get; set; }
- public ImageLoadFileFormatType ImageLoadFileFormat { get; set; }
- public ImagesToExportType ImagesToExport { get; set; }
- public int MetadataLoadFileEncodingCodePage { get; set; }
- public LoadFileFormat MetadataLoadFileFormat { get; set; }
- public char MultiValueDelimiter { get; set; }
- public char NestedValueDelimiter { get; set; }
- public char NewlineProxy { get; set; }
- public bool OverwriteFiles { get; set; }
- public int[] ProductionPrecedence { get; set; }
- public int RunTimeInMilliseconds { get; set; }
- public int SourceRootFolderID { get; set; }
- public int StartExportAtDocumentNumber { get; set; }
- public string SubdirectoryImagePrefix { get; set; }
- public long SubdirectoryMaxFileCount { get; set; }
- public string SubdirectoryNativePrefix { get; set; }
- public long SubdirectoryStartNumber { get; set; }
- public string SubdirectoryTextPrefix { get; set; }
- public int TextAndNativeFilesNamedAfterFieldID { get; set; }
- public long TotalFileBytesExported { get; set; }
- public long TotalMetadataBytesExported { get; set; }
- public string Type { get; set; }
- public long VolumeMaxSize { get; set; }
- public string VolumePrefix { get; set; }
- public int VolumeStartNumber { get; set; }
- public int WarningCount { get; set; }
- public ExportStatistics()
public interface ICascadeDeleteAgentObjectTypeRef : IObjectTypeRef, IArtifactRef
- bool ForceDelete { get; }
public interface ICascadeDeleteDocumentObjectTypeRef : IObjectTypeRef, IArtifactRef
- DocumentDeleteOptions DocumentDeleteOptions { get; }
- bool ForceDelete { get; }
public interface IContextOptions
- string OnBehalfOfToken { get; set; }
public interface IResourceFileEventHandlerRef
- Guid EventHandlerGuid { get; }
public interface ISearchProviderRef : IArtifactRef
- bool HasRank { get; set; }

Relativity.API.Foundation.MassOperations

public enum DocumentDeleteOptions
- DeleteDocumentAndAllAssociatedFiles = 0
- DeleteOnlyImages = 1
- DeleteOnlyNatives = 2
- DeleteOnlyNativesAndImages = 3
public enum ExportToFileOptions
- Csv = 0
- Dat = 1
- Xls = 2
public interface ICascadeDeleteBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICascadeDeleteParameters>, IMassOperationBuilder, IContextualInformation
public interface ICascadeDeleteParameters
- int? BatchSize { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface ICopyBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICopyParameters>, IMassOperationBuilder, IContextualInformation
public interface ICopyParameters
- int? BatchSize { get; set; }
- IObjectTypeRef ObjectType { get; }
- IArtifactRef ParentArtifact { get; }
- Guid? ProcessIdentifier { get; }
public interface ICustomBuilder : IMassOperationBuilderWithParameters<ICustomMassOperation, int, ICustomParameters>, IMassOperationBuilder, IContextualInformation
public interface ICustomMassOperation : IMassOperation
- IEnumerable<ICustomValidationResponse> ValidateLayout()
- IEnumerable<ICustomValidationResponse> ValidateSelection()
public interface ICustomParameters
- int? BatchSize { get; }
- IMassOperationRef CustomMassOperation { get; }
- IEnumerable<IField> Fields { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface ICustomValidationResponse
- string Message { get; }
- ValidationResponseSeverity Severity { get; }
public interface IDeleteParameters
- int? BatchSize { get; set; }
public interface IEditBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IEditParameters>, IMassOperationBuilder, IContextualInformation
public interface IEditParameters
- int? BatchSize { get; set; }
- IEnumerable<IField> Fields { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface IExportToFileBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IExportToFileParameters>, IMassOperationBuilder, IContextualInformation
public interface IExportToFileParameters
- Encoding Encoding { get; }
- bool EscapeFormulas { get; }
- Stream ExportResults { get; }
- IEnumerable<IFieldRef> Fields { get; }
- ExportToFileOptions FileOptions { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
- ISearchProviderRef SearchProvider { get; }
- IArtifactRef View { get; }
public interface IMassOperationRef
- IArtifactRef MassOperationArtifact { get; }
- IResourceFileEventHandlerRef ResourceFileMassOperation { get; }
public interface IMoveBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IMoveParameters>, IMassOperationBuilder, IContextualInformation
public interface IMoveParameters
- int? BatchSize { get; }
- IArtifactRef DestinationFolder { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface IReplaceAction
- IFieldRef FieldToReplaceWith { get; }
- ReplaceWithOptions ReplaceWithOptions { get; }
- string TextToReplaceWith { get; }
public interface IReplaceBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IReplaceParameters>, IMassOperationBuilder, IContextualInformation
public interface IReplaceFieldRef
- IFieldRef FieldToReplace { get; }
- IReplaceAction ReplaceAction { get; }
- IReplaceOptions ReplaceOptions { get; }
public interface IReplaceOptions
- ReplaceActionOptions ReplaceActionOptions { get; }
- string ReplaceActionValue { get; }
public interface IReplaceParameters
- int? BatchSize { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
- IEnumerable<IReplaceFieldRef> ReplaceFields { get; }
public interface ISaveAsListBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ISaveAsListBuilder>, IMassOperationBuilder, IContextualInformation
public interface ISaveAsListOptions
- IArtifactRef ExistingListArtifactId { get; }
- string ListName { get; }
- SaveAsListAction SaveAsListAction { get; }
public interface ISaveAsListParameters
- int? BatchSize { get; }
- string Notes { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
- ISaveAsListOptions SaveAsListOptions { get; }
public interface ITallySumAverageBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ITallySumAverageParameters>, IMassOperationBuilder, IContextualInformation
public interface ITallySumAverageParameters
- IFieldRef Field { get; }
- IObjectTypeRef ObjectType { get; }
- TallySumAverageOptions Operation { get; }
- Guid? ProcessIdentifier { get; }
- DataTable ReportTable { get; }
public enum ReplaceActionOptions
- Append = 1
- FindReplace = 3
- Insert = 2
- ReplaceWhole = 0
public enum ReplaceWithOptions
- Field = 1
- Text = 0
public enum SaveAsListAction
- CreateNewList = 0
- ReplaceExistingList = 1
public enum TallySumAverageOptions
- Average = 2
- Sum = 1
- Tally = 0
public enum ValidationResponseSeverity
- Error = 1
- Warning = 0

Relativity.API.Foundation.Repositories

public interface IAuditRepository : IRepository, IContextualInformation
- Task CreateAuditRecords(IEnumerable<IAuditRecord> auditRecords)
public interface IChoiceRepository : IRepository, IContextualInformation
- IChoice Read(IArtifactRef choiceRef)
public interface IExportAuditRepository : IRepository, IContextualInformation
- bool CreateAuditForExport(ExportStatistics exportStatistics, int contextUserId)
public interface IFieldRepository : IRepository, IContextualInformation
- IEnumerable<IField> RetrieveAllFieldsByArtifactTypeID(int artifactTypeID)
public interface IObjectTypeCacheRepository : IRepository, IContextualInformation
- IObjectType RetrieveObjectTypeByIdentifier(int artifactID)
public interface ISystemArtifactCacheRepository : IRepository, IContextualInformation
- bool ExistsInSystemArtifact(int artifactID)
- int RetrieveArtifactIDByIdentifier(string identifier)
- int RetrieveArtifactIDByIdentifier(SystemArtifact identifier)
public interface ISystemArtifactTypeCacheRepository : IRepository, IContextualInformation
- int RetrieveArtifactIDByIdentifier(SystemArtifact systemArtifact)
- int RetrieveArtifactIDByIdentifier(string systemArtifact)