Relativity.ObjectManager 9.6.26.97

API Differences between 9.6.26.97 and 9.5.104.50

993 Additions 24 Removals

Relativity.Kepler.Logging

public static class Log
- public static ILog Logger { get; set; }
public class OutputWindowLogger : ILog
- public OutputWindowLogger()
- public ILog ForContext(Type source)
- public ILog ForContext(string propertyName, object value, bool destructureObjects)
- public ILog ForContext<T>()
- public IDisposable LogContextPushProperty(string propertyName, object obj)
- public void LogDebug(string messageTemplate, object[] propertyValues)
- public void LogDebug(Exception exception, string messageTemplate, object[] propertyValues)
- public void LogError(string messageTemplate, object[] propertyValues)
- public void LogError(Exception exception, string messageTemplate, object[] propertyValues)
- public void LogFatal(string messageTemplate, object[] propertyValues)
- public void LogFatal(Exception exception, string messageTemplate, object[] propertyValues)
- public void LogInformation(string messageTemplate, object[] propertyValues)
- public void LogInformation(Exception exception, string messageTemplate, object[] propertyValues)
- public void LogVerbose(string messageTemplate, object[] propertyValues)
- public void LogVerbose(Exception exception, string messageTemplate, object[] propertyValues)
- public void LogWarning(string messageTemplate, object[] propertyValues)
- public void LogWarning(Exception exception, string messageTemplate, object[] propertyValues)

Relativity.Services

public interface IArtifact
- int ArtifactID { get; set; }
- DateTime LastModifiedOn { get; set; }
public interface ISortAssociable
- int ArtifactTypeID { get; set; }
- List<Sort> Sorts { get; set; }
public class Query
- public int? ExecutingSavedSearchId { get; set; }
- public string QueryHint { get; set; }
- public string RankSortOrder { get; set; }
public class DeleteProcessStateProgress
- public int OperationsCompleted { get; set; }
- public int TotalOperations { get; set; }
- public DeleteProcessStateProgress()
- public DeleteProcessStateProgress(int totalOperations, int operationsCompleted)

Relativity.Services.Analytics

public class AnalyticsIndex : SearchIndexRef
public class AnalyticsIndexJobParameters
public enum AnalyticsIndexJobType
public class AnalyticsProfileRef
public interface IAnalyticsModule
public interface IIndexManager : IDisposable

Relativity.Services.Batching

public class AutoBatchProgress
- public enum ProgressStatus
- public int? DocumentsToBeBatched { get; set; }
- public string LastReportedError { get; set; }
- public DateTime? LastSuccessfulRun { get; set; }
- public ProgressStatus? Status { get; set; }
- public AutoBatchProgress()
public class AutoBatchSettings
- public int AutoCreateRateInMinutes { get; set; }
- public int MinimumBatchSize { get; set; }
- public AutoBatchSettings()
public class BatchCheckin
- public enum BatchCheckinStatus
- public BatchCheckinStatus CheckinStatus { get; set; }
- public BatchCheckin()
public class BatchCheckout
- public int UserId { get; set; }
- public BatchCheckout()
public class BatchInfo
- public int? AssignedToUserID { get; set; }
- public int BatchID { get; set; }
- public string BatchName { get; set; }
- public BatchStatus BatchSatus { get; set; }
- public bool CanCheckin { get; set; }
- public bool CanCheckoutForOtherUser { get; set; }
- public bool CanCheckoutToSelf { get; set; }
- public bool CanReassignToOtherUser { get; set; }
- public bool CanReassignToSelf { get; set; }
- public bool HasUserCheckedOutOtherBatch { get; set; }
- public BatchInfo()
public class BatchSet : BatchSetRef, IArtifact
- public AutoBatchSettings AutoBatchSettings { get; set; }
- public AutoBatchProgress AutoBatchStatus { get; set; }
- public string BatchPrefix { get; set; }
- public int BatchSize { get; set; }
- public SecurableField BatchUnitField { get; set; }
- public UserRef CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public DataSource DataSource { get; set; }
- public SecurableField FamilyField { get; set; }
- public string Keywords { get; set; }
- public UserRef LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public string Notes { get; set; }
- public SecurableField ReviewedField { get; set; }
- public BatchSet()
public class BatchSetRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public BatchSetRef()
public enum BatchStatus
- Completed = 2
- InProgress = 1
- None = 0
public class DataSource : ISecurableArtifact
- public int ArtifactID { get; set; }
- public bool IsSecured { get; set; }
- public string Name { get; set; }
- public DataSource()
- public void Secure()
public interface ISecurableArtifact
- int ArtifactID { get; set; }
- bool IsSecured { get; set; }
- void Secure()
public class SecurableField : FieldRef, ISecurableArtifact
- public bool IsSecured { get; set; }
- public SecurableField()
- public void Secure()
public class UserToAssign
- public string FullName { get; set; }
- public int UserToAssignArtifactID { get; set; }
- public UserToAssign()

Relativity.Services.DashboardObject

public class Dashboard : DashboardRef
- public int ArtifactID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
public class DashboardRef
- public int ArtifactID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public DashboardRef()
- public DashboardRef(int artifactID)
- public DashboardRef(int artifactID, string name)
- public DashboardRef(List<Guid> guids)
public class DeleteStatus
- public bool CanDelete { get; }
- public bool CanDeleteObjectDependencies { get; }
- public bool HasLinkedObjects { get; }
- public bool HasRestrictedLinkedObjects { get; }
- public IEnumerable<ObjectDependency> LinkedObjects { get; }
- public DeleteStatus(bool canDelete, bool canDeleteObjectDependencies, IEnumerable<ObjectDependency> linkedObjects)

Relativity.Services.DataContracts.DTOs.DynamicReviewQueue

public class DynamicReviewQueueCount
- public Dictionary<int, int> ChoiceCount { get; set; }
- public bool ReviewCompleted { get; set; }
- public string StatusDescription { get; set; }
- public int StatusID { get; set; }
- public int TotalCount { get; set; }
- public DynamicReviewQueueCount()
public class DynamicReviewQueueDocument
- public int? AssignedUserID { get; set; }
- public int? Category { get; set; }
- public int DocumentArtifactID { get; set; }
- public int Order { get; set; }
- public float? Rank { get; set; }
- public DateTime? ReviewedTimestamp { get; set; }
- public int? ReviewSessionID { get; set; }
- public DateTime? ReviewStartedTimestamp { get; set; }
- public int? SelectedChoiceID { get; set; }
- public int Status { get; set; }
- public DynamicReviewQueueDocument()

Relativity.Services.DataContracts.DTOs.EventHandler

public class PageInteractionScriptFile
- public Guid AppGuid { get; set; }
- public string FileName { get; set; }
- public string Version { get; set; }
- public PageInteractionScriptFile()

Relativity.Services.DataContracts.DTOs.ItemListView

public class DynamicReviewQueue
- public int AssociatedViewID { get; set; }
- public bool Enabled { get; set; }
- public int QueueSourceIdentifier { get; set; }
- public DynamicReviewQueue()

Relativity.Services.DataContracts.DTOs.Results

public class DynamicReviewQueueResultSet
- public List<DynamicReviewQueue> DynamicReviewQueues { get; set; }
- public DynamicReviewQueueResultSet()
public class UniqueFieldValuesResult
- public string FieldName { get; set; }
- public bool MaxNumberOfValuesReached { get; set; }
- public List<string> UniqueValues { get; set; }
- public UniqueFieldValuesResult()

Relativity.Services.DataContracts.DTOs.Results.StaticObject

public class BrandingQueueStatus
- public int Id { get; set; }
- public string Name { get; set; }
- public BrandingQueueStatus()
public enum BrandingQueueStatusEnum
- Error = 100
- PendingFinalize = 2
- Processing = 1
- Waiting = 0
public class FailedApplicationInstall
- public int ApplicationInstallID { get; set; }
- public string ApplicationName { get; set; }
- public FailedApplicationInstall()
public class OCRQueueStatus
- public int Id { get; set; }
- public string Name { get; set; }
- public OCRQueueStatus()
public class WorkspaceUpgradeQueueCode
- public object Id { get; set; }
- public string Name { get; set; }
- public WorkspaceUpgradeQueueCode()

Relativity.Services.DataContracts.DTOs.Search

public class SearchContainerTreeFilter
- public int? CreatedById { get; set; }
- public DateTime? CreatedFrom { get; set; }
- public string Keywords { get; set; }
- public int? LastModifiedById { get; set; }
- public DateTime? LastModifiedFrom { get; set; }
- public string Notes { get; set; }
- public int? OwnerId { get; set; }
- public string SearchText { get; set; }
- public SearchContainerTreeFilter()

Relativity.Services.Document

public class File : FileRef
- public int FileID { get; set; }
- public string Filename { get; set; }

Relativity.Services.DocumentPrintData

public interface IDocumentPrintDataManager : IDisposable
- Task<string> GetDocumentPrintDataAsync(string printOptions, int workspaceId)
public interface IDocumentPrintDataModule

Relativity.Services.Exceptions

public class InvalidInputException : ValidationException
- public ValidationError[] Errors { get; set; }
- public InvalidInputException()
- public InvalidInputException(string message)
- public InvalidInputException(string message, Exception innerException)
- protected InvalidInputException(SerializationInfo info, StreamingContext context)
public class SearchProviderInactiveException : ServiceException
- public SearchProviderInactiveException()
- public SearchProviderInactiveException(string message)
- public SearchProviderInactiveException(string message, Exception innerException)
- protected SearchProviderInactiveException(SerializationInfo info, StreamingContext context)
public class SearchProviderPermissionException : ServiceException
- public SearchProviderPermissionException()
- public SearchProviderPermissionException(string message)
- public SearchProviderPermissionException(string message, Exception innerException)
- protected SearchProviderPermissionException(SerializationInfo info, StreamingContext context)
public class ValidationError
- public string ErrorMessage { get; set; }
- public string PropertyName { get; set; }
- public ValidationError()

Relativity.Services.Field

public class MultipleObjectFieldUpdateValue
- public IEnumerable<RelativityObjectRef> Objects { get; set; }
- public IEnumerable<RelativityObjectRef> Objects { get; set; }
public class SecurityFieldRef : FieldRef
- public const string SECURITY_FIELD_NAME = "Security"
- public string Name { get; }
- public SecurityFieldRef()
public class SecurityFieldValue
- public bool OverwriteInheritedSecurity { get; set; }
- public bool UserCanEditSecurity { get; set; }
- public SecurityFieldValue()

Relativity.Services.FieldManager

public interface IFieldManager : IDisposable
- Task<int?> RetrieveArtifactViewFieldIdAsync(int workspaceArtifactId, int fieldArtifactId)
- Task<List<FieldRef>> RetrieveBeginBatesFieldsAsync(int workspaceArtifactId)
- Task<UniqueFieldValuesResult> RetrieveUniqueFieldValuesAsync(int workspaceId, int artifactTypeId, string fieldName)
- Task SetOverlayBehaviorAsync(int workspaceArtifactId, int fieldArtifactId, bool fieldOverlayBehavior)
- Task SetPropagateToAsync(int workspaceArtifactId, int fieldArtifactId, IEnumerable<int> relationalFieldArtifactIDs)
- Task UpdateFilterTypeAsync(int workspaceArtifactId, int artifactViewFieldId, string filterType)
public interface IFieldModule

Relativity.Services.Files

public class FileRef
- public int FileID { get; set; }
- public string Filename { get; set; }
- public FileRef()

Relativity.Services.ItemListView

public class ItemListFieldRef : FieldRef
- public bool IsVisible { get; set; }
- public List<Guid> SourceFieldArtifactGuids { get; set; }
public class PageInteractionScriptFileResultSet
- public List<PageInteractionScriptFile> ScriptFiles { get; set; }
- public PageInteractionScriptFileResultSet()
public class View
- public int AllConditionCount { get; set; }
- public int? DashboardArtifactId { get; set; }
- public int SavedSearchConditionCount { get; set; }

Relativity.Services.JobManager

public class Job : JobSummary
- public string DismissURL { get; set; }
- public string LastError { get; set; }
- public string LastErrorStackTrace { get; set; }
- public JobProgress Progress { get; set; }
- public string RetryURL { get; set; }
- public Job()
public class JobProgress
- public int CompletedTasks { get; set; }
- public int ErrorTasks { get; set; }
- public int InProgressTasks { get; set; }
- public JobProgress()
public class JobQueryResultSet : QueryResultSet<JobSummary>
- public JobQueryResultSet()
public class JobRef
- public int ID { get; set; }
- public JobRef()
public class JobStatus
- public int ID { get; set; }
- public string Name { get; set; }
- public JobStatus()
public class JobSummary : JobRef
- public DateTime? CompletedOn { get; set; }
- public string Description { get; set; }
- public string Name { get; set; }
- public DateTime? StartedOn { get; set; }
- public JobStatus Status { get; set; }
- public UserRef User { get; set; }
- public JobSummary()
public class JobTask : JobTaskSummary
- public string DismissURL { get; set; }
- public string LastError { get; set; }
- public string LastErrorStackTrace { get; set; }
- public string RetryURL { get; set; }
- public JobTask()
public class JobTaskRef
- public int ID { get; set; }
- public JobTaskRef()
public class JobTaskSummary : JobTaskRef
- public DateTime? CompletedOn { get; set; }
- public int JobID { get; set; }
- public DateTime? StartedOn { get; set; }
- public JobStatus Status { get; set; }
- public JobTaskSummary()

Relativity.Services.ObjectQuery

public class Query
- public string QueryHint { get; set; }
- public string RankSortOrder { get; set; }
public class SearchProviderCondition
- public string SortOrder { get; set; }

Relativity.Services.Objects

public interface IObjectManager : IDisposable
- Task<CreateResult> CreateAsync(int workspaceID, CreateRequest request)
- Task<CreateResult> CreateAsync(int workspaceID, CreateRequest request, OperationOptions operationOptions)
- Task<ObjectCreateResult> CreateSingleAsync(int workspaceID, RelativityObject relativityObject, CallingContext callingContext)
- Task<DeleteResult> DeleteAsync(int workspaceID, DeleteRequest request)
- Task<DeleteResult> DeleteAsync(int workspaceID, DeleteRequest request, CancellationToken cancel, IProgress<DeleteProcessStateProgress> progress)
- Task<DeleteResult> DeleteAsync(int workspaceID, DeleteRequest request, CancellationToken cancel)
- Task<DeleteResult> DeleteAsync(int workspaceID, DeleteRequest request, IProgress<DeleteProcessStateProgress> progress)
- Task<ObjectDeleteResult> DeleteSingleAsync(int workspaceID, RelativityObjectRef relativityObjectRef, CallingContext callingContext)
- Task<ObjectDeleteResult> DeleteSingleAsync(int workspaceID, RelativityObjectRef relativityObjectRef, CallingContext callingContext, CancellationToken cancel, IProgress<DeleteProcessStateProgress> progress)
- Task<ObjectQueryResultSet> QueryAsync(int workspaceID, ObjectTypeRef artifactType, Query query, int start, int length)
- Task<QueryResult> QueryAsync(int workspaceID, QueryRequest request, int start, int length)
- Task<ObjectQueryResultSet> QueryAsync(int workspaceID, ObjectTypeRef artifactType, Query query, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResult> QueryAsync(int workspaceID, QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<ObjectQueryResultSet> QueryAsync(int workspaceID, ObjectTypeRef artifactType, Query query, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResult> QueryAsync(int workspaceID, QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QuerySlimAsync(int workspaceID, QueryRequest request, int start, int length)
- Task<QueryResultSlim> QuerySlimAsync(int workspaceID, QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QuerySlimAsync(int workspaceID, QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QuerySlimAsync(int workspaceID, QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<ReadResult> ReadAsync(int workspaceID, ReadRequest request)
- Task<ReadResult> ReadAsync(int workspaceID, ReadRequest request, OperationOptions operationOptions)
- Task<ObjectReadResult> ReadSingleAsync(int workspaceID, int objectID, IEnumerable<FieldRef> fieldRefs, CallingContext callingContext)
- Task<ObjectReadResult> ReadSingleAsync(int workspaceID, Guid objectGuid, IEnumerable<FieldRef> fieldRefs, CallingContext callingContext)
- Task<ObjectUpdateResult> UpdateAsync(int workspaceID, int objectID, RelativityObject relativityObject, CallingContext callingContext)
- Task<UpdateResult> UpdateAsync(int workspaceID, UpdateRequest request)
- Task<UpdateResult> UpdateAsync(int workspaceID, UpdateRequest request, UpdateOptions operationOptions)
public interface IObjectModule

Relativity.Services.Objects.DataContracts

public class CallingContext
- public LayoutRef Layout { get; set; }
- public PageMode PageMode { get; set; }
- public string Referrer { get; set; }
- public CallingContext()
public class Choice
- public int ArtifactID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public Choice()
public class ChoiceRef
- public int ArtifactID { get; set; }
- public Guid? Guid { get; set; }
- public ChoiceRef()
public class CreateRequest
- public IEnumerable<FieldRefValuePair> FieldValues { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public RelativityObjectRef ParentObject { get; set; }
- public CreateRequest()
public class CreateResult
- public List<EventHandlerStatus> EventHandlerStatuses { get; set; }
- public RelativityObject Object { get; set; }
- public CreateResult()
public class DeleteItem
- public string Action { get; set; }
- public string Connection { get; set; }
- public int Count { get; set; }
- public string ObjectTypeName { get; set; }
- public DeleteItem()
public class DeleteProcessStateProgress
- public int OperationsCompleted { get; set; }
- public int TotalOperations { get; set; }
- public DeleteProcessStateProgress()
- public DeleteProcessStateProgress(int totalOperations, int operationsCompleted)
public class DeleteReport
- public List<DeleteItem> DeletedItems { get; set; }
- public DeleteReport()
public class DeleteRequest
- public RelativityObjectRef Object { get; set; }
- public DeleteRequest()
public class DeleteResult
- public DeleteReport Report { get; set; }
- public DeleteResult()
public class EventHandlerStatus
- public string Message { get; set; }
- public bool Success { get; set; }
- public EventHandlerStatus()
public class Field
- public int ArtifactID { get; set; }
- public FieldCategory FieldCategory { get; set; }
- public FieldType FieldType { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public int ViewFieldID { get; set; }
- public Field()
public enum FieldCategory
- AutoCreate = 7
- Batch = 15
- Comments = 4
- FileInfo = 10
- FileSize = 8
- FolderName = 9
- FullText = 1
- Generic = 0
- GenericSystem = 13
- Identifier = 2
- MarkupSetMarker = 12
- MultiReflected = 14
- ParentArtifact = 11
- ProductionMarker = 6
- Reflected = 3
- Relational = 5
public class FieldRef
- public int ArtifactID { get; set; }
- public Guid? Guid { get; set; }
- public string Name { get; set; }
- public int ViewFieldID { get; set; }
- public FieldRef()
public class FieldRefValuePair
- public FieldRef Field { get; set; }
- public object Value { get; set; }
- public FieldRefValuePair()
public enum FieldType
- Currency = 7
- Date = 2
- Decimal = 6
- Empty = -1
- File = 9
- FixedLengthText = 0
- LongText = 4
- MultipleChoice = 8
- MultipleObject = 13
- SingleChoice = 5
- SingleObject = 10
- User = 11
- WholeNumber = 1
- YesNo = 3
public enum FieldUpdateBehavior
- Merge = 1
- Replace = 0
public class FieldValuePair
- public Field Field { get; set; }
- public object Value { get; set; }
- public FieldValuePair()
public class Layout
- public int ArtifactID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public Layout()
public class LayoutRef
- public int ArtifactID { get; set; }
- public Guid? Guid { get; set; }
- public LayoutRef()
public class ObjectType
- public int ArtifactID { get; set; }
- public int ArtifactTypeID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public ObjectType()
public class ObjectTypeRef
- public int ArtifactID { get; set; }
- public int ArtifactTypeID { get; set; }
- public Guid? Guid { get; set; }
- public string Name { get; set; }
- public ObjectTypeRef()
public class OperationOptions
- public CallingContext CallingContext { get; set; }
- public OperationOptions()
public enum PageMode
- Edit = 2
- List = 3
- Unknown = 0
- View = 1
public class QueryRequest
- public int? ActiveArtifactID { get; set; }
- public string Condition { get; set; }
- public bool? ConvertNumberFieldValuesToString { get; set; }
- public int? ExecutingSavedSearchID { get; set; }
- public int? ExecutingViewID { get; set; }
- public IEnumerable<FieldRef> Fields { get; set; }
- public bool? IncludeIDWindow { get; set; }
- public bool? IncludeNameInQueryResult { get; set; }
- public bool? IsAdhocQuery { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public string QueryHint { get; set; }
- public SortEnum RankSortOrder { get; set; }
- public FieldRef RelationalField { get; set; }
- public string RowCondition { get; set; }
- public SampleParameters SampleParameters { get; set; }
- public SearchProviderCondition SearchProviderCondition { get; set; }
- public IEnumerable<Sort> Sorts { get; set; }
- public QueryRequest()
public class QueryResult
- public int CurrentStartIndex { get; set; }
- public List<int> IDWindow { get; set; }
- public List<RelativityObject> Objects { get; set; }
- public ObjectType ObjectType { get; set; }
- public List<double?> RankWindow { get; set; }
- public Field RelationalField { get; set; }
- public int ResultCount { get; set; }
- public SampleDetails SampleDetails { get; set; }
- public int TotalCount { get; set; }
- public QueryResult()
public class QueryResultSlim
- public int CurrentStartIndex { get; set; }
- public List<Field> Fields { get; set; }
- public List<int> IDWindow { get; set; }
- public List<RelativityObjectSlim> Objects { get; set; }
- public ObjectType ObjectType { get; set; }
- public List<double?> RankWindow { get; set; }
- public Field RelationalField { get; set; }
- public int ResultCount { get; set; }
- public SampleDetails SampleDetails { get; set; }
- public int TotalCount { get; set; }
- public QueryResultSlim()
public class ReadRequest
- public IEnumerable<FieldRef> Fields { get; set; }
- public RelativityObjectRef Object { get; set; }
- public ReadRequest()
public class ReadResult
- public string Message { get; set; }
- public RelativityObject Object { get; set; }
- public ObjectType ObjectType { get; set; }
- public ReadResult()
public class RelativityObject
- public int ArtifactID { get; set; }
- public List<FieldValuePair> FieldValues { get; set; }
- public List<Guid> Guids { get; set; }
- public FieldValuePair this[int artifactId] { get; }
- public FieldValuePair this[string fieldName] { get; }
- public FieldValuePair this[Guid guid] { get; }
- public string Name { get; set; }
- public RelativityObjectRef ParentObject { get; set; }
- public RelativityObject()
- public bool FieldValuePairExists(int artifactId)
- public bool FieldValuePairExists(string fieldName)
- public bool FieldValuePairExists(Guid guid)
public class RelativityObjectRef
- public int ArtifactID { get; set; }
- public Guid? Guid { get; set; }
- public RelativityObjectRef()
public class RelativityObjectSlim
- public int ArtifactID { get; set; }
- public List<object> Values { get; set; }
- public RelativityObjectSlim()
public class RelativityObjectValue
- public int ArtifactID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public RelativityObjectValue()
public class SampleDetails
- public int? SampleSize { get; set; }
- public string Token { get; set; }
- public int? UniverseSize { get; set; }
- public SampleDetails()
public class SampleParameters
- public decimal ConfidenceLevel { get; set; }
- public Guid? ExistingToken { get; set; }
- public int FixedSampleSize { get; set; }
- public decimal MarginOfError { get; set; }
- public decimal SamplingPercentage { get; set; }
- public SampleParameters()
public class SearchIndexRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public SearchIndexRef()
public class SearchProviderCondition
- public string Input { get; set; }
- public SearchIndexRef SearchIndex { get; set; }
- public SearchProviderCondition()
public class Security
- public bool OverwriteInheritedSecurity { get; set; }
- public bool UserCanEditSecurity { get; set; }
- public Security()
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 UpdateOptions : OperationOptions
- public FieldUpdateBehavior UpdateBehavior { get; set; }
- public UpdateOptions()
public class UpdateRequest
- public IEnumerable<FieldRefValuePair> FieldValues { get; set; }
- public RelativityObjectRef Object { get; set; }
- public UpdateRequest()
public class UpdateResult
- public List<EventHandlerStatus> EventHandlerStatuses { get; set; }
- public UpdateResult()
public class User
- public int ArtifactID { get; set; }
- public string EmailAddress { get; set; }
- public string Name { get; set; }
- public User()

Relativity.Services.Objects.Exceptions

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

Relativity.Services.Objects.Extensions

public static class ChoiceExtensions
- public static ChoiceRef ToRef(this Choice choice)
public static class FieldExtensions
- public static FieldRef ToRef(this Field field)
public static class LayoutExtensions
- public static LayoutRef ToRef(this Layout layout)
public static class RelativityObjectExtensions
- public static RelativityObjectRef ToRef(this RelativityObject relativityObject)

Relativity.Services.Objects.Helpers

public class ChoiceRefHelper : IChoiceRefHelper
- public ChoiceRefHelper()
- public ChoiceRef DeserializeChoiceRef(object choiceObject)
- public IEnumerable<ChoiceRef> DeserializeChoiceRefEnumerable(object choiceListObjects)
public class ObjectTypeRefHelper : IObjectTypeRefHelper
- public ObjectTypeRefHelper()
- public ObjectTypeRef DeserializeObjectTypeRef(object objectTypeRef)
public class RelativityObjectRefHelper : IRelativityObjectRefHelper
- public RelativityObjectRefHelper()
- public RelativityObjectRef DeserializeRelativityObjectRef(object value)
- public IEnumerable<RelativityObjectRef> DeserializeRelativityObjectRefEnumerable(object value)
public class UserRefHelper : IUserRefHelper
- public UserRefHelper()
- public User DeserializeUserRef(object value)

Relativity.Services.Objects.Models

public class ObjectDependency
- public string Action { get; }
- public string Connection { get; }
- public int Count { get; }
- public bool IsModificationRestricted { get; }
- public string ObjectTypeName { get; }
- public ObjectDependency(string objectTypeName, string action, int count, string connection)
public class RelativityObject : RelativityObjectRef
- public IEnumerable<FieldValuePair> FieldValuePairs { get; set; }
- public int? ParentArtifactID { get; set; }
- public RelativityObject()
public class RelativityObjectRef
- public int ArtifactID { get; set; }
- public string DisplayText { get; set; }
- public IEnumerable<Guid> Guids { get; set; }
- public ObjectTypeRef ObjectTypeRef { get; set; }
- public RelativityObjectRef()
public class DeleteItem
- public string Action { get; set; }
- public string Connection { get; set; }
- public int Count { get; set; }
- public string ObjectType { get; set; }
- public DeleteItem()
public class DeleteReport
- public IEnumerable<DeleteItem> DeleteItems { get; set; }
- public DeleteReport()
public class EventHandlerStatus
- public string Message { get; set; }
- public bool Success { get; set; }
- public EventHandlerStatus()
public class ObjectCreateResult
- public IEnumerable<EventHandlerStatus> EventHandlerStatuses { get; set; }
- public RelativityObject RelativityObject { get; set; }
- public ObjectCreateResult()
public class ObjectDeleteResult
- public DeleteReport DeleteReport { get; set; }
- public ObjectDeleteResult()
public class ObjectQueryResultSet : QueryResultSet<RelativityObject>
- public int CurrentStartIndex { get; set; }
- public IEnumerable<int> IDWindow { get; set; }
- public FieldRef Includes { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public double?[] RankWindow { get; set; }
- public int ResultCount { get; set; }
- public SampleDetails Sample { get; set; }
- public ObjectQueryResultSet()
public class ObjectReadResult
- public string Message { get; set; }
- public RelativityObject RelativityObject { get; set; }
- public ObjectReadResult()
public class ObjectUpdateResult
- public IEnumerable<EventHandlerStatus> EventHandlerStatuses { get; set; }
- public ObjectUpdateResult()
public class Query : Query
- public int? ActiveArtifactID { get; set; }
- public bool? ConvertNumberFieldValuesToString { get; set; }
- public int? ExecutingSavedSearchID { get; set; }
- public int? ExecutingViewID { get; set; }
- public IEnumerable<FieldRef> Fields { get; set; }
- public bool? IncludeDisplayText { get; set; }
- public bool? IsAdhocQuery { get; set; }
- public bool? TruncateTextFields { get; set; }
- public Query()

Relativity.Services.Objects.Models.WebContent

public class CallingContext
- public LayoutMetadata Layout { get; set; }
- public PageMode PageMode { get; set; }
- public string Referrer { get; set; }
- public CallingContext()
public class LayoutMetadata
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public LayoutMetadata()
public enum PageMode
- Edit = 2
- List = 3
- Unknown = 0
- View = 1

Relativity.Services.Objects.Serialization

public class FieldRefSerializer : IModelSerializer<FieldRef>, IModelSerializer
- public FieldRefSerializer()
- public FieldRef TransformForDeserialize(object data)
- public object TransformForSerialize(FieldRef model)
public class FieldValuePairSerializer : IModelSerializer<FieldValuePair>, IModelSerializer
- public FieldValuePairSerializer()
- public FieldValuePair TransformForDeserialize(object data)
- public object TransformForSerialize(FieldValuePair model)
public class FRSerializer : IModelSerializer<FieldRef>, IModelSerializer
- public FRSerializer()
- public FieldRef TransformForDeserialize(object data)
- public object TransformForSerialize(FieldRef model)
public class FRVPSerializer : IModelSerializer<FieldRefValuePair>, IModelSerializer
- public FRVPSerializer()
- public FieldRefValuePair TransformForDeserialize(object data)
- public object TransformForSerialize(FieldRefValuePair model)
public class FVPSerializer : IModelSerializer<FieldValuePair>, IModelSerializer
- public FVPSerializer()
- public T GetPropertyFromData<T>(string name, object data)
- public FieldValuePair TransformForDeserialize(object data)
- public object TransformForSerialize(FieldValuePair fvp)

Relativity.Services.Permission

public class PermissionType : IEquatable<PermissionType>
- public static readonly PermissionType Manage
public interface IPermissionManager : IDisposable
- Task<List<PermissionDetail>> GetAdminOperationPermissionSelectedListAsync(int workspaceArtifactID, List<int> permissionIds)

Relativity.Services.PivotProfile

public class ObjectTypeRef : ObjectTypeRef
public class PivotBase
- public ObjectTypeRef ObjectType { get; set; }
- public ObjectTypeRef ObjectType { get; set; }

Relativity.Services.Proxy.Routing

public class RouteBuilder
- public RouteInfo GetRouteInfoBase(Type serviceModuleIntType, Type serviceIntType, MethodInfo targetIntMethod)

Relativity.Services.RelativityObject

public class Query : Query
public class RelativityObject : RelativityObjectRef
public class RelativityObjectRef
public class ObjectQueryResultSet : QueryResultSet<RelativityObject>
public class ObjectUpdateResult

Relativity.Services.ResourceServer

public class FileShareResourceServer : ResourceServerRef
- public ChoiceRef Status { get; set; }
- public UserRef SystemCreatedBy { get; set; }
- public DateTime SystemCreatedOn { get; set; }
- public UserRef SystemLastModifiedBy { get; set; }
- public DateTime SystemLastModifiedOn { get; set; }
- public string UNCPath { get; set; }
- public FileShareResourceServer()

Relativity.Services.Review.DynamicReviewQueue

public class DynamicDocumentReviewState : ReviewerStatus
- public int? AssignedDocumentArtifactID { get; set; }
- public int DynamicReviewStatusID { get; set; }
- public string StatusName { get; set; }
- public DynamicDocumentReviewState()
public class DynamicReviewQueue : DynamicReviewQueueRef
- public bool AllowOutsideCoded { get; set; }
- public int DynamicReviewID { get; set; }
- public int DynamicReviewStatusID { get; set; }
- public int? ReviewFieldArtifactID { get; set; }
- public string StatusCallbackUrl { get; set; }
- public string StatusName { get; set; }
- public DynamicReviewQueue()
public class DynamicReviewQueueRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public DynamicReviewQueueRef()
public class ReviewerStatus
- public int DocumentReviewCount { get; set; }
- public bool UserHasAccess { get; set; }
- public ReviewerStatus()

Relativity.Services.Search

public class AnalyticsSearch : SavedSearchRef, ISavedSearch, IRelativityApplicationAssociable
- public DashboardRef Dashboard { get; set; }
- public AnalyticsSearch(int artifactId)
public class DataGridSearch : SavedSearchRef, ISavedSearch, IRelativityApplicationAssociable
- public DashboardRef Dashboard { get; set; }
public class dtSearch : SavedSearchRef, ISavedSearch, IRelativityApplicationAssociable
- public DashboardRef Dashboard { get; set; }
public interface ISearchCriteriaAssociable
- int ArtifactTypeID { get; set; }
- CriteriaCollection SearchCriteria { get; set; }
public class KeywordSearch : SavedSearchRef, ISavedSearch, IRelativityApplicationAssociable
- public DashboardRef Dashboard { get; set; }
public class SearchProviderCondition
- public string SortOrder { get; set; }
public class AdvancedSearchViewInfo
- public List<string> FieldNames { get; set; }
- public bool HasViewPermission { get; set; }
- public AdvancedSearchViewInfo()
public interface ISearchContainerManager : IDisposable
- Task<AdvancedSearchViewInfo> GetAdvancedSearchViewInfoAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetAdvancedSearchViewUniqueCreatedByAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetAdvancedSearchViewUniqueModifiedByAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetAdvancedSearchViewUniqueOwnersAsync(int workspaceArtifactID)
- Task<SearchContainerItemCollection> GetFilteredWithAdvancedOptionsSearchContainerTreeAsync(int workspaceArtifactID, SearchContainerTreeFilter filter)
public class SearchProvider
- public string BasicSearchMarkupId { get; set; }

Relativity.Services.Security.Models

public class SAML2Provider
- public Uri Issuer { get; set; }
- public string Issuer { get; set; }

Relativity.Services.Serialization

public class ChoiceRefHelper : IChoiceRefHelper
- public ChoiceRefHelper()
- public ChoiceRef DeserializeChoiceRef(object choiceObject)
- public IEnumerable<ChoiceRef> DeserializeChoiceRefEnumerable(object choiceListObjects)
- public MultipleChoiceFieldUpdateValue DeserializeMulitChoiceFieldUpdateValue(object value)
public class DateHelper : IDateHelper
- public DateHelper()
public class FileRefHelper : IFileRefHelper
- public FileRefHelper()
- public FileRef DeserializeFileRef(object value)
public interface IChoiceRefHelper
- ChoiceRef DeserializeChoiceRef(object choiceObject)
- IEnumerable<ChoiceRef> DeserializeChoiceRefEnumerable(object choiceListObjects)
- MultipleChoiceFieldUpdateValue DeserializeMulitChoiceFieldUpdateValue(object value)
public interface IDateHelper
- DateTime DeserializeDate(object dateObject)
- bool IsValidDate(object dateObject)
public interface IFileRefHelper
- FileRef DeserializeFileRef(object value)
public interface IObjectTypeRefHelper
- ObjectTypeRef DeserializeObjectTypeRef(object objectTypeRef)
public interface IRelativityObjectRefHelper
- MultipleObjectFieldUpdateValue DeserializeMultiObjectFieldUpdateValue(object value)
- RelativityObjectRef DeserializeRelativityObjectRef(object value)
- IEnumerable<RelativityObjectRef> DeserializeRelativityObjectRefEnumerable(object value)
public interface IUserRefHelper
- UserRef DeserializeUserRef(object value)
public class ObjectTypeRefHelper : IObjectTypeRefHelper
- public ObjectTypeRefHelper()
- public ObjectTypeRef DeserializeObjectTypeRef(object objectTypeRef)
public class RelativityObjectRefHelper : IRelativityObjectRefHelper
- public RelativityObjectRefHelper()
- public MultipleObjectFieldUpdateValue DeserializeMultiObjectFieldUpdateValue(object value)
- public RelativityObjectRef DeserializeRelativityObjectRef(object value)
- public IEnumerable<RelativityObjectRef> DeserializeRelativityObjectRefEnumerable(object value)
public class RelativityObjectRefSerializer : IModelSerializer<RelativityObjectRef>, IModelSerializer
- public RelativityObjectRefSerializer()
- public RelativityObjectRef TransformForDeserialize(object data)
- public object TransformForSerialize(RelativityObjectRef model)
public class UserRefHelper : IUserRefHelper
- public UserRefHelper()
- public UserRef DeserializeUserRef(object value)

Relativity.Services.Serialization.Foundation

public interface IChoiceRefHelper
- ChoiceRef DeserializeChoiceRef(object choiceObject)
- IEnumerable<ChoiceRef> DeserializeChoiceRefEnumerable(object choiceListObjects)
public interface IObjectTypeRefHelper
- ObjectTypeRef DeserializeObjectTypeRef(object objectTypeRef)
public interface IRelativityObjectRefHelper
- RelativityObjectRef DeserializeRelativityObjectRef(object value)
- IEnumerable<RelativityObjectRef> DeserializeRelativityObjectRefEnumerable(object value)
public interface IUserRefHelper
- User DeserializeUserRef(object value)

Relativity.Services.StaticObject

public class BrandingQueueItem
- public int CaseArtifactID { get; set; }
- public string CaseName { get; set; }
- public int? ImagesRemaining { get; set; }
- public int Priority { get; set; }
- public string ProductionJobID { get; set; }
- public string ProductionName { get; set; }
- public int RootFolderID { get; set; }
- public int SetArtifactID { get; set; }
- public int SetQueueID { get; set; }
- public string Status { get; set; }
- public string SubmittedBy { get; set; }
- public DateTime SubmittedDate { get; set; }
- public int WorkspaceUpgradeStatus { get; set; }
- public BrandingQueueItem()
public class OCRQueueItem
- public string OCRSetName { get; set; }
- public int Priority { get; set; }
- public int SetArtifactID { get; set; }
- public int SetArtifactTypeId { get; set; }
- public int SetQueueID { get; set; }
- public string Status { get; set; }
- public DateTime SubmittedDate { get; set; }
- public int WorkspaceArtifactId { get; set; }
- public string WorkspaceName { get; set; }
- public OCRQueueItem()
public class ProductionQueueItem
- public string CaseName { get; set; }
- public string JobTypeName { get; set; }
- public int Priority { get; set; }
- public string ProductionJobID { get; set; }
- public string ProductionName { get; set; }
- public int RootFolderID { get; set; }
- public int SetArtifactID { get; set; }
- public int SetQueueID { get; set; }
- public string Status { get; set; }
- public string SubmittedBy { get; set; }
- public DateTime SubmittedDate { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public int WorkspaceUpgradeStatus { get; set; }
- public ProductionQueueItem()
public class StaticObjectQuery
- public string Condition { get; set; }
- public StaticObjectQuery()
public class UserStatusListItem
- public string ClientName { get; set; }
- public string CurrentCase { get; set; }
- public string EmailAddress { get; set; }
- public DateTime LastUpdateDateTime { get; set; }
- public string Message { get; set; }
- public string SessionToken { get; set; }
- public int UserId { get; set; }
- public string UserName { get; set; }
- public string WebServer { get; set; }
- public UserStatusListItem()
public class WorkerManagerQueueItem
- public int? DataSourceArtifactId { get; set; }
- public string DataSourceName { get; set; }
- public long? DocumentsRemaining { get; set; }
- public int? FailedAttempts { get; set; }
- public bool? IsPaused { get; set; }
- public long? JobId { get; set; }
- public string JobType { get; set; }
- public int? Priority { get; set; }
- public int? RootFolderId { get; set; }
- public int? ServerArtifactId { get; set; }
- public string ServerName { get; set; }
- public string ServerUrl { get; set; }
- public int? SetArtifactId { get; set; }
- public int SetArtifactTypeId { get; set; }
- public string SetName { get; set; }
- public string Status { get; set; }
- public string SubmittedBy { get; set; }
- public DateTime? SubmittedDate { get; set; }
- public DateTime? TimePaused { get; set; }
- public string WorkerManagerQueueId { get; set; }
- public int? WorkspaceArtifactId { get; set; }
- public string WorkspaceName { get; set; }
- public int? WorkspaceUpgradeStatus { get; set; }
- public WorkerManagerQueueItem()
public class WorkspaceUpgradeQueueItem
- public string CurrentRelativityVersion { get; set; }
- public string CurrentStoreVersion { get; set; }
- public int? DoneCount { get; set; }
- public int? ErrorID { get; set; }
- public int? Order { get; set; }
- public string Priority { get; set; }
- public int RootFolderID { get; set; }
- public int? StoreErrorID { get; set; }
- public int? StoreUpgradeStatusID { get; set; }
- public string StoreUpgradeStatusName { get; set; }
- public int StoreUpgradeStatusProgress { get; set; }
- public WorkspaceUpgradeQueueProgressType StoreUpgradeStatusProgressType { get; set; }
- public int? ToDoCount { get; set; }
- public int UpgradeStatusID { get; set; }
- public string UpgradeStatusName { get; set; }
- public int UpgradeStatusProgress { get; set; }
- public WorkspaceUpgradeQueueProgressType UpgradeStatusProgressType { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public string WorkspaceName { get; set; }
- public string WorkspaceStatus { get; set; }
- public WorkspaceUpgradeQueueItem()
public enum WorkspaceUpgradeQueueProgressType
- Complete = 2
- Failed = 3
- InProgress = 1
- NoProgress = 4
public class BrandingQueueQueryResultSet
- public int CurrentStartIndex { get; set; }
- public IEnumerable<BrandingQueueItem> DataResults { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultCount { get; set; }
- public BrandingQueueQueryResultSet()
public class BrandingSetQueueSubmitter
- public string Name { get; set; }
- public int UserID { get; set; }
- public BrandingSetQueueSubmitter()
public class OCRQueueQueryResultSet
- public int CurrentStartIndex { get; set; }
- public IEnumerable<OCRQueueItem> DataResults { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultCount { get; set; }
- public OCRQueueQueryResultSet()
public class PermissionResultSet
- public bool CanAccessServerTab { get; set; }
- public bool CanChangeQueuePriority { get; set; }
- public bool CanForceUserLogout { get; set; }
- public bool CanSendMessage { get; set; }
- public PermissionResultSet()
public class ProductionQueueQueryResultSet
- public int CurrentStartIndex { get; set; }
- public IEnumerable<ProductionQueueItem> DataResults { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultCount { get; set; }
- public ProductionQueueQueryResultSet()
public class ProductionSetQueueSubmitter
- public string Name { get; set; }
- public int UserID { get; set; }
- public ProductionSetQueueSubmitter()
public class StartupInfoResultSet
- public PermissionResultSet Permissions { get; set; }
- public object UserPreferences { get; set; }
- public UserSettingsResult UserSettings { get; set; }
- public Dictionary<string, int> ViewFieldWidthCollection { get; set; }
- public StartupInfoResultSet()
public class UserSettingsResult
- public int ItemListPageLength { get; set; }
- public bool ShowFilters { get; set; }
- public UserSettingsResult()
public class UserStatusQueryResultSet
- public int CurrentStartIndex { get; set; }
- public IEnumerable<UserStatusListItem> DataResults { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultCount { get; set; }
- public UserStatusQueryResultSet()
public class WorkerManagerQueueQueryResultSet
- public int CurrentStartIndex { get; set; }
- public IEnumerable<WorkerManagerQueueItem> DataResults { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultCount { get; set; }
- public WorkerManagerQueueQueryResultSet()
public class WorkspaceUpgradeQueueQueryResultSet
- public int CurrentStartIndex { get; set; }
- public IEnumerable<WorkspaceUpgradeQueueItem> DataResults { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultCount { get; set; }
- public WorkspaceUpgradeQueueQueryResultSet()

Relativity.Services.User

public class User : UserRef
- public string FirstName { get; set; }
- public int ItemListPageLength { get; set; }
- public string LastName { get; set; }
- public bool ShowFilters { get; set; }
- public User()
- public User(int artifactID)
public class WorkspaceUserData
- public bool? MaxNumberOfUsersReached { get; set; }
public interface IUserManager : IDisposable
- Task<WorkspaceUserData> RetrieveAllActiveWithLimitAsync(int workspaceId)
- Task<int> RetrieveCurrentAclUserIdAsync(int workspaceId)
- Task<User> RetrieveCurrentAsync(int workspaceId)

Relativity.Services.View

public class ObjectTypeRef : ObjectTypeRef
public class View : ViewRef, IViewFieldAssociable, ISortAssociable, IRelativityApplicationAssociable, ISearchCriteriaAssociable
- public DashboardRef Dashboard { get; set; }
- public bool IsRelationalFieldView { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
public interface IViewManager : IDisposable
- Task<int> CreateSingleAsync(int workspaceArtifactID, View viewDTO)
- Task<ViewAccessStatus> GetAccessStatusAsync(int workspaceArtifactID, int artifactID)
- Task<bool> GetIsViewLockedAsync(int workspaceArtifactID, View viewDTO)
- Task<List<ObjectTypeRef>> GetObjectTypesAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetViewOwnersAsync(int workspaceArtifactID)
- Task<View> ReadSingleAsync(int workspaceArtifactID, int viewArtifactID)
- Task UpdateSingleAsync(int workspaceArtifactID, View viewDTO)
public interface IViewModule
public class ViewAccessStatus
- public bool CanView { get; set; }
- public bool CanViewCriteriaFields { get; set; }
- public bool Exists { get; set; }
- public ViewAccessStatus()