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

---

API Differences between 10.1.273.3 and 9.7.74.3

755 Additions 2 Removals

Relativity.Services.ChoiceQuery

• public class Choice
  • public int? ParentArtifactID { get; set; }

Relativity.Services.DBStatus

• public interface IDBStatusManager : IDisposable
  • Task CallInvariantDBAsync()
• public interface IDBStatusModule

Relativity.Services.Exceptions

• public class ConflictException : ServiceException
  • public ConflictException()
  • public ConflictException(string message)
  • public ConflictException(string message, Exception innerException)
  • protected ConflictException(SerializationInfo info, StreamingContext context)
• public class SaveConflictException : ServiceException
  • public SaveConflictException()
  • public SaveConflictException(string message)
  • public SaveConflictException(string message, Exception innerException)
  • protected SaveConflictException(SerializationInfo info, StreamingContext context)
• public class UnprocessableEntityException : ServiceException
  • public UnprocessableEntityException()
  • public UnprocessableEntityException(string message)
  • public UnprocessableEntityException(string message, Exception innerException)
  • protected UnprocessableEntityException(SerializationInfo info, StreamingContext context)

Relativity.Services.FileField

• public static class FileFieldConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/file"
  • public const string MODULE_PREFIX = "Relativity.FileField"
  • public const string SERVICE_MODULE_NAME = "File Field Module"
  • public const string SERVICE_NAME = "File Field Manager"
• public interface IFileFieldManager : IDisposable
  • Task<IKeplerStream> DownloadAsync(int workspaceID, RelativityObjectRef objectRef, FieldRef field)
  • Task<FileRef> UploadAsync(int workspaceID, FieldRef field, RelativityObjectRef objectRef, string fileName, IKeplerStream file)
  • Task<FileRef> UploadAsync(int workspaceID, FieldRef field, RelativityObjectRef objectRef, string fileName, IKeplerStream file, IProgress<ProgressReport> progress)
  • Task<FileRef> UploadAsync(int workspaceID, FieldRef field, RelativityObjectRef objectRef, string fileName, IKeplerStream file, CancellationToken cancel, IProgress<ProgressReport> progress)
• public interface IFileFieldModule

Relativity.Services.Files

• public class FileRef
  • public Guid? UploadedFileGuid { get; set; }

Relativity.Services.Interfaces.Agent

• public class AgentConstants
  • public const string AGENT_ID_STRING = "agentID"
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/agents"
  • public const string MODULE_PREFIX = "Relativity.Agents"
  • public const string SERVICE_MODULE_NAME = "Agent Module"
  • public const string SERVICE_NAME = "Agent Manager"
  • public const string SERVICE_ROUTE = "agents"
  • public AgentConstants()
• public interface IAgentManager : IDisposable
  • Task<int> CreateAsync(int workspaceID, AgentRequest agentRequest)
  • Task<List<int>> CreateAsync(int workspaceID, AgentRequest agentRequest, int count)
  • Task DeleteAsync(int workspaceID, int agentID)
  • Task DeleteAsync(int workspaceID, int agentID, bool force)
  • Task<List<AgentServerResponse>> GetAgentServersAsync(int workspaceID)
  • Task<List<AgentTypeResponse>> GetAgentTypesAsync(int workspaceID)
  • Task<List<AgentServerResponse>> GetAvailableAgentServersAsync(int workspaceID, int agentTypeID)
  • Task<List<AgentServerResponse>> GetAvailableAgentServersAsync(int workspaceID, Guid agentTypeGuid)
  • Task<AgentResponse> ReadAsync(int workspaceID, int agentID)
  • Task<AgentResponse> ReadAsync(int workspaceID, int agentID, bool includeMetadata, bool includeActions)
  • Task UpdateAsync(int workspaceID, int agentID, AgentRequest agentRequest)
  • Task UpdateAsync(int workspaceID, int agentID, AgentRequest agentRequest, DateTime lastModifiedOn)
  • Task<List<AgentInstanceLimitResult>> ValidateCreateInstanceLimitAsync(int workspaceID, AgentRequest agentRequest, int count)
  • Task<List<AgentInstanceLimitResult>> ValidateDeleteInstanceLimitAsync(int workspaceID, int agentID)
  • Task<List<AgentInstanceLimitResult>> ValidateUpdateInstanceLimitAsync(int workspaceID, int agentID, AgentRequest agentRequest)
• public interface IAgentModule

Relativity.Services.Interfaces.Agent.Models

• public enum AgentEventLevel
  • Error = 1
  • Informational = 3
  • Warning = 2
• public enum AgentInstanceLimit
  • LastPerEnvironment = 6
  • MaxPerEnvironment = 2
  • MaxPerServer = 5
  • MinPerEnvironment = 1
  • MinPerResourcePool = 3
  • MinPerServer = 4
• public class AgentInstanceLimitResult
  • public Securable<DisplayableObjectIdentifier> AgentServer { get; set; }
  • public AgentInstanceLimit Limit { get; set; }
  • public Securable<DisplayableObjectIdentifier> ResourcePool { get; set; }
  • public AgentInstanceLimitResult()
• public class AgentRequest
  • public Securable<ObjectIdentifier> AgentServer { get; set; }
  • public Securable<ObjectIdentifier> AgentType { get; set; }
  • public bool Enabled { get; set; }
  • public decimal Interval { get; set; }
  • public string Keywords { get; set; }
  • public int LoggingLevel { get; set; }
  • public string Notes { get; set; }
  • public AgentRequest()
  • public AgentRequest(AgentResponse agentResponse)
• public class AgentResponse : DisplayableObjectIdentifier
  • public List<Action> Actions { get; set; }
  • public Securable<DisplayableObjectIdentifier> AgentServer { get; set; }
  • public Securable<DisplayableObjectIdentifier> AgentType { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public string DetailMessage { get; set; }
  • public bool Enabled { get; set; }
  • public AgentEventLevel EventLevel { get; set; }
  • public decimal Interval { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public DateTime? LastUpdate { get; set; }
  • public int LoggingLevel { get; set; }
  • public string Message { get; set; }
  • public DateTime? MessageTime { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public AgentResponse()
• public class AgentServerResponse : DisplayableObjectIdentifier
  • public int NumberOfAgents { get; set; }
  • public int ProcessorCores { get; set; }
  • public string Type { get; set; }
  • public AgentServerResponse()
• public class AgentTypeResponse : DisplayableObjectIdentifier
  • public Guid AgentTypeGuid { get; set; }
  • public string ApplicationName { get; set; }
  • public string CompanyName { get; set; }
  • public decimal? DefaultInterval { get; set; }
  • public int? DefaultLoggingLevel { get; set; }
  • public AgentTypeResponse()

Relativity.Services.Interfaces.DtSearchIndexManager

• public class DtSearchIndexConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/dtsearchindexes"
  • public const string DTSEARCH_ARTIFACT_ID_ROUTE = "{dtsearchArtifactID:int}"
  • public const string DTSEARCH_ARTIFACT_ID_STRING = "dtsearchArtifactID"
  • public const string MODULE_PREFIX = "Relativity.DtSearchIndexes"
  • public const string SERVICE_MODULE_NAME = "DtSearchIndex Module"
  • public const string SERVICE_NAME = "DtSearchIndex Manager"
  • public const string SERVICE_ROUTE_POSTFIX = "dtsearchindexes"
  • public DtSearchIndexConstants()
• public interface IDtSearchIndexManager : IDisposable
  • Task ActivateIndexAsync(int workspaceID, int dtsearchArtifactID)
  • Task CancelBuildIndexAsync(int workspaceID, int dtsearchArtifactID)
  • Task CompressIndexAsync(int workspaceID, int dtsearchArtifactID)
  • Task<int> CreateAsync(int workspaceID, DtSearchIndexRequest dtSearchIndexRequest)
  • Task DeactivateIndexAsync(int workspaceID, int dtsearchArtifactID)
  • Task DeleteAsync(int workspaceID, int dtsearchArtifactID)
  • Task FullBuildIndexAsync(int workspaceID, int dtsearchArtifactID, bool isActive)
  • Task<DtSearchIndexStatus> GetIndexIDAndStatusAsync(int workspaceID, int dtsearchArtifactID)
  • Task<List<NameIDPair>> GetIndexShareLocationAsync(int workspaceID)
  • Task<List<NameIDPair>> GetSearchableSetAsync(int workspaceID)
  • Task<List<DtSearchSubIndexResponse>> GetSubIndexDetailsAsync(int workspaceID, int dtsearchArtifactID)
  • Task IncrementalBuildIndexAsync(int workspaceID, int dtsearchArtifactID)
  • Task<DtSearchIndexResponse> ReadAsync(int workspaceID, int dtsearchArtifactID, bool includeMetadata, bool includeActions)
  • Task<DtSearchIndexResponse> ReadAsync(int workspaceID, int dtsearchArtifactID)
  • Task RetryErrorsAsync(int workspaceID, int dtsearchArtifactID)
  • Task SwapIndexAsync(int workspaceID, int oldSearchProviderID, int newSearchProviderID)
  • Task UpdateAsync(int workspaceID, int dtsearchArtifactID, DtSearchIndexRequest dtSearchIndexRequest)
• public interface IDtSearchIndexModule

Relativity.Services.Interfaces.DtSearchIndexManager.Models

• public class DtSearchIndexRequest
  • public string AlphabetText { get; set; }
  • public string DirtySettings { get; set; }
  • public string EmailAddress { get; set; }
  • public int FragmentationThreshold { get; set; }
  • public int IndexShareCodeArtifactID { get; set; }
  • public string Name { get; set; }
  • public string NoiseWords { get; set; }
  • public int Order { get; set; }
  • public int Priority { get; set; }
  • public bool RecognizeDates { get; set; }
  • public int SearchSearchID { get; set; }
  • public bool SkipNumericValues { get; set; }
  • public int SubIndexSize { get; set; }
  • public DtSearchIndexRequest()
• public class DtSearchIndexResponse
  • public string AlphabetText { get; set; }
  • public string DirtySettings { get; set; }
  • public int DtSearchSourceIndexID { get; set; }
  • public string EmailAddress { get; set; }
  • public int FragmentationThreshold { get; set; }
  • public int ID { get; set; }
  • public int IndexShareCodeArtifactID { get; set; }
  • public DateTime LastBuildEndTime { get; set; }
  • public string LastBuildError { get; set; }
  • public DateTime LastBuildStartTime { get; set; }
  • public DateTime LastIndexStartTime { get; set; }
  • public string Location { get; set; }
  • public string Name { get; set; }
  • public string NoiseWords { get; set; }
  • public bool RecognizeDates { get; set; }
  • public int RelativitySearchProviderID { get; set; }
  • public int SearchableSearchID { get; set; }
  • public bool SkipNumericValues { get; set; }
  • public string Status { get; set; }
  • public int SubIndexSize { get; set; }
  • public DtSearchIndexResponse()
• public class DtSearchIndexStatus
  • public int ID { get; set; }
  • public string Status { get; set; }
  • public DtSearchIndexStatus()
• public class DtSearchSubIndexResponse
  • public string BuildStatus { get; set; }
  • public int DtSearchIndexId { get; set; }
  • public int DtSearchSubIndexId { get; set; }
  • public int ErroredDocumentCount { get; set; }
  • public string ErrorMessage { get; set; }
  • public int FragmentationLevel { get; set; }
  • public int IndexedDocumentCount { get; set; }
  • public string IndexLocation { get; set; }
  • public string IsWorkerAgentEnabled { get; set; }
  • public string RepositoryName { get; set; }
  • public string SubIndexLocation { get; set; }
  • public int TotalDocumentCount { get; set; }
  • public string WorkerAgent { get; set; }
  • public DtSearchSubIndexResponse()

Relativity.Services.Interfaces.EventHandler

• public interface IEventHandlerManager : IDisposable
  • Task AttachAsync(int workspaceID, int objectTypeID, int eventHandlerID)
  • Task DetachAsync(int workspaceID, int objectTypeID, int eventHandlerID)
  • Task<List<EventHandlerResponse>> GetAttachedAsync(int workspaceID, int objectTypeID)
  • Task<List<EventHandlerResponse>> GetAvailableEventHandlersAsync(int workspaceID, int objectTypeID)
• public interface IEventHandlerModule

Relativity.Services.Interfaces.EventHandler.Models

• public enum EventHandlerExecution
  • Console = 1
  • ListPageInteraction = 2
  • PageInteraction = 3
  • PostCopy = 4
  • PostSave = 5
  • PreCascadeDelete = 6
  • PreCopy = 7
  • PreDelete = 8
  • PreLoad = 9
  • PreMassDelete = 10
  • PreSave = 11
  • Save = 12
• public class EventHandlerResponse
  • public DisplayableObjectIdentifier Application { get; set; }
  • public string AssemblyName { get; set; }
  • public string ClassName { get; set; }
  • public string CompanyName { get; set; }
  • public string Description { get; set; }
  • public EventHandlerExecution Execution { get; set; }
  • public int ID { get; set; }
  • public EventHandlerResponse()

Relativity.Services.Interfaces.MassOperation

• public interface IMassOperationManager : IDisposable
  • Task<int> CreateAsync(int workspaceID, CustomPageMassOperationRequest massOperationRequest)
  • Task<int> CreateAsync(int workspaceID, EventHandlerMassOperationRequest massOperationRequest)
  • Task DeleteAsync(int workspaceID, int massOperationID)
  • Task<List<MassOperationEventHandlerResponse>> GetAvailableEventHandlersAsync(int workspaceID)
  • Task<List<MassOperationLayoutResponse>> GetAvailableLayoutsAsync(int workspaceID, ObjectTypeIdentifier objectType)
  • Task<List<ObjectTypeIdentifier>> GetAvailableObjectTypeAsync(int workspaceID)
  • Task<MassOperationResponse> ReadMassOperationAsync(int workspaceID, int massOperationID)
  • Task<MassOperationResponse> ReadMassOperationAsync(int workspaceID, int massOperationID, bool includeMetadata, bool includeActions)
  • Task UpdateAsync(int workspaceID, int massOperationID, CustomPageMassOperationRequest massOperationRequest)
  • Task UpdateAsync(int workspaceID, int massOperationID, CustomPageMassOperationRequest massOperationRequest, DateTime lastModifiedOn)
  • Task UpdateAsync(int workspaceID, int massOperationID, EventHandlerMassOperationRequest massOperationRequest)
  • Task UpdateAsync(int workspaceID, int massOperationID, EventHandlerMassOperationRequest massOperationRequest, DateTime lastModifiedOn)
• public interface IMassOperationModule
• public class MassOperationConstants
  • public const string CUSTOM_PAGE_BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/custompagemassoperations"
  • public const string CUSTOM_PAGE_SERVICE_ROUTE = "custompagemassoperations"
  • public const string EVENT_HANDLER_BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/eventhandlermassoperations"
  • public const string EVENT_HANDLER_SERVICE_ROUTE = "eventhandlermassoperations"
  • public const string MASS_OPERATION_MODULE_NAME = "Mass Operation Module"
  • public MassOperationConstants()

Relativity.Services.Interfaces.MassOperation.Models

• public class CustomPageMassOperationRequest
  • public string Name { get; set; }
  • public Securable<ObjectTypeIdentifier> ObjectType { get; set; }
  • public int PopupHeight { get; set; }
  • public int PopupWidth { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public string Url { get; set; }
  • public CustomPageMassOperationRequest()
  • public CustomPageMassOperationRequest(MassOperationResponse response)
• public class EventHandlerMassOperationRequest
  • public int EventHandlerID { get; set; }
  • public Securable<ObjectIdentifier> Layout { get; set; }
  • public string Name { get; set; }
  • public Securable<ObjectTypeIdentifier> ObjectType { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public EventHandlerMassOperationRequest()
  • public EventHandlerMassOperationRequest(MassOperationResponse response)
• public class MassOperationEventHandlerResponse
  • public DisplayableObjectIdentifier Application { get; set; }
  • public string AssemblyName { get; set; }
  • public string ClassName { get; set; }
  • public string CompanyName { get; set; }
  • public string Description { get; set; }
  • public int EventHandlerID { get; set; }
  • public MassOperationEventHandlerResponse()
• public class MassOperationLayoutResponse : DisplayableObjectIdentifier
  • public string ObjectTypeName { get; set; }
  • public MassOperationLayoutResponse()
• public class MassOperationResponse : ObjectIdentifier
  • public List<Action> Actions { get; set; }
  • public string ApplicationName { get; set; }
  • public string ClassName { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public int EventHandlerID { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public Securable<DisplayableObjectIdentifier> Layout { get; set; }
  • public Meta Meta { get; set; }
  • public string Name { get; set; }
  • public Securable<DisplayableObjectIdentifier> ObjectType { get; set; }
  • public int PopupHeight { get; set; }
  • public int PopupWidth { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public MassOperationType Type { get; set; }
  • public string Url { get; set; }
  • public MassOperationResponse()
• public enum MassOperationType
  • CustomPageMassOperation = 1
  • EventHandlerMassOperation = 2

Relativity.Services.Interfaces.ObjectRules

• public interface IObjectRuleManager : IDisposable
  • Task<int> CreateChoiceBehaviorAsync(int workspaceID, ChoiceBehaviorRuleRequest objectRuleRequest)
  • Task<int> CreateCustomSingleObjectAddLinkVisibilityAsync(int workspaceID, CustomSingleObjectAddLinkVisibilityRuleRequest objectRuleRequest)
  • Task<int> CreateDefaultLayoutAsync(int workspaceID, DefaultLayoutRuleRequest objectRuleRequest)
  • Task<int> CreateDefaultLayoutOnNewAsync(int workspaceID, DefaultLayoutOnNewRuleRequest objectRuleRequest)
  • Task<int> CreateGlobalButtonVisibilityAsync(int workspaceID, GlobalButtonVisibilityRuleRequest objectRuleRequest)
  • Task<int> CreateMassActionVisibilityAsync(int workspaceID, MassActionVisibilityRuleRequest objectRuleRequest)
  • Task<int> CreateNewButtonOverrideAsync(int workspaceID, NewButtonOverrideRuleRequest objectRuleRequest)
  • Task<int> CreateOverrideEditLinkAsync(int workspaceID, OverrideEditLinkRuleRequest objectRuleRequest)
  • Task<int> CreateOverrideViewLinkAsync(int workspaceID, OverrideViewLinkRuleRequest objectRuleRequest)
  • Task<int> CreateSubListButtonVisibilityAsync(int workspaceID, SubListButtonVisibilityRuleRequest objectRuleRequest)
  • Task DeleteAsync(int workspaceID, int objectRuleID)
  • Task<List<ObjectTypeIdentifier>> GetAvailableAssociatedObjectsAsync(int workspaceID, int objectTypeID)
  • Task<List<ObjectTypeIdentifier>> GetAvailableAssociatedObjectsAsync(int workspaceID, ObjectTypeIdentifier objectTypeID)
  • Task<List<DisplayableObjectIdentifier>> GetAvailableChoiceFieldsAsync(int workspaceID, int objectTypeID)
  • Task<List<DisplayableObjectIdentifier>> GetAvailableChoiceFieldsAsync(int workspaceID, ObjectTypeIdentifier objectTypeID)
  • Task<List<DisplayableObjectIdentifier>> GetAvailableChoicesAsync(int workspaceID, int fieldID)
  • Task<List<DisplayableObjectIdentifier>> GetAvailableLayoutsAsync(int workspaceID, int objectTypeID)
  • Task<List<DisplayableObjectIdentifier>> GetAvailableLayoutsAsync(int workspaceID, ObjectTypeIdentifier objectTypeID)
  • Task<List<DisplayableObjectIdentifier>> GetAvailableSingleChoiceFieldsAsync(int workspaceID, int objectTypeID)
  • Task<List<DisplayableObjectIdentifier>> GetAvailableSingleChoiceFieldsAsync(int workspaceID, ObjectTypeIdentifier objectTypeID)
  • Task<ObjectRuleResponse> ReadAsync(int workspaceID, int objectRuleID)
  • Task<ObjectRuleResponse> ReadAsync(int workspaceID, int objectRuleID, bool includeMetadata, bool includeActions)
  • Task UpdateChoiceBehaviorAsync(int workspaceID, int objectRuleID, ChoiceBehaviorRuleRequest objectRuleRequest)
  • Task UpdateChoiceBehaviorAsync(int workspaceID, int objectRuleID, ChoiceBehaviorRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateCustomSingleObjectAddLinkVisibilityAsync(int workspaceID, int objectRuleID, CustomSingleObjectAddLinkVisibilityRuleRequest objectRuleRequest)
  • Task UpdateCustomSingleObjectAddLinkVisibilityAsync(int workspaceID, int objectRuleID, CustomSingleObjectAddLinkVisibilityRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateDefaultLayoutAsync(int workspaceID, int objectRuleID, DefaultLayoutRuleRequest objectRuleRequest)
  • Task UpdateDefaultLayoutAsync(int workspaceID, int objectRuleID, DefaultLayoutRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateDefaultLayoutOnNewAsync(int workspaceID, int objectRuleID, DefaultLayoutOnNewRuleRequest objectRuleRequest)
  • Task UpdateDefaultLayoutOnNewAsync(int workspaceID, int objectRuleID, DefaultLayoutOnNewRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateGlobalButtonVisibilityAsync(int workspaceID, int objectRuleID, GlobalButtonVisibilityRuleRequest objectRuleRequest)
  • Task UpdateGlobalButtonVisibilityAsync(int workspaceID, int objectRuleID, GlobalButtonVisibilityRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateMassActionVisibilityAsync(int workspaceID, int objectRuleID, MassActionVisibilityRuleRequest objectRuleRequest)
  • Task UpdateMassActionVisibilityAsync(int workspaceID, int objectRuleID, MassActionVisibilityRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateNewButtonOverrideAsync(int workspaceID, int objectRuleID, NewButtonOverrideRuleRequest objectRuleRequest)
  • Task UpdateNewButtonOverrideAsync(int workspaceID, int objectRuleID, NewButtonOverrideRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateOverrideEditLinkAsync(int workspaceID, int objectRuleID, OverrideEditLinkRuleRequest objectRuleRequest)
  • Task UpdateOverrideEditLinkAsync(int workspaceID, int objectRuleID, OverrideEditLinkRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateOverrideViewLinkAsync(int workspaceID, int objectRuleID, OverrideViewLinkRuleRequest objectRuleRequest)
  • Task UpdateOverrideViewLinkAsync(int workspaceID, int objectRuleID, OverrideViewLinkRuleRequest objectRuleRequest, DateTime lastModifiedOn)
  • Task UpdateSubListButtonVisibilityAsync(int workspaceID, int objectRuleID, SubListButtonVisibilityRuleRequest objectRuleRequest)
  • Task UpdateSubListButtonVisibilityAsync(int workspaceID, int objectRuleID, SubListButtonVisibilityRuleRequest objectRuleRequest, DateTime lastModifiedOn)
• public interface IObjectRuleModule
• public class ObjectRuleConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}"
  • public const string MODULE_PREFIX = "Relativity.ObjectRules"
  • public ObjectRuleConstants()

Relativity.Services.Interfaces.ObjectRules.Models

• public class BaseObjectRuleRequest
  • public string Name { get; set; }
  • public ObjectTypeIdentifier ObjectType { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public BaseObjectRuleRequest()
• public class ChoiceBehaviorRuleRequest : BaseObjectRuleRequest
  • public bool AllowAdd { get; set; }
  • public bool AllowDelete { get; set; }
  • public bool AllowRename { get; set; }
  • public Securable<ObjectIdentifier> Field { get; set; }
  • public ChoiceBehaviorRuleRequest()
• public class CustomSingleObjectAddLinkVisibilityRuleRequest : BaseObjectRuleRequest
  • public bool ShowAddLink { get; set; }
  • public CustomSingleObjectAddLinkVisibilityRuleRequest()
• public class DefaultLayoutOnNewRuleRequest : BaseObjectRuleRequest
  • public Securable<ObjectIdentifier> Layout { get; set; }
  • public DefaultLayoutOnNewRuleRequest()
• public class DefaultLayoutRuleRequest : BaseObjectRuleRequest
  • public bool AllowLayoutChange { get; set; }
  • public Securable<ObjectIdentifier> Choice { get; set; }
  • public Securable<ObjectIdentifier> Field { get; set; }
  • public Securable<ObjectIdentifier> Layout { get; set; }
  • public DefaultLayoutRuleRequest()
• public class GlobalButtonVisibilityRuleRequest : BaseObjectRuleRequest
  • public bool ShowDelete { get; set; }
  • public bool ShowLink { get; set; }
  • public bool ShowNew { get; set; }
  • public bool ShowUnlink { get; set; }
  • public GlobalButtonVisibilityRuleRequest()
• public class MassActionVisibilityRuleRequest : BaseObjectRuleRequest
  • public bool ShowMassCopy { get; set; }
  • public bool ShowMassEdit { get; set; }
  • public bool ShowMassReplace { get; set; }
  • public bool ShowMassTally { get; set; }
  • public MassActionVisibilityRuleRequest()
• public class NewButtonOverrideRuleRequest : BaseObjectRuleRequest
  • public string Url { get; set; }
  • public NewButtonOverrideRuleRequest()
• public enum ObjectRuleBehavior
  • ChoiceBehavior = 6
  • CustomSingleObjectAddLinkVisibility = 1
  • DefaultLayout = 0
  • DefaultLayoutOnNew = 2
  • GlobalButtonVisibility = 3
  • MassActionVisbility = 4
  • NewButtonOverride = 5
  • OverrideEditLink = 9
  • OverrideViewLink = 8
  • SubListButtonVisibility = 7
• public class ObjectRuleResponse : DisplayableObjectIdentifier
  • public List<Action> Actions { get; set; }
  • public bool AllowAdd { get; set; }
  • public bool AllowDelete { get; set; }
  • public bool AllowLayoutChange { get; set; }
  • public bool AllowRename { get; set; }
  • public ObjectRuleBehavior Behavior { get; set; }
  • public Securable<DisplayableObjectIdentifier> Choice { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public Securable<DisplayableObjectIdentifier> Field { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public Securable<DisplayableObjectIdentifier> Layout { get; set; }
  • public Meta Meta { get; set; }
  • public ObjectTypeIdentifier ObjectType { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public bool ShowAddLink { get; set; }
  • public bool ShowDelete { get; set; }
  • public bool ShowLink { get; set; }
  • public bool ShowMassCopy { get; set; }
  • public bool ShowMassEdit { get; set; }
  • public bool ShowMassReplace { get; set; }
  • public bool ShowMassTally { get; set; }
  • public bool ShowNew { get; set; }
  • public bool ShowUnlink { get; set; }
  • public Securable<ObjectTypeIdentifier> SubListObject { get; set; }
  • public string Url { get; set; }
  • public ObjectRuleResponse()
• public class OverrideEditLinkRuleRequest : BaseObjectRuleRequest
  • public string Url { get; set; }
  • public OverrideEditLinkRuleRequest()
• public class OverrideViewLinkRuleRequest : BaseObjectRuleRequest
  • public string Url { get; set; }
  • public OverrideViewLinkRuleRequest()
• public class SubListButtonVisibilityRuleRequest : BaseObjectRuleRequest
  • public Securable<ObjectIdentifier> Choice { get; set; }
  • public Securable<ObjectIdentifier> Field { get; set; }
  • public bool ShowDelete { get; set; }
  • public bool ShowLink { get; set; }
  • public bool ShowNew { get; set; }
  • public bool ShowUnlink { get; set; }
  • public Securable<ObjectTypeIdentifier> SubListObject { get; set; }
  • public SubListButtonVisibilityRuleRequest()

Relativity.Services.Interfaces.ObjectType

• public interface IObjectTypeManager : IDisposable
  • Task<int> CreateAsync(int workspaceID, ObjectTypeRequest objectTypeRequest)
  • Task DeleteAsync(int workspaceID, int objectTypeID)
  • Task<List<ObjectTypeIdentifier>> GetAvailableParentObjectTypesAsync(int workspaceID)
  • Task<List<Dependency>> GetDependencyList(int workspaceID, int objectTypeID)
  • Task<ObjectTypeResponse> ReadAsync(int workspaceID, int objectTypeID)
  • Task<ObjectTypeResponse> ReadAsync(int workspaceID, int objectTypeID, bool includeMetadata, bool includeActions)
  • Task UpdateAsync(int workspaceID, int objectTypeID, ObjectTypeRequest objectTypeRequest)
  • Task UpdateAsync(int workspaceID, int objectTypeID, ObjectTypeRequest objectTypeRequest, DateTime lastModifiedOn)
• public interface IObjectTypeModule
• public class ObjectTypeConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/objecttypes"
  • public const string MODULE_PREFIX = "Relativity.ObjectTypes"
  • public const string OBJECT_TYPE_ID = "objectTypeID"
  • public const string SERVICE_MODULE_NAME = "Object Type Module"
  • public const string SERVICE_NAME = "Object Type Manager"
  • public const string SERVICE_ROUTE = "objecttypes"
  • public ObjectTypeConstants()

Relativity.Services.Interfaces.ObjectType.Models

• public class ObjectTypeRequest
  • public bool CopyInstancesOnCaseCreation { get; set; }
  • public bool CopyInstancesOnParentCopy { get; set; }
  • public bool EnableSnapshotAuditingOnDelete { get; set; }
  • public string Keywords { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public Securable<ObjectTypeIdentifier> ParentObjectType { get; set; }
  • public bool PersistentListsEnabled { get; set; }
  • public bool PivotEnabled { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public bool SamplingEnabled { get; set; }
  • public bool? UseRelativityForms { get; set; }
  • public ObjectTypeRequest()
• public class ObjectTypeResponse : DisplayableObjectIdentifier
  • public List<Action> Actions { get; set; }
  • public int ArtifactTypeID { get; set; }
  • public bool CopyInstancesOnCaseCreation { get; set; }
  • public bool CopyInstancesOnParentCopy { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public bool EnableSnapshotAuditingOnDelete { get; set; }
  • public int FieldByteUsage { get; set; }
  • public bool IsDynamic { get; set; }
  • public bool IsSystem { get; set; }
  • public bool IsViewEnabled { 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> ParentObjectType { get; set; }
  • public bool PersistentListsEnabled { get; set; }
  • public bool PivotEnabled { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public bool SamplingEnabled { get; set; }
  • public bool? UseRelativityForms { get; set; }
  • public ObjectTypeResponse()

Relativity.Services.Interfaces.SearchProvider

• public interface ISearchProviderManager : IDisposable
  • Task<int> CreateAsync(int workspaceID, SearchProviderRequest searchProvider)
  • Task DeleteAsync(int workspaceID, int searchProviderArtifactID)
  • Task<List<Dependency>> GetDependencyList(int workspaceID, int searchProviderArtifactID)
  • Task<SearchProviderResponse> ReadAsync(int workspaceID, int searchProviderArtifactID, bool includeMetadata, bool includeActions)
  • Task<SearchProviderResponse> ReadAsync(int workspaceID, int searchProviderArtifactID)
  • Task UpdateAsync(int workspaceID, int searchProviderArtifactID, SearchProviderRequest searchProvider)
• public interface ISearchProviderModule
• public class SearchProviderConstants
  • public const string MODULE_PREFIX = "Relativity.SearchProviders"
  • public const string SERVICE_ROUTE = "searchproviders"
  • public SearchProviderConstants()

Relativity.Services.Interfaces.SearchProvider.Models

• public class SearchProviderDTO
  • public bool Active { get; set; }
  • public int ArtifactID { get; set; }
  • public bool AvailableForSearching { get; set; }
  • public string DLL { get; set; }
  • public int MaxRank { get; set; }
  • public int MinRank { get; set; }
  • public string Name { get; set; }
  • public int Order { get; set; }
  • public string Parameters { get; set; }
  • public int RankCacheMultiplier { get; set; }
  • public SearchProviderDTO()
• public class SearchProviderRequest
  • public bool Active { get; set; }
  • public int ArtifactID { get; set; }
  • public bool AvailableForSearching { get; set; }
  • public string DLL { get; set; }
  • public int MaxRank { get; set; }
  • public int MinRank { get; set; }
  • public string Name { get; set; }
  • public int Order { get; set; }
  • public string Parameters { get; set; }
  • public int RankCacheMultiplier { get; set; }
  • public SearchProviderRequest()
• public class SearchProviderResponse
  • public bool Active { get; set; }
  • public int ArtifactID { get; set; }
  • public bool AvailableForSearching { get; set; }
  • public string DLL { get; set; }
  • public int MaxRank { get; set; }
  • public int MinRank { get; set; }
  • public string Name { get; set; }
  • public int Order { get; set; }
  • public string Parameters { get; set; }
  • public int RankCacheMultiplier { get; set; }
  • public SearchProviderResponse()

Relativity.Services.Interfaces.Shared

• public class Dependency
  • public string Action { get; set; }
  • public Securable<string> Connection { get; set; }
  • public Securable<int?> Count { get; set; }
  • public int HierarchicLevel { get; set; }
  • public Securable<string> ObjectType { get; set; }
  • public Dependency()
• public class NameIDPair
  • public int ID { get; set; }
  • public string Name { get; set; }
  • public NameIDPair()
• public class Securable<T>
  • public bool Secured { get; set; }
  • public T Value { get; set; }
  • public Securable()
  • public Securable(T value)
  • public static T op_Explicit(Securable<T> value)
  • public static Securable<T> op_Implicit(T value)
• public class SecurableList<T>
  • public bool HasSecuredItems { get; set; }
  • public List<T> ViewableItems { get; set; }
  • public SecurableList()
  • public SecurableList(bool hasSecuredItems, List<T> viewableItems)

Relativity.Services.Interfaces.Shared.Constants

• public static class RouteConstants
  • public const string WORKSPACE_ROUTE = "workspace"

Relativity.Services.Interfaces.Shared.Models

• public class Action
  • public string Href { get; set; }
  • public bool IsAvailable { get; set; }
  • public string Name { get; set; }
  • public List<string> Reason { get; set; }
  • public string Verb { get; set; }
  • public Action()
• public class DisplayableObjectIdentifier : ObjectIdentifier
  • public string Name { get; set; }
  • public DisplayableObjectIdentifier()
• public class Meta
  • public List<string> ReadOnly { get; set; }
  • public List<string> Unsupported { get; set; }
  • public Meta()
• public class ObjectIdentifier
  • public int ArtifactID { get; set; }
  • public List<Guid> Guids { get; set; }
  • public ObjectIdentifier()
• public class ObjectTypeIdentifier : ObjectIdentifier
  • public int ArtifactTypeID { get; set; }
  • public string Name { get; set; }
  • public ObjectTypeIdentifier()

Relativity.Services.Interfaces.SystemArtifact

• public interface ISystemArtifactManager : IDisposable
  • Task<int> ReadArtifactIDAsync(int workspaceID, string identifier)
  • Task<int> ReadArtifactTypeIDAsync(int workspaceID, string identifier)
• public interface ISystemArtifactModule

Relativity.Services.Interfaces.Tab

• public interface ITabManager : IDisposable
  • Task<int> CreateAsync(int workspaceID, TabRequest tab)
  • Task DeleteAsync(int workspaceID, int tabID)
  • Task<List<NameIDPair>> GetAvailableObjectTypesAsync(int workspaceID)
  • Task<List<NameIDPair>> GetAvailableObjectTypesAsync(int workspaceID, int tabID)
  • Task<List<NameIDPair>> GetAvailableParentsAsync(int workspaceID)
  • Task<List<Dependency>> GetDependencyList(int workspaceID, int tabID)
  • Task<Meta> GetMetaAsync(int workspaceID)
  • Task<List<TabViewOrder>> GetViewOrderList(int workspaceID)
  • Task<TabResponse> ReadAsync(int workspaceID, int tabID, bool includeMetadata, bool includeActions)
  • Task<TabResponse> ReadAsync(int workspaceID, int tabID)
  • Task UpdateAsync(int workspaceID, TabRequest tab)
  • Task UpdateAsync(int workspaceID, TabRequest tab, DateTime lastModifiedOn)
• public interface ITabModule
• public class TabRouteConstants
  • public const string TAB_MODULE = "Relativity.Tabs"
  • public const string TAB_ROUTE = "tabs"
  • public TabRouteConstants()

Relativity.Services.Interfaces.Tab.Models

• public enum TabLinkTypeEnum
  • Link = 2
  • Object = 1
  • Parent = 3
  • Unknown = 0
• public class TabRequest
  • public int ArtifactID { get; set; }
  • public bool? IsDefault { get; set; }
  • public bool IsVisible { get; set; }
  • public string Link { get; set; }
  • public TabLinkTypeEnum LinkType { get; set; }
  • public string Name { get; set; }
  • public Securable<RelativityObjectRef> ObjectArtifactTypeID { get; set; }
  • public int Order { get; set; }
  • public Securable<RelativityObjectRef> ParentID { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public TabRequest()
• public class TabResponse
  • public List<Action> Actions { get; set; }
  • public int ArtifactID { get; set; }
  • public NameIDPair CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public bool? IsDefault { get; set; }
  • public bool IsVisible { get; set; }
  • public NameIDPair LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public string Link { get; set; }
  • public TabLinkTypeEnum LinkType { get; set; }
  • public Meta Meta { get; set; }
  • public string Name { get; set; }
  • public Securable<NameIDPair> ObjectType { get; set; }
  • public int Order { get; set; }
  • public Securable<NameIDPair> Parent { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public TabResponse()
• public class TabViewOrder
  • public int ArtifactID { get; set; }
  • public string Name { get; set; }
  • public int Order { get; set; }
  • public string Parent { get; set; }
  • public int ParentArtifactID { get; set; }
  • public TabViewOrder()

Relativity.Services.Interfaces.UserInfo

• public interface IUserInfoManager : IDisposable
  • Task<List<UserInfo>> RetrieveAll(int workspaceID)
  • Task<UserInfoQueryResultSet> RetrieveUsersBy(int workspaceID, QueryRequest query, int start, int length)
• public interface IUserInfoModule
• public class UserConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/users"
  • public const string MODULE_PREFIX = "Relativity.Users"
  • public const string SERVICE_MODULE_NAME = "UserInfo Module"
  • public const string SERVICE_NAME = "UserInfo Manager"
  • public const string SERVICE_ROUTE_POSTFIX = "users"
  • public UserConstants()

Relativity.Services.Interfaces.UserInfo.Models

• public class UserInfo
  • public int ArtifactID { get; set; }
  • public string Email { get; set; }
  • public string FullName { get; set; }
  • public UserInfo()
• public class UserInfoQueryResultSet
  • public int CurrentStartIndex { get; set; }
  • public IEnumerable<UserInfo> DataResults { get; set; }
  • public int ResultCount { get; set; }
  • public int TotalResultCount { get; set; }
  • public UserInfoQueryResultSet()

Relativity.Services.ItemListView

• public class PermissionResultSet
  • public bool CommunicationAnalysisWidget { get; set; }

Relativity.Services.KeyboardShortcuts

• public interface IKeyboardShortcutsManager : IDisposable
  • Task<List<KeyboardShortcutInformation>> GetKeyboardShortcuts(int workspaceID)
  • Task<List<KeyboardShortcutInformation>> GetKeyboardShortcuts(int workspaceID, KeyboardShortcutsRequest requestOptions)
• public interface IKeyboardShortcutsModule

Relativity.Services.KeyboardShortcuts.Models

• public class KeyboardShortcutInformation
  • public string Action { get; set; }
  • public int? ArtifactID { get; set; }
  • public int KeyboardShortcutID { get; set; }
  • public KeyCombination KeyCombination { get; set; }
  • public string Type { get; set; }
  • public KeyboardShortcutInformation()
• public class KeyboardShortcutsRequest
  • public bool? IncludeChoiceShortcuts { get; set; }
  • public bool? IncludeFieldShortcuts { get; set; }
  • public bool? IncludeSystemShortcuts { get; set; }
  • public KeyboardShortcutsRequest()
• public class KeyCombination
  • public bool Alt { get; set; }
  • public bool Ctrl { get; set; }
  • public int Key { get; set; }
  • public bool Shift { get; set; }
  • public KeyCombination(bool shift, bool ctrl, bool alt, int key)

Relativity.Services.Notifications

• public class MOTDRef
  • public bool AllowDismiss { get; set; }

Relativity.Services.Objects

• public class ObjectRef
  • public bool ItemSecured { get; set; }
• public interface IObjectManager : IDisposable
  • Task<List<Dependency>> GetDependencyListAsync(int workspaceID, DependencyListByObjectIdentifiersRequest request)

Relativity.Services.Objects.DataContracts

• public class DependencyListByObjectIdentifiersRequest
  • public IEnumerable<RelativityObjectRef> Objects { get; set; }
  • public DependencyListByObjectIdentifiersRequest()
• public enum FieldUpdateBehavior
  • Remove = 2
• public class ReadOptions : OperationOptions
  • public IEnumerable<FieldType> FieldTypesToReturnAsString { get; set; }
• public class ReadResult
  • public string ObjectVersionToken { get; set; }
• public class RelativityObjectValue : IHasArtifactID, IHasIdentifyingInformation, IHasGuids, IHasName
  • public bool ItemSecured { get; set; }
• public class SecuredReflectedFieldValue
  • public bool ItemSecured { get; set; }
  • public SecuredReflectedFieldValue()
• public class UpdateRequest
  • public string ObjectVersionToken { get; set; }

Relativity.Services.Permission

• public interface IPermissionManager : IDisposable
  • Task<bool> IsUserInWorkspaceGroupAsync(int workspaceArtifactID, UserRef user, GroupRef group)

Relativity.Services.Pipeline

• public interface IKeplerServiceFactory
  • T GetClient<T>() where T : IDisposable

Relativity.Services.Pivot

• public class PivotSettings
  • public bool? ConvertNumberFieldValuesToString { get; set; }

Relativity.Services.Proxy.LRP

• public class KeplerLRPClientV2 : IKeplerClient, IDisposable
  • public KeplerLRPClientV2(ProxySettings proxySettings, string moduleAndServiceUrlFragment, JsonSerializerSettings serializerSettings)
  • public KeplerLRPClientV2(ProxySettings proxySettings, string moduleAndServiceUrlFragment, JsonSerializerSettings serializerSettings, ILog logger)

Relativity.Services.ResourceServer

• public class CacheLocationResourceServer : ResourceServerRef
  • public bool? IsVisible { get; set; }
• public class FileShareResourceServer : ResourceServerRef
  • public bool? IsVisible { get; set; }
• public class ResourceServer : ResourceServerRef
  • public string FriendlyName { get; set; }
  • public bool? IsVisible { get; set; }

Relativity.Services.Review.DynamicReviewQueue

• public class DocumentSqlView
  • public int DocumentCount { get; set; }
  • public string DocumentIdColumnName { get; set; }
  • public string Name { get; set; }
  • public string Schema { get; set; }
  • public DocumentSqlView()
• public class DynamicReviewQueuesView

Relativity.Services.ServiceProxy

• public interface IServiceFactory
  • T CreateProxy<T>() where T : IDisposable

Relativity.Services.StaticObject

• public class StartupInfoResultSet
  • public Dictionary<string, bool> Toggles { get; set; }

Relativity.Services.SystemArtifact

• public class SystemArtifactConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/systemartifacts"
  • public const string MODULE_PREFIX = "Relativity.SystemArtifacts"
  • public const string SERVICE_MODULE_NAME = "System Artifacts Module"
  • public const string SERVICE_ROUTE = "systemartifacts"
  • public SystemArtifactConstants()

Relativity.Services.User

• public interface IUserManager : IDisposable
  • Task<WorkspaceUserData> RetrieveAllActiveWithLimitAsync(int workspaceId, bool includeCurrentUser)

Relativity.Services.Workspace

• public class WorkspaceSetttings
  • public int? ClientArtifactId { get; set; }
  • public List<int> CredentialArtifactIDs { get; set; }
  • public int? DefaultCacheLocationServerArtifactId { get; set; }
  • public int? DefaultDataGridLocationCodeArtifactId { get; set; }
  • public int? DefaultFileLocationCodeArtifactId { get; set; }
  • public string DownloadHandlerApplicationPath { get; set; }
  • public bool? EnableDataGrid { get; set; }
  • public int? MatterArtifactId { get; set; }
  • public string Name { get; set; }
  • public int? ResourceGroupArtifactId { get; set; }
  • public int? RootFolderId { get; set; }
  • public int? ServerId { get; set; }
  • public int? SqlFullTextLcid { get; set; }
  • public int? StatusCodeArtifactId { get; set; }
  • public int TemplateArtifactId { get; set; }
  • public int? WorkspaceAdminGroupId { get; set; }
  • public WorkspaceSetttings()