Relativity.ObjectManager 9.7.160.4 - API Reference

<PackageReference Include="Relativity.ObjectManager" Version="9.7.160.4" />

API Differences between 9.7.160.4 and 9.6.53.73

201 Additions 6 Removals

Relativity.Services

public enum TextConditionEnum
- IsGreaterThanOrEqualTo = 11
- IsLessThanOrEqualTo = 10

Relativity.Services.DataContracts.DTOs.ItemListView

public class WorkspaceTabListPageUrl
- public bool CanRedirectToListPage { get; set; }
- public string Url { get; set; }
- public WorkspaceTabListPageUrl()

Relativity.Services.DataContracts.DTOs.Results

public class ExportInitializationResults
- public List<FieldMetadata> FieldData { get; set; }
- public long RecordCount { get; set; }
- public Guid RunID { get; set; }
- public ExportInitializationResults()

Relativity.Services.DataContracts.ImportExport

public class RetrieveResultsBlockSettings
- public int MaximumNumberOfCharactersForLongText { get; set; }
- public int NumberOfRecordsToRetrieve { get; set; }
- public RetrieveResultsBlockSettings()

Relativity.Services.Exceptions

public class SearchProviderInvalidSyntaxException : ServiceException
- public SearchProviderInvalidSyntaxException()
- public SearchProviderInvalidSyntaxException(string message)
- public SearchProviderInvalidSyntaxException(string message, Exception innerException)

Relativity.Services.Objects

public interface IObjectManager : IDisposable
- Task<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest)
- Task<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest, CancellationToken cancel)
- Task<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest, IProgress<MassOperationsStateProgress> progress)
- Task<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, CancellationToken cancel)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<ExportInitializationResults> InitializeExportAsync(int workspaceID, QueryRequest queryRequest, int start)
- Task<ExportInitializationResults> InitializeExportAsync(int workspaceID, QueryRequest queryRequest, Guid requestKey, int start)
- Task<RelativityObjectSlim[]> RetrieveNextResultsBlockFromExportAsync(int workspaceID, Guid runID, int batchSize)
- Task<IKeplerStream> StreamLongTextAsync(int workspaceID, RelativityObjectRef exportObject, FieldRef longTextField)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)

Relativity.Services.Objects.DataContracts

public interface IHasArtifactID : IHasIdentifyingInformation
- int ArtifactID { get; set; }
public interface IHasArtifactTypeID : IHasIdentifyingInformation
- int ArtifactTypeID { get; set; }
public interface IHasGuid : IHasIdentifyingInformation
- Guid? Guid { get; set; }
public interface IHasGuids : IHasIdentifyingInformation
- List<Guid> Guids { get; set; }
public interface IHasIdentifyingInformation
public interface IHasName : IHasIdentifyingInformation
- string Name { get; set; }
public interface IHasObjectIdentificationCriteria
- ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
public interface IHasViewFieldID : IHasIdentifyingInformation
- int ViewFieldID { get; set; }
public interface IObjectType : IHasArtifactID, IHasIdentifyingInformation, IHasName, IHasArtifactTypeID
public interface IRelativityObject
- FieldValuePair this[int artifactId] { get; }
- bool FieldValuePairExists(int artifactId)
public class MassCreateRequest
- public IReadOnlyList<FieldRef> Fields { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public RelativityObjectRef ParentObject { get; set; }
- public IReadOnlyList<IReadOnlyList<object>> ValueLists { get; set; }
- public MassCreateRequest()
public class MassCreateResult
- public string Message { get; set; }
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public bool Success { get; set; }
- public MassCreateResult()
public class MassDeleteByCriteriaRequest : IHasObjectIdentificationCriteria
- public ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
- public MassDeleteByCriteriaRequest()
public class MassDeleteByObjectIdentifiersRequest
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public MassDeleteByObjectIdentifiersRequest()
public class MassDeleteResult
- public string Message { get; set; }
- public DeleteReport Report { get; set; }
- public bool Success { get; set; }
- public MassDeleteResult()
public class MassOperationsStateProgress
- public double PercentageComplete { get; set; }
- public MassOperationsStateProgress()
public class MassUpdateByCriteriaRequest : IHasObjectIdentificationCriteria
- public IEnumerable<FieldRefValuePair> FieldValues { get; set; }
- public ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
- public MassUpdateByCriteriaRequest()
public class MassUpdateByObjectIdentifiersRequest
- public IEnumerable<FieldRefValuePair> FieldValues { get; set; }
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public MassUpdateByObjectIdentifiersRequest()
public class MassUpdateOptions
- public FieldUpdateBehavior UpdateBehavior { get; set; }
- public MassUpdateOptions()
public class MassUpdatePerObjectsRequest
- public IReadOnlyList<FieldRef> Fields { get; set; }
- public IReadOnlyList<ObjectRefValuesPair> ObjectValues { get; set; }
- public MassUpdatePerObjectsRequest()
public class MassUpdateResult
- public string Message { get; set; }
- public bool Success { get; set; }
- public int TotalObjectsUpdated { get; set; }
- public MassUpdateResult()
public class ObjectIdentificationCriteria
- public string Condition { get; set; }
- public int? ExecutingSavedSearchID { get; set; }
- public int? ExecutingViewID { get; set; }
- public bool IsAdhocQuery { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public string QueryHint { get; set; }
- public FieldRef RelationalField { get; set; }
- public string RowCondition { get; set; }
- public SearchProviderCondition SearchProviderCondition { get; set; }
- public ObjectIdentificationCriteria()
public class ObjectRefValuesPair
- public RelativityObjectRef Object { get; set; }
- public IReadOnlyList<object> Values { get; set; }
- public ObjectRefValuesPair()

Relativity.Services.Objects.Exceptions

public class ArtifactNotFoundException : ValidationException
- public ArtifactNotFoundException()
- public ArtifactNotFoundException(string message)
- public ArtifactNotFoundException(string message, Exception innerException)
- public ArtifactNotFoundException(SerializationInfo info, StreamingContext context)
public class DuplicateArtifactException : ValidationException
- public DuplicateArtifactException()
- public DuplicateArtifactException(string message)
- public DuplicateArtifactException(string message, Exception innerException)
- public DuplicateArtifactException(SerializationInfo info, StreamingContext context)
public class InsufficientArgumentException : ValidationException
- public InsufficientArgumentException()
- public InsufficientArgumentException(string message)
- public InsufficientArgumentException(string message, Exception innerException)
- public InsufficientArgumentException(SerializationInfo info, StreamingContext context)
public class InvalidObjectTypeException : ValidationException
- public InvalidObjectTypeException()
- public InvalidObjectTypeException(string message)
- public InvalidObjectTypeException(string message, Exception innerException)
- public InvalidObjectTypeException(SerializationInfo info, StreamingContext context)
public class InvalidValueTypeException : ValidationException
- public InvalidValueTypeException()
- public InvalidValueTypeException(string message)
- public InvalidValueTypeException(string message, Exception innerException)
- public InvalidValueTypeException(SerializationInfo info, StreamingContext context)
public class MissingArgumentException : ValidationException
- public MissingArgumentException()
- public MissingArgumentException(string message)
- public MissingArgumentException(string message, Exception innerException)
- public MissingArgumentException(SerializationInfo info, StreamingContext context)
public class PermissionDeniedException : ValidationException
- public PermissionDeniedException()
- public PermissionDeniedException(string message)
- public PermissionDeniedException(string message, Exception innerException)
- public PermissionDeniedException(SerializationInfo info, StreamingContext context)
public class UnsupportedFieldTypeException : ValidationException
- public UnsupportedFieldTypeException()
- public UnsupportedFieldTypeException(string message)
- public UnsupportedFieldTypeException(string message, Exception innerException)
- public UnsupportedFieldTypeException(SerializationInfo info, StreamingContext context)
public class UnsupportedObjectTypeException : ValidationException
- public UnsupportedObjectTypeException()
- public UnsupportedObjectTypeException(string message)
- public UnsupportedObjectTypeException(string message, Exception innerException)
- public UnsupportedObjectTypeException(SerializationInfo info, StreamingContext context)

Relativity.Services.Objects.Extensions

public static class ExpandoObjectExtensions
- public static string FixCaseForKey(this ExpandoObject expando, string key)
- public static T GetPropertyWithKey<T>(this ExpandoObject expando, string key, T defaultValue = null)
public static class GuidListExtensions
- public static Guid? GetOptionalGuid(this IEnumerable<Guid> guids)
public static class IObjectTypeExtensions
- public static Guid GetGuid(this IObjectType objectType)
- public static bool IsIdentifiedByGuid(this IObjectType objectType)

Relativity.Services.Objects.Helpers

public class ChoiceRefHelper : IChoiceRefHelper
public class RelativityObjectRefHelper : IRelativityObjectRefHelper
public class UserRefHelper : IUserRefHelper

Relativity.Services.Review.DynamicReviewQueue

public class DynamicReviewQueuesView
- public string DocumentIdColumnName { get; set; }
- public string Name { get; set; }
- public string Schema { get; set; }
- public DynamicReviewQueuesView()

Relativity.Services.Search

public enum CriteriaConditionEnum
- EndsWith = 15
- StartsWith = 14
public interface IKeywordSearchManager : IDisposable
- Task<SearchAccessStatus> GetAccessStatusAsync(int workspaceArtifactID, int artifactID)

Relativity.Services.Serialization.Foundation

public interface IChoiceRefHelper
public interface IRelativityObjectRefHelper
public interface IUserRefHelper

Relativity.Services.User

public interface IUserManager : IDisposable
- Task<WorkspaceUserData> RetrieveAllActiveAsync(int workspaceId, bool includeCurrentUser)
- Task<WorkspaceUserData> RetrieveAllWithRelativityAccessAsync(int workspaceId)