Relativity.ObjectManager 11.2.256.10 - API Reference

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

API Differences between 11.2.256.10 and 11.1.185.8

361 Additions 100 Removals

Relativity.Kepler.Services

public interface IProbes
- TimeSpan RetryAfter { get; }
- Task<bool> IsLiveAsync(CancellationToken token)
- Task<bool> IsReadyAsync(CancellationToken token)
public class ProbesDefault : IProbes
- public virtual TimeSpan RetryAfter { get; }
- public ProbesDefault()
- public virtual Task<bool> IsLiveAsync(CancellationToken token)
- public virtual Task<bool> IsReadyAsync(CancellationToken token)
public class RoutePrefixAttribute : Attribute
- public VersioningStrategy Versioning { get; }
- public RoutePrefixAttribute(string prefix, VersioningStrategy versioning)
public enum VersioningStrategy
- Namespace = 1
- None = 0

Relativity.Kepler.Transport

public interface IKeplerStream : IDisposable
- NameValueCollection Headers { get; set; }
- HttpStatusCode? StatusCode { get; set; }
public interface IResponseController
- NameValueCollection Headers { get; set; }
- HttpStatusCode? StatusCode { get; set; }
public class KeplerResponseStream : IKeplerStream, IDisposable
- public NameValueCollection Headers { get; set; }
- public HttpStatusCode? StatusCode { get; set; }
- public event EventHandler Disposed
public class KeplerStream : IKeplerStream, IDisposable
- public NameValueCollection Headers { get; set; }
- public HttpStatusCode? StatusCode { get; set; }
public class ResponseController : IResponseController
- public NameValueCollection Headers { get; set; }
- public HttpStatusCode? StatusCode { get; set; }
- public ResponseController()

Relativity.Services.Exceptions

public class ExceptionIdentifierAttribute : Attribute
- public string Identifier { get; }
- public ExceptionIdentifierAttribute(string identifier)
public class MisdirectedRequestException : ServiceException
- public MisdirectedRequestException()
- public MisdirectedRequestException(string message)
- public MisdirectedRequestException(string message, Exception innerException)
- protected MisdirectedRequestException(SerializationInfo info, StreamingContext context)
public class SearchProviderException : ServiceException
- public SearchProviderException()
- public SearchProviderException(string message)
- public SearchProviderException(string message, Exception innerException)
- protected SearchProviderException(SerializationInfo info, StreamingContext context)

Relativity.Services.Interfaces.Application

public interface IApplicationManager : IDisposable
public interface IApplicationModule

Relativity.Services.Interfaces.Application.Models

public class Application
public class ApplicationComponentDetail
public class CreateApplicationRequest
public class CreateApplicationResponse
public enum ErrorLevel
public class ValidateApplicationResponse
public class ValidationMessage

Relativity.Services.Interfaces.Client

public interface IClientManager : IDisposable
- Task ActivateClientDomainAsync(int clientID)
- Task ActivateClientDomainAsync(int clientID, IProgress<ProgressReport> progress)
- Task ActivateClientDomainAsync(int clientID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<string> CreateClientDomainRequestKeyAsync(int clientID)
- Task SubmitClientDomainActivationKeyAsync(int clientID, string activationKey)
- Task SubmitClientDomainActivationKeyAsync(int clientID, string activationKey, IProgress<ProgressReport> progress)
- Task SubmitClientDomainActivationKeyAsync(int clientID, string activationKey, CancellationToken cancel, IProgress<ProgressReport> progress)

Relativity.Services.Interfaces.Group

public interface IGroupManager : IDisposable
- Task<List<Action>> GetMassActionsAsync()
- Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users)
- Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)

Relativity.Services.Interfaces.Layout

public interface ILayoutManager : IDisposable
- Task<LayoutResponse> CreateAsync(int workspaceID, LayoutRequest layoutRequest)
- Task DeleteAsync(int workspaceID, int layoutID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleOwnersAsync(int workspaceID)
- Task<LayoutResponse> ReadAsync(int workspaceID, int layoutID)
- Task<LayoutResponse> ReadAsync(int workspaceID, int layoutID, bool includeMetadata, bool includeActions)
- Task<LayoutResponse> UpdateAsync(int workspaceID, int layoutID, LayoutRequest layoutRequest)
- Task<LayoutResponse> UpdateAsync(int workspaceID, int layoutID, LayoutRequest layoutRequest, DateTime lastModifiedOn)
public interface ILayoutModule
public class LayoutConstants
- public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/layouts"
- public const string LAYOUT_ID_STRING = "layoutID"
- public const string MODULE_PREFIX = "Relativity.Layouts"
- public const string SERVICE_MODULE_NAME = "Layout Module"
- public const string SERVICE_NAME = "Layout Manager"
- public const string SERVICE_ROUTE = "layouts"
- public LayoutConstants()

Relativity.Services.Interfaces.Layout.Models

public class LayoutRequest
- public bool AllowCopyFromPrevious { get; set; }
- public string Keywords { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public Securable<ObjectTypeIdentifier> ObjectType { get; set; }
- public string Order { get; set; }
- public bool OverwriteProtection { get; set; }
- public ObjectIdentifier Owner { get; set; }
- public List<ObjectIdentifier> RelativityApplications { get; set; }
- public LayoutRequest()
- public LayoutRequest(LayoutResponse layoutResponse)
public class LayoutResponse : DisplayableObjectIdentifier, IHaveMetaAndActions, IHaveKeywordsAndNotes, IHaveCreatedAndModified
- public List<Action> Actions { get; set; }
- public bool AllowCopyFromPrevious { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Meta Meta { get; set; }
- public string Notes { get; set; }
- public Securable<ObjectTypeIdentifier> ObjectType { get; set; }
- public string Order { get; set; }
- public bool OverwriteProtection { get; set; }
- public DisplayableObjectIdentifier Owner { get; set; }
- public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
- public LayoutResponse()

Relativity.Services.Interfaces.LibraryApplication

public interface ILibraryApplicationManager : IDisposable
- Task<ApplicationHostingStatusResponse> GetApplicationHostingStatusAsync(int workspaceID, Guid applicationGUID)
- Task<ApplicationHostingStatusResponse> GetApplicationHostingStatusAsync(int workspaceID, int applicationID)

Relativity.Services.Interfaces.LibraryApplication.Models

public class ApplicationHostingStatusResponse : HostingStatusResponse
- public List<CustomPageHostingStatusResponse> CustomPages { get; set; }
- public ApplicationHostingStatusResponse()
public class CustomPageHostingStatusResponse : HostingStatusResponse
- public Securable<DisplayableObjectIdentifier> CustomPage { get; set; }
- public HttpStatusCode StatusCode { get; set; }
- public CustomPageHostingStatusResponse()
public class GetInstallStatusResponse : IHasInstallStatus
- public List<ApplicationInstallDetail> Errors { get; set; }
public class HostingStatusResponse
- public List<Action> Actions { get; set; }
- public string Message { get; set; }
- public ReadinessState State { get; set; }
- public HostingStatusResponse()
public enum ReadinessState
- OutOfDate = 2
- Pending = 1
- Ready = 0
- Unavailable = 3

Relativity.Services.Interfaces.MassOperation.Models

public class CustomPageMassOperationRequest
- public bool OpenInModal { get; set; }
public class MassOperationResponse : ObjectIdentifier
- public bool OpenInModal { get; set; }

Relativity.Services.Interfaces.ResourcePool

public interface IResourcePoolManager : IDisposable
- Task AddResourceAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)
- Task AddResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, IProgress<ProgressReport> progress)
- Task AddResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task AddResourcesAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)
- Task RemoveResourceAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)
- Task RemoveResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, IProgress<ProgressReport> progress)
- Task RemoveResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task RemoveResourcesAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)

Relativity.Services.Interfaces.ResourceServer

public interface IAgentServerManager : IDisposable
- Task DeleteAsync(int serverID)
- Task RestartWindowsService(int serverID)
- Task RestartWindowsServiceAsync(int serverID)
public interface IAnalyticsServerManager : IDisposable
- Task<List<DisplayableObjectIdentifier>> GetAvailableAnalyticsOperationsAsync()
- Task<AnalyticsServerResponse> GetDefaultFieldValues()
- Task<AnalyticsServerDefaultValuesResponse> GetDefaultFieldValuesAsync()
- Task<List<DisplayableObjectIdentifier>> GetEligibleAnalyticsOperationsAsync()
- Task<Meta> GetMetadataAsync()
- Task RestartWindowsService(int serverID)
- Task RestartWindowsServiceAsync(int serverID)
public interface ICacheLocationServerManager : IDisposable
- Task ClearCache(int serverID)
- Task ClearCache(int serverID, IProgress<ProgressReport> progress)
- Task ClearCache(int serverID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<List<DisplayableObjectIdentifier>> GetAvailableFileAccessCredentialsAsync()
- Task<CacheLocationServerResponse> GetDefaultFieldValues()
- Task<Meta> GetMetadataAsync()
- Task<bool> IsLastVisibleServerAsync(int serverID)
- Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
public interface IFileshareServerManager : IDisposable
public interface IFileRepositoryServerManager : IDisposable
- Task<FileRepositoryServerResponse> CreateAsync(FileRepositoryServerRequest request)
- Task DeleteAsync(int serverID)
- Task<Meta> GetMetadataAsync()
- Task<bool> IsLastVisibleServerAsync(int serverID)
- Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<FileRepositoryServerResponse> ReadAsync(int serverID)
- Task<FileRepositoryServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
- Task<FileRepositoryServerResponse> UpdateAsync(int serverID, FileRepositoryServerRequest request)
- Task<FileRepositoryServerResponse> UpdateAsync(int serverID, FileRepositoryServerRequest request, DateTime lastModifiedOn)
public interface IResourceServerManager : IDisposable
- Task<ResourceServerMetadataResponse> ReadMetaAsync(int serverID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleStatusesAsync()
- Task<ResourceServerResponse> ReadAsync(int serverID)
- Task<List<ServerTypeResponse>> ReadServerTypesAsync()
public interface IServicesServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface ISqlDistributedServerManager : IDisposable
- Task DeleteAsync(int serverID)
- Task<bool> IsLastVisibleServerAsync(int serverID)
public interface ISqlPrimaryServerManager : IDisposable
- Task DeleteAsync(int serverID)
- Task<bool> IsLastVisibleServerAsync(int serverID)
public interface IWebApiFormsAuthServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebApiServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebApiWindowsAuthServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebBackgroundProcessingServerManager : IDisposable
- Task DeleteAsync(int serverID)
- Task<WorkerManagerServerResponse> ReadAsync(int serverID)
- Task<WorkerManagerServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
- Task RestartWindowsService(int serverID)
- Task<WebBackgroundProcessingServerResponse> ReadAsync(int serverID)
- Task<WebBackgroundProcessingServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
- Task RestartWindowsServiceAsync(int serverID)
public interface IWebDistributedFormsAuthServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebDistributedServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebDistributedWindowsAuthServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebFormsAuthServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebServerManager : IDisposable
- Task DeleteAsync(int serverID)
public interface IWebWindowsAuthServerManager : IDisposable
- Task<WebWindowsAuthServerResponse> ReadAsync(int serverID)
- Task<WebWindowsAuthServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
- Task<WebWindowsAuthServerResponse> UpdateAsync(int serverID, WebWindowsAuthServerRequest request)
- Task<WebWindowsAuthServerResponse> UpdateAsync(int serverID, WebWindowsAuthServerRequest request, DateTime lastModifiedOn)
public interface IWorkerManagerServerManager : IDisposable
- Task<WorkerManagerServerResponse> CreateAsync(WorkerManagerServerRequest request)
- Task DeleteAsync(int serverID)
- Task<WorkerManagerServerDefaultValuesResponse> GetDefaultFieldValuesAsync()
- Task<WorkerManagerServerResponse> ReadAsync(int serverID)
- Task<WorkerManagerServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
- Task<WorkerManagerServerResponse> UpdateAsync(int serverID, WorkerManagerServerRequest request)
- Task<WorkerManagerServerResponse> UpdateAsync(int serverID, WorkerManagerServerRequest request, DateTime lastModifiedOn)
public interface IWorkerServerManager : IDisposable
- Task DeleteAsync(int serverID)
- Task<List<DisplayableObjectIdentifier>> GetAvailableWorkerDesignatedWorkAsync()
- Task DisableProcessingLicenseAsync(int serverID)
- Task EnableProcessingLicenseAsync(int serverID)
- Task<List<EnableableObjectIdentifier>> GetEligibleWorkerDesignatedWorkAsync(int serverID)
- Task StartWorkerAsync(int serverID)
- Task StopWorkerAsync(int serverID)
- Task UpdateProcessingLicenseStatusAsync(int serverID, bool isProcessingEnabled)
- Task UpdateWorkerStatusAsync(int serverID, bool isStarted)
public class ResourceServerMetadataResponse : DisplayableObjectIdentifier, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified

Relativity.Services.Interfaces.ResourceServer.Models

public class AgentServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveTemporaryDirectory, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public bool IsWindowsServiceRestartAllowed { get; set; }
public class AnalyticsServerDefaultValuesResponse : IHaveDisplayableStatus
- public int MaximumConnectors { get; set; }
- public int MaximumTotalConnectors { get; set; }
- public DisplayableObjectIdentifier Status { get; set; }
- public AnalyticsServerDefaultValuesResponse()
public class AnalyticsServerRequest : IHaveName, IHaveStatus, IHaveKeywordsAndNotes
- public AnalyticsServerRequest(AnalyticsServerDefaultValuesResponse defaultValues)
- public static AnalyticsServerRequest op_Implicit(AnalyticsServerDefaultValuesResponse defaultValues)
public class AnalyticsServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public bool IsWindowsServiceRestartAllowed { get; set; }
public class CacheLocationServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveUncPath, IHaveIsVisible, IHaveDisplayableFileAccessCredentials, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public bool IsCacheCleanupAllowed { get; set; }
public class FileshareServerRequest : IHaveName, IHaveIsVisible, IHaveUncPath, IHaveFileAccessCredentials, IHaveKeywordsAndNotes
public class FileshareServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveUncPath, IHaveIsVisible, IHaveDisplayableFileAccessCredentials, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
public class FileRepositoryServerRequest : IHaveName, IHaveIsVisible, IHaveUncPath, IHaveFileAccessCredentials, IHaveKeywordsAndNotes
- public Securable<ObjectIdentifier> FileAccessCredentials { get; set; }
- public bool IsVisible { get; set; }
- public string Keywords { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public string UncPath { get; set; }
- public FileRepositoryServerRequest()
- public FileRepositoryServerRequest(FileRepositoryServerResponse response)
- public static FileRepositoryServerRequest op_Implicit(FileRepositoryServerResponse response)
public class FileRepositoryServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveUncPath, IHaveIsVisible, IHaveDisplayableFileAccessCredentials, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public List<Action> Actions { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public Securable<DisplayableObjectIdentifier> FileAccessCredentials { get; set; }
- public bool IsVisible { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Meta Meta { get; set; }
- public string Notes { get; set; }
- public DisplayableObjectIdentifier Type { get; set; }
- public string UncPath { get; set; }
- public FileRepositoryServerResponse()
public class ResourceServerResponse : DisplayableObjectIdentifier, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public List<Action> Actions { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Meta Meta { get; set; }
- public string Notes { get; set; }
- public DisplayableObjectIdentifier Type { get; set; }
- public ResourceServerResponse()
public class ServerTypeResponse : IHasArtifactID, IHasIdentifyingInformation, IHasName
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public string SystemArtifactIdentifier { get; set; }
- public string Url { get; set; }
- public ServerTypeResponse()
public class SqlDistributedServerRequest : IHaveFriendlyName, IHaveIsVisible, IHaveStatus, IHaveBcpPath, IHaveWorkspaceUpgradeLimit, IHaveKeywordsAndNotes
- public SqlDistributedServerRequest(SqlPrimaryServerResponse response)
- public static SqlDistributedServerRequest op_Implicit(SqlPrimaryServerResponse response)
- public SqlDistributedServerRequest(SqlDistributedServerResponse response)
- public static SqlDistributedServerRequest op_Implicit(SqlDistributedServerResponse response)
public class WebBackgroundProcessingServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public bool IsWindowsServiceRestartAllowed { get; set; }
public class WebFormsAuthServerRequest : IHaveStatus, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveKeywordsAndNotes
- public bool IsUserLoadBalancingEnabled { get; set; }
- public string Url { get; set; }
public class WebFormsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveFailedRedirectionAttemptCount, IHaveLastRedirectFailedOn, IHaveCurrentUserCount, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public int CurrentUserCount { get; set; }
- public int FailedRedirectionAttemptCount { get; set; }
- public bool IsUserLoadBalancingEnabled { get; set; }
- public DateTime? LastRedirectFailedOn { get; set; }
- public string Url { get; set; }
public class WebServerRequest : IHaveStatus, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveKeywordsAndNotes
- public bool IsUserLoadBalancingEnabled { get; set; }
- public string Url { get; set; }
public class WebServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveFailedRedirectionAttemptCount, IHaveLastRedirectFailedOn, IHaveCurrentUserCount, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public int CurrentUserCount { get; set; }
- public int FailedRedirectionAttemptCount { get; set; }
- public bool IsUserLoadBalancingEnabled { get; set; }
- public DateTime? LastRedirectFailedOn { get; set; }
- public string Url { get; set; }
public class WebWindowsAuthServerRequest : IHaveStatus, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveKeywordsAndNotes
- public bool IsUserLoadBalancingEnabled { get; set; }
- public string Url { get; set; }
public class WebWindowsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveFailedRedirectionAttemptCount, IHaveLastRedirectFailedOn, IHaveCurrentUserCount, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public int CurrentUserCount { get; set; }
- public int FailedRedirectionAttemptCount { get; set; }
- public bool IsUserLoadBalancingEnabled { get; set; }
- public DateTime? LastRedirectFailedOn { get; set; }
- public string Url { get; set; }
public class WorkerManagerServerDefaultValuesResponse
- public int DiscoveryPriority { get; set; }
- public int ImageOnTheFlyPriority { get; set; }
- public int InventoryPriority { get; set; }
- public int MassImagingPriority { get; set; }
- public int MassSaveAsPdfPriority { get; set; }
- public int PublishPriority { get; set; }
- public int SingleSaveAsPdfPriority { get; set; }
- public WorkerManagerServerDefaultValuesResponse()
public class WorkerManagerServerRequest : IHaveName, IHaveTemporaryDirectory, IHaveKeywordsAndNotes
- public string ServerName { get; set; }
- public WorkerManagerServerRequest(WorkerManagerServerDefaultValuesResponse defaultValues)
- public static WorkerManagerServerRequest op_Implicit(WorkerManagerServerDefaultValuesResponse defaultValues)
public class WorkerManagerServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveTemporaryDirectory, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public bool IsWindowsServiceRestartAllowed { get; set; }
- public DisplayableObjectIdentifier Status { get; set; }
public class WorkerServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public bool IsChangingWorkerLicenseStatusAllowed { get; set; }
- public bool IsChangingWorkerStatusAllowed { get; set; }
- public List<ObjectIdentifier> WorkerDesignatedWork { get; set; }
- public List<DisplayableObjectIdentifier> WorkerDesignatedWork { get; set; }
- public string WorkerSatus { get; set; }
- public string WorkerStatus { get; set; }
- public int WorkerWorkStationID { get; set; }
- public long WorkerWorkStationID { get; set; }

Relativity.Services.Interfaces.Tab

public interface ITabManager : IDisposable
- Task<List<NavigationTabResponse>> GetAllNavigationTabs(int workspaceID)

Relativity.Services.Interfaces.Tab.Models

public class NavigationTabResponse : DisplayableObjectIdentifier
- public bool? IsDefault { get; set; }
- public bool IsShownInSidebar { get; set; }
- public bool IsVisible { get; set; }
- public TabLinkTypeEnum LinkType { get; set; }
- public Securable<ObjectTypeIdentifier> ObjectTypeIdentifier { get; set; }
- public int Order { get; set; }
- public Securable<DisplayableObjectIdentifier> Parent { get; set; }
- public string Url { get; set; }
- public NavigationTabResponse()

Relativity.Services.Interfaces.UserInfo.Models

public enum DocumentViewer
- RelativityReview = 3
public class UserResponse : ObjectIdentifier
- public DateTime? LastLoginDate { get; set; }

Relativity.Services.Interfaces.Workspace

public interface IWorkspaceManager : IDisposable
- Task<Meta> GetDefaultDownloadHandlerURL()
- Task<List<DisplayableObjectIdentifier>> GetEligibleAzureCredentials()
- Task<List<DisplayableObjectIdentifier>> GetEligibleAzureFileSystemCredentials()
- Task<List<DisplayableObjectIdentifier>> GetEligibleCacheLocations(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleFileRepositories(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleResourcePools()
- Task<SqlFullTextLanguageOptions> GetEligibleSqlFullTextLanguages()
- Task<List<DisplayableObjectIdentifier>> GetEligibleSqlServers(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleStatuses()
- Task<Meta> GetMeta()
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<string> GetDefaultDownloadHandlerURLAsync()
- Task<List<DisplayableObjectIdentifier>> GetEligibleAzureCredentialsAsync(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleAzureFileSystemCredentialsAsync(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleCacheLocationsAsync(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleFileRepositoriesAsync(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleResourcePoolsAsync()
- Task<SqlFullTextLanguageOptions> GetEligibleSqlFullTextLanguagesAsync()
- Task<List<DisplayableObjectIdentifier>> GetEligibleSqlServersAsync(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleStatusesAsync()
- Task<Meta> GetMetaAsync()
- Task<WorkspaceSummary> GetWorkspaceSummaryAsync(int workspaceID)
- Task MoveToColdStorageAsync(int workspaceID)
- Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID)
- Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task RetryFailedCreateEventHandlers(int workspaceID)
- Task RetryFailedCreateEventHandlersAsync(int workspaceID)

Relativity.Services.Interfaces.Workspace.Models

public class WorkspaceRequest
- public Securable<ObjectIdentifier> Client { get; set; }
public class WorkspaceSummary
- public long DocumentCount { get; set; }
- public long FileSize { get; set; }
- public WorkspaceSummary()

Relativity.Services.Objects.DataContracts

public class WordListCondition
- public string displayValue { get; set; }
- public string operator { get; set; }
- public string value { get; set; }
- public WordListCondition()
public class WordListFieldCondition
- public WordListCondition condition { get; set; }
- public string field { get; set; }
- public bool isAdvanced { get; set; }
- public WordListFieldCondition()
public class WordListSort
- public string column { get; set; }
- public string direction { get; set; }
- public WordListSort()

Relativity.Services.Permission

public class GroupTabVisibility
- public int GroupArtifactID { get; set; }
- public DateTime LastModified { get; set; }
- public List<GenericPermission> TabVisibility { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public GroupTabVisibility()
public interface IPermissionManager : IDisposable
- Task<GroupTabVisibility> GetAdminGroupTabVisibilityAsync(int groupArtifactID)
- Task<GroupTabVisibility> GetWorkspaceGroupTabVisibilityAsync(int workspaceArtifactID, int groupArtifactID)
- Task SetAdminGroupTabVisibilityAsync(GroupTabVisibility tabVisibility)
- Task SetWorkspaceGroupTabVisibilityAsync(int workspaceArtifactID, GroupTabVisibility tabVisibility)

Relativity.Services.Pipeline

public static class Constants
- public static class MetricsHeaders
public enum WireProtocolVersion
- V1 = 0

Relativity.Services.Proxy

public class ServiceExceptionWrapper
- public string Identifier { get; set; }
- public static string GetExceptionIdentifier(ServiceException ex)
- public static Type GetExceptionTypeFromWrapper(ServiceExceptionWrapper wrapper)

Relativity.Services.Proxy.Async

public class TicketTaskTable : ConcurrentDictionary<LRPTicket, Tuple<CancellationTokenSource, Task>>

Relativity.Services.Proxy.LRP

public class KeplerLRPClientV1 : IKeplerClient, IDisposable
public interface IServerBridge : IDisposable
- Task<IDisposable> RegisterForProgressNotifications<T>(LRPTicket ticket, IProgress<T> progress)
- Task<bool> SendCancellationRequestAsync(LRPTicket ticket)

Relativity.Services.Proxy.RPC

public class KeplerRPCClientV1 : KeplerRPCClient

Relativity.Services.Proxy.Routing

public static class VersionByNamespaceExtensions
- public static RouteInfo ApplyVersionToUrl(this RouteInfo routeInfo)
- public static string GetRawApiVersion(this Type controllerType)

Relativity.Services.ResourceServer

public interface IWebWindowsAuthServerManager : IDisposable
public interface IWorkerManagerServerManager : IDisposable

Relativity.Services.ResourceServer.Models

public class EnableableObjectIdentifier : DisplayableObjectIdentifier
- public bool Enabled { get; set; }
- public EnableableObjectIdentifier()

Relativity.Services.Search

public class WordListDictionaryResponse
- public readonly long TotalResults
- public readonly List<WordListResult> WordListResults
- public WordListDictionaryResponse(List<WordListResult> wordListResults, long totalResults)
public interface IdtSearchManager : IDisposable
- Task<List<WordListResult>> GetDictionarySearchResultsAsync(int workspaceArtifactID, int searchProviderID, string searchRequest, string fuzzinessLevel, bool enableStemming)
- Task<WordListDictionaryResponse> GetDictionarySearchResultsAsync(int workspaceArtifactID, int searchProviderID, string searchRequest, string fuzzinessLevel, bool enableStemming, IEnumerable<WordListFieldCondition> conditions, WordListSort sort, int start, int length)

Relativity.Services.UserSearchHistoryManager.Models

public class UserSearchHistoryRequest
- public long Hits { get; set; }
- public int SearchProviderArtifactID { get; set; }
- public string SearchTerm { get; set; }
- public UserSearchHistoryRequest()
public class UserSearchHistoryResponse
- public long Hits { get; set; }
- public int SearchProviderArtifactID { get; set; }
- public string SearchTerm { get; set; }
- public DateTime Timestamp { get; set; }
- public int UserArtifactID { get; set; }
- public int UserSearchHistoryID { get; set; }
- public UserSearchHistoryResponse()