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

---

API Differences between 10.2.99.73 and 10.0.199.13

948 Additions 39 Removals

Relativity.Services.DataContracts.DTOs.EmailNotifications

• public class EmailNotificationRequest
  • public string Body { get; set; }
  • public bool IsBodyHtml { get; set; }
  • public IEnumerable<string> Recipients { get; set; }
  • public string Sender { get; set; }
  • public string Subject { get; set; }
  • public EmailNotificationRequest()
• public class EmailNotificationResponse
  • public IEnumerable<EmailNotificationStatus> EmailNotifications { get; set; }
  • public EmailNotificationResponse()
• public class EmailNotificationStatus
  • public bool IsSent { get; set; }
  • public string Message { get; set; }
  • public string Recipient { get; set; }
  • public EmailNotificationStatus()

Relativity.Services.EmailNotificationsManager

• public interface IEmailNotificationsManager : IDisposable
  • Task<EmailNotificationResponse> SendEmailNotificationAsync(EmailNotificationRequest request)
• public interface IEmailNotificationsModule

Relativity.Services.Interfaces.Agent

• public interface IAgentManager : IDisposable
  • Task<List<int>> CreateAsync(int workspaceID, AgentRequest agentRequest, int count)

Relativity.Services.Interfaces.Agent.Models

• public class AgentInstanceLimitResult
  • public Securable<ObjectIdentifier> AgentServer { get; set; }
  • public Securable<DisplayableObjectIdentifier> AgentServer { get; set; }
  • public Securable<ObjectIdentifier> ResourcePool { get; set; }
  • public Securable<DisplayableObjectIdentifier> ResourcePool { get; set; }
• public class AgentResponse : DisplayableObjectIdentifier
  • public Securable<ObjectIdentifier> AgentServer { get; set; }
  • public Securable<ObjectIdentifier> AgentType { get; set; }
  • public ObjectIdentifier CreatedBy { get; set; }
  • public Securable<DisplayableObjectIdentifier> AgentServer { get; set; }
  • public Securable<DisplayableObjectIdentifier> AgentType { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public ObjectIdentifier LastModifiedBy { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
• public class AgentTypeResponse : DisplayableObjectIdentifier
  • public Guid AgentTypeGuid { get; set; }

Relativity.Services.Interfaces.Choice

• public static class ChoiceConstants
  • public const string CHOICE_ROUTE = "choice"
• public interface IChoiceManager : IDisposable
  • Task<int> CreateAsync(int workspaceID, ChoiceRequest choiceRequest)
  • Task DeleteAsync(int workspaceID, int choiceID)
  • Task DeleteAsync(int workspaceID, Guid choiceGuid)
  • Task<List<ObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID)
  • Task<List<ObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, int choiceID)
  • Task<List<ObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, Guid choiceGuid)
  • Task<List<NameIDPair>> GetColorsListAsync(int workspaceID)
  • Task<ChoiceResponse> ReadAsync(int workspaceID, int choiceID)
  • Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid)
  • Task<ChoiceResponse> ReadAsync(int workspaceID, int choiceID, bool includeActions)
  • Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid, bool includeActions)
  • Task UpdateAsync(int workspaceID, int choiceID, ChoiceRequest choiceRequest)
  • Task UpdateAsync(int workspaceID, int choiceID, ChoiceRequest choiceRequest, string objectVersionToken)
  • Task UpdateAsync(int workspaceID, Guid choiceGuid, ChoiceRequest choiceRequest)
  • Task UpdateAsync(int workspaceID, Guid choiceGuid, ChoiceRequest choiceRequest, string objectVersionToken)
• public interface IChoiceModule

Relativity.Services.Interfaces.Choice.Models

• public class ChoiceRequest
  • public int Color { get; set; }
  • public ObjectIdentifier Field { get; set; }
  • public KeyboardShortcutCombination KeyboardShortcut { get; set; }
  • public string Keywords { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public int Order { get; set; }
  • public ObjectIdentifier Parent { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public ChoiceRequest()
• public class ChoiceResponse : DisplayableObjectIdentifier
  • public List<Action> Actions { get; set; }
  • public NameIDPair Color { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public DisplayableObjectIdentifier Field { get; set; }
  • public KeyboardShortcutCombination KeyboardShortcut { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public string Notes { get; set; }
  • public string ObjectVersionToken { get; set; }
  • public int Order { get; set; }
  • public ObjectIdentifier Parent { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public ChoiceResponse()

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 int ArtifactID { 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.EventHandler.ObjectType

• public interface IEventHandlerManager

Relativity.Services.Interfaces.Field

• public class FieldConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}"
  • public const string MODULE_PREFIX = "Relativity.Fields"
  • public FieldConstants()
• public interface IFieldManager : IDisposable
  • Task<int> CreateCurrencyFieldAsync(int workspaceID, CurrencyFieldRequest fieldRequest)
  • Task<int> CreateDateFieldAsync(int workspaceID, DateFieldRequest fieldRequest)
  • Task<int> CreateDecimalFieldAsync(int workspaceID, DecimalFieldRequest fieldRequest)
  • Task<int> CreateFileFieldAsync(int workspaceID, FileFieldRequest fieldRequest)
  • Task<int> CreateFixedLengthFieldAsync(int workspaceID, FixedLengthFieldRequest fieldRequest)
  • Task<int> CreateLongTextFieldAsync(int workspaceID, LongTextFieldRequest fieldRequest)
  • Task<int> CreateMultipleChoiceFieldAsync(int workspaceID, MultipleChoiceFieldRequest fieldRequest)
  • Task<int> CreateMultipleObjectFieldAsync(int workspaceID, MultipleObjectFieldRequest fieldRequest)
  • Task<int> CreateSingleChoiceFieldAsync(int workspaceID, SingleChoiceFieldRequest fieldRequest)
  • Task<int> CreateSingleObjectFieldAsync(int workspaceID, SingleObjectFieldRequest fieldRequest)
  • Task<int> CreateUserFieldAsync(int workspaceID, UserFieldRequest fieldRequest)
  • Task<int> CreateWholeNumberFieldAsync(int workspaceID, WholeNumberFieldRequest fieldRequest)
  • Task<int> CreateYesNoFieldAsync(int workspaceID, YesNoFieldRequest fieldRequest)
  • Task DeleteAsync(int workspaceID, int fieldID)
  • Task<List<KeyboardShortcut>> GetAvailableKeyboardShortcutsAsync(int workspaceID)
  • Task<List<ObjectTypeIdentifier>> GetAvailableMultiAssociativeObjectTypesAsync(int workspaceID, ObjectTypeIdentifier objectType)
  • Task<List<ObjectTypeIdentifier>> GetAvailableObjectTypesAsync(int workspaceID)
  • Task<List<Securable<DisplayableObjectIdentifier>>> GetAvailableObjectTypeViewsAsync(int workspaceID, ObjectTypeIdentifier objectType)
  • Task<List<DisplayableObjectIdentifier>> GetAvailablePropagateToFieldsAsync(int workspaceID)
  • Task<List<ObjectTypeIdentifier>> GetAvailableSingleAssociativeObjectTypesAsync(int workspaceID, ObjectTypeIdentifier objectType)
  • Task<List<string>> GetValidKeys(int workspaceID)
  • Task<FieldResponse> ReadAsync(int workspaceID, int fieldID)
  • Task<FieldResponse> ReadAsync(int workspaceID, int fieldID, bool includeMetadata, bool includeActions)
  • Task UpdateCurrencyFieldAsync(int workspaceID, int fieldID, CurrencyFieldRequest fieldRequest)
  • Task UpdateCurrencyFieldAsync(int workspaceID, int fieldID, CurrencyFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateDateFieldAsync(int workspaceID, int fieldID, DateFieldRequest fieldRequest)
  • Task UpdateDateFieldAsync(int workspaceID, int fieldID, DateFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateDecimalFieldAsync(int workspaceID, int fieldID, DecimalFieldRequest fieldRequest)
  • Task UpdateDecimalFieldAsync(int workspaceID, int fieldID, DecimalFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateFileFieldAsync(int workspaceID, int fieldID, FileFieldRequest fieldRequest)
  • Task UpdateFileFieldAsync(int workspaceID, int fieldID, FileFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateFixedLengthFieldAsync(int workspaceID, int fieldID, FixedLengthFieldRequest fieldRequest)
  • Task UpdateFixedLengthFieldAsync(int workspaceID, int fieldID, FixedLengthFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateLongTextFieldAsync(int workspaceID, int fieldID, LongTextFieldRequest fieldRequest)
  • Task UpdateLongTextFieldAsync(int workspaceID, int fieldID, LongTextFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateMultipleChoiceFieldAsync(int workspaceID, int fieldID, MultipleChoiceFieldRequest fieldRequest)
  • Task UpdateMultipleChoiceFieldAsync(int workspaceID, int fieldID, MultipleChoiceFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateMultipleObjectFieldAsync(int workspaceID, int fieldID, MultipleObjectFieldRequest fieldRequest)
  • Task UpdateMultipleObjectFieldAsync(int workspaceID, int fieldID, MultipleObjectFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateSingleChoiceFieldAsync(int workspaceID, int fieldID, SingleChoiceFieldRequest fieldRequest)
  • Task UpdateSingleChoiceFieldAsync(int workspaceID, int fieldID, SingleChoiceFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateSingleObjectFieldAsync(int workspaceID, int fieldID, SingleObjectFieldRequest fieldRequest)
  • Task UpdateSingleObjectFieldAsync(int workspaceID, int fieldID, SingleObjectFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateUserFieldAsync(int workspaceID, int fieldID, UserFieldRequest fieldRequest)
  • Task UpdateUserFieldAsync(int workspaceID, int fieldID, UserFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateWholeNumberFieldAsync(int workspaceID, int fieldID, WholeNumberFieldRequest fieldRequest)
  • Task UpdateWholeNumberFieldAsync(int workspaceID, int fieldID, WholeNumberFieldRequest fieldRequest, DateTime lastModifiedOn)
  • Task UpdateYesNoFieldAsync(int workspaceID, int fieldID, YesNoFieldRequest fieldRequest)
  • Task UpdateYesNoFieldAsync(int workspaceID, int fieldID, YesNoFieldRequest fieldRequest, DateTime lastModifiedOn)
• public interface IFieldModule

Relativity.Services.Interfaces.Field.Models

• public class BaseFieldRequest
  • public bool AllowGroupBy { get; set; }
  • public bool AllowPivot { get; set; }
  • public FilterType FilterType { get; set; }
  • public bool IsLinked { get; set; }
  • public bool IsRequired { get; set; }
  • public string Keywords { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public ObjectTypeIdentifier ObjectType { get; set; }
  • public List<ObjectIdentifier> PropagateTo { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public int? Width { get; set; }
  • public BaseFieldRequest()
• public class CurrencyFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool CTRL { get; set; }
  • public string Key { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public CurrencyFieldRequest()
• public class DateFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool CTRL { get; set; }
  • public Formatting Formatting { get; set; }
  • public string Key { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public DateFieldRequest()
• public class DecimalFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool CTRL { get; set; }
  • public Formatting Formatting { get; set; }
  • public string Key { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public DecimalFieldRequest()
• public class FieldResponse : DisplayableObjectIdentifier
  • public List<Action> Actions { get; set; }
  • public bool AllowGroupBy { get; set; }
  • public bool AllowHtml { get; set; }
  • public bool AllowPivot { get; set; }
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public ObjectTypeIdentifier AssociativeObjectType { get; set; }
  • public bool AutoAddChoices { get; set; }
  • public bool AvailableInFieldTree { get; set; }
  • public bool AvailableInViewer { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public bool CTRL { get; set; }
  • public string DisplayValueFalse { get; set; }
  • public string DisplayValueTrue { get; set; }
  • public bool EnableDataGrid { get; set; }
  • public Securable<DisplayableObjectIdentifier> FieldTreeView { get; set; }
  • public FieldType FieldType { get; set; }
  • public FilterType FilterType { get; set; }
  • public Formatting Formatting { get; set; }
  • public bool HasUnicode { get; set; }
  • public bool IncludeInTextIndex { get; set; }
  • public bool IsIdentifier { get; set; }
  • public bool IsLinked { get; set; }
  • public bool IsRequired { get; set; }
  • public string Key { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public int Length { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public ObjectTypeIdentifier ObjectType { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public OverlayBehavior OverlayBehavior { get; set; }
  • public Securable<DisplayableObjectIdentifier> PopupPickerView { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> PropagateTo { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public bool SHIFT { get; set; }
  • public int? Width { get; set; }
  • public bool Wrapping { get; set; }
  • public FieldResponse()
• public enum FieldType
  • Currency = 9
  • Date = 5
  • Decimal = 8
  • File = 6
  • FixedLength = 2
  • LongText = 3
  • MultipleChoice = 11
  • MultipleObject = 13
  • SingleChoice = 10
  • SingleObject = 12
  • User = 1
  • WholeNumber = 7
  • YesNo = 4
• public class FileFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool Wrapping { get; set; }
  • public FileFieldRequest()
• public enum FilterType
  • Boolean = 4
  • CustomOnly = 5
  • List = 1
  • MultiList = 3
  • None = 0
  • Popup = 6
  • TextBox = 2
• public class FixedLengthFieldRequest : BaseFieldRequest
  • public bool AllowHtml { get; set; }
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool CTRL { get; set; }
  • public bool HasUnicode { get; set; }
  • public bool IncludeInTextIndex { get; set; }
  • public bool IsRelational { get; set; }
  • public string Key { get; set; }
  • public int Length { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public FixedLengthFieldRequest()
• public enum Formatting
  • Currency = 4
  • Date = 2
  • DateTime = 3
  • Formatted = 1
  • None = 0
• public class KeyboardShortcut
  • public string Action { get; set; }
  • public string Category { get; set; }
  • public string Shortcut { get; set; }
  • public string ViewerMode { get; set; }
  • public KeyboardShortcut()
• public class LongTextFieldRequest : BaseFieldRequest
  • public bool AllowHtml { get; set; }
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool AvailableInViewer { get; set; }
  • public bool CTRL { get; set; }
  • public bool EnableDataGrid { get; set; }
  • public bool HasUnicode { get; set; }
  • public bool IncludeInTextIndex { get; set; }
  • public string Key { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public LongTextFieldRequest()
• public class MultipleChoiceFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool AutoAddChoices { get; set; }
  • public bool AvailableInFieldTree { get; set; }
  • public bool HasUnicode { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public OverlayBehavior OverlayBehavior { get; set; }
  • public bool Wrapping { get; set; }
  • public MultipleChoiceFieldRequest()
• public class MultipleObjectFieldRequest : BaseFieldRequest
  • public ObjectTypeIdentifier AssociativeObjectType { get; set; }
  • public bool AvailableInFieldTree { get; set; }
  • public Securable<ObjectTypeIdentifier> FieldTreeView { get; set; }
  • public OverlayBehavior OverlayBehavior { get; set; }
  • public Securable<ObjectTypeIdentifier> PopupPickerView { get; set; }
  • public MultipleObjectFieldRequest()
• public enum OverlayBehavior
  • MergeValues = 1
  • ReplaceValues = 0
• public class SingleChoiceFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool AutoAddChoices { get; set; }
  • public bool AvailableInFieldTree { get; set; }
  • public bool HasUnicode { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool Wrapping { get; set; }
  • public SingleChoiceFieldRequest()
• public class SingleObjectFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public ObjectTypeIdentifier AssociativeObjectType { get; set; }
  • public bool AvailableInFieldTree { get; set; }
  • public Securable<ObjectTypeIdentifier> FieldTreeView { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public Securable<ObjectTypeIdentifier> PopupPickerView { get; set; }
  • public bool Wrapping { get; set; }
  • public SingleObjectFieldRequest()
• public class UserFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool CTRL { get; set; }
  • public string Key { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public UserFieldRequest()
• public class WholeNumberFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool CTRL { get; set; }
  • public Formatting Formatting { get; set; }
  • public string Key { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public WholeNumberFieldRequest()
• public class YesNoFieldRequest : BaseFieldRequest
  • public bool AllowSortTally { get; set; }
  • public bool ALT { get; set; }
  • public bool CTRL { get; set; }
  • public string DisplayValueFalse { get; set; }
  • public string DisplayValueTrue { get; set; }
  • public string Key { get; set; }
  • public bool OpenToAssociations { get; set; }
  • public bool SHIFT { get; set; }
  • public bool Wrapping { get; set; }
  • public YesNoFieldRequest()

Relativity.Services.Interfaces.InstanceSetting

• public interface IInstanceSettingManager : IDisposable
  • Task<int> CreateAsync(int workspaceID, InstanceSettingRequest instanceSetting)
  • Task DeleteAsync(int workspaceID, int instanceSettingID)
  • Task<InstanceSettingResponse> ReadAsync(int workspaceID, int instanceSettingID)
  • Task UpdateAsync(int workspaceID, InstanceSettingRequest instanceSetting)
  • Task UpdateAsync(int workspaceID, InstanceSettingRequest instanceSetting, DateTime lastModifiedOn)
• public interface IInstanceSettingModule
• public class InstanceSettingRouteConstants
  • public const string INSTANCE_SETTINGS_MODULE = "Relativity.InstanceSettings"
  • public const string INSTANCE_SETTINGS_ROUTE = "instancesettings"
  • public InstanceSettingRouteConstants()

Relativity.Services.Interfaces.InstanceSetting.Model

• public class InstanceSettingRequest
  • public int ArtifactID { get; set; }
  • public string Description { get; set; }
  • public bool Encrypted { get; set; }
  • public string InitialValue { get; set; }
  • public string Keywords { get; set; }
  • public string Machine { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public string Section { get; set; }
  • public string Value { get; set; }
  • public InstanceSettingValueTypeEnum ValueType { get; set; }
  • public InstanceSettingRequest()
• public class InstanceSettingResponse : DisplayableObjectIdentifier
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public string Description { get; set; }
  • public bool Encrypted { get; set; }
  • public string InitialValue { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public string Machine { get; set; }
  • public string Notes { get; set; }
  • public string Section { get; set; }
  • public string Value { get; set; }
  • public InstanceSettingValueTypeEnum ValueType { get; set; }
  • public InstanceSettingResponse()
• public enum InstanceSettingValueTypeEnum
  • Integer32 = 2
  • Integer64 = 3
  • NonNegativeInteger32 = 4
  • NonNegativeInteger64 = 5
  • PositiveInteger32 = 6
  • PositiveInteger64 = 7
  • Text = 1
  • TrueFalse = 8

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 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 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 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
  • MassActionVisibility = 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 class ObjectTypeConstants
  • public const string OBJECT_TYPE_ID = "objectTypeID"
  • public const string SERVICE_NAME = "Object Type Manager"

Relativity.Services.Interfaces.ObjectType.EventHandler.Models

• public enum EventHandlerExecution
• public class EventHandlerResponse : ObjectIdentifier

Relativity.Services.Interfaces.ObjectType.MassOperation

• public interface IMassOperationManager

Relativity.Services.Interfaces.ObjectType.MassOperation.Models

• public class MassOperationRequest
• public class MassOperationResponse : ObjectIdentifier

Relativity.Services.Interfaces.ObjectType.Models

• public class ObjectTypeRequest
  • public bool IsViewEnabled { get; set; }
  • public List<Securable<ObjectIdentifier>> RelativityApplications { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public bool? UseRelativityForms { get; set; }
• public class ObjectTypeResponse : DisplayableObjectIdentifier
  • public ObjectIdentifier CreatedBy { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public bool IsExtensible { get; set; }
  • public ObjectIdentifier LastModifiedBy { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public List<Securable<ObjectIdentifier>> RelativityApplications { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public bool? UseRelativityForms { get; set; }

Relativity.Services.Interfaces.ObjectType.ObjectRule

• public interface IObjectRuleManager

Relativity.Services.Interfaces.ObjectType.ObjectRule.Models

• public enum ObjectRuleBehavior
• public class ObjectRuleRequest
• public class ObjectRuleResponse : ObjectIdentifier

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 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 ARTIFACT_ID = "artifactID"
  • public const string DELETE_VERB = "DELETE"
  • public const string INCLUDE_ACTIONS_ROUTE = "{includeActions:bool}"
  • public const string INCLUDE_ACTIONS_STRING = "includeActions"
  • public const string INCLUDE_METADATA_AND_ACTIONS_ROUTE = "{includeMetadata:bool}/{includeActions:bool}"
  • public const string INCLUDE_METADATA_ROUTE = "{includeMetadata:bool}"
  • public const string INCLUDE_METADATA_STRING = "includeMetadata"
  • public const string METADATA_ROUTE = "meta"
  • public const string SERVICE_ROUTE_WORKSPACE_PREFIX = "workspace"
  • public const string UPDATE_VERB = "PUT"
  • public const string WORKSPACE_ID_ROUTE = "{workspaceID:int}"
  • public const string WORKSPACE_ID_STRING = "workspaceID"
  • public const string WORKSPACE_ROUTE = "workspace"

Relativity.Services.Interfaces.Shared.Models

• public class DisplayableObjectIdentifier : ObjectIdentifier
  • public string Name { get; set; }
  • public DisplayableObjectIdentifier()
• public enum FieldTypeEnum
  • Boolean = 3
  • Code = 5
  • Currency = 7
  • Date = 2
  • Decimal = 6
  • Empty = -1
  • File = 9
  • Integer = 1
  • LayoutText = 12
  • MultiCode = 8
  • Object = 10
  • Objects = 13
  • OffTableText = 14
  • Text = 4
  • User = 11
  • Varchar = 0
• public class KeyboardShortcutCombination
  • public KeyboardShortcutCombination()
• public class ObjectIdentifier
  • public string Name { get; set; }
  • public bool ShouldSerializeGuids()
• public class ObjectTypeIdentifier : ObjectIdentifier
  • public string Name { get; set; }
• public enum ParentReflectionTypeEnum
  • Empty = -1
  • GrandParent = 2
  • Parent = 1

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 class TabConstants
• public class TabRouteConstants
  • public const string TAB_MODULE = "Relativity.Tabs"
  • public const string TAB_ROUTE = "tabs"
  • public TabRouteConstants()

Relativity.Services.Interfaces.Tab.Models

• public class TabRequest
  • public Securable<List<RelativityObjectRef>> RelativityApplicationIDs { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
• public class TabResponse
  • public Securable<List<NameIDPair>> RelativityApplications { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }

Relativity.Services.Interfaces.UserInfo

• public interface IUserInfoManager : IDisposable
  • Task<UserInfoQueryResultSet> RetrieveUsersBy(int workspaceID, QueryRequest query, int start, int length)

Relativity.Services.Interfaces.UserInfo.Models

• 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.Interfaces.ViewField

• public interface IViewFieldManager : IDisposable
  • Task<ViewFieldResponse[]> ReadExportableViewFieldsAsync(int workspaceID, int artifactTypeID)
  • Task<ViewFieldIDResponse[]> ReadViewFieldIDsFromProductionAsync(int workspaceID, int artifactTypeID, int viewArtifactID)
  • Task<ViewFieldIDResponse[]> ReadViewFieldIDsFromSearchAsync(int workspaceID, int artifactTypeID, int viewArtifactID)
• public interface IViewFieldModule
• public class ViewFieldConstants
  • public const string MODULE_PREFIX = "Relativity.ViewFields"
  • public const string SERVICE_ROUTE = "viewfields"
  • public ViewFieldConstants()

Relativity.Services.Interfaces.ViewField.Models

• public enum ColumnSourceTypeEnum
  • Artifact = 1
  • Computed = 0
  • MainTable = 3
  • MetadataJoin = 2
  • NoDatabaseColumn = 4
• public enum FieldCategoryEnum
  • 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 ViewFieldIDResponse
  • public int ArtifactID { get; set; }
  • public int ArtifactViewFieldID { get; set; }
  • public ViewFieldIDResponse()
• public class ViewFieldResponse
  • public string AllowFieldName { get; set; }
  • public bool AllowHtml { get; set; }
  • public int ArtifactID { get; set; }
  • public int ArtifactTypeID { get; set; }
  • public string ArtifactTypeTableName { get; set; }
  • public string ArtifactViewFieldColumnName { get; set; }
  • public string ArtifactViewFieldHeaderName { get; set; }
  • public int ArtifactViewFieldID { get; set; }
  • public int AssociativeArtifactTypeID { get; set; }
  • public FieldCategoryEnum Category { get; set; }
  • public ColumnSourceTypeEnum ColumnSourceType { get; set; }
  • public int ConnectorFieldArtifactID { get; set; }
  • public FieldCategoryEnum ConnectorFieldCategory { get; set; }
  • public string ConnectorFieldName { get; set; }
  • public string DataSource { get; set; }
  • public string DisplayName { get; set; }
  • public bool EnableDataGrid { get; set; }
  • public int FieldCodeTypeID { get; set; }
  • public bool FieldIsArtifactBaseField { get; set; }
  • public FieldTypeEnum FieldType { get; set; }
  • public string FormatString { get; set; }
  • public bool IsLinked { get; set; }
  • public bool IsUnicodeEnabled { get; set; }
  • public bool IsVirtualAssociativeArtifactType { get; set; }
  • public int ParentFileFieldArtifactID { get; set; }
  • public string ParentFileFieldDisplayName { get; set; }
  • public ParentReflectionTypeEnum ParentReflectionType { get; set; }
  • public string ReflectedConnectorIdentifierColumnName { get; set; }
  • public string ReflectedFieldArtifactTypeTableName { get; set; }
  • public string ReflectedFieldConnectorFieldName { get; set; }
  • public string ReflectedFieldIdentifierColumnName { get; set; }
  • public string RelationalTableColumnName { get; set; }
  • public string RelationalTableColumnName2 { get; set; }
  • public string RelationalTableName { get; set; }
  • public int SourceFieldArtifactID { get; set; }
  • public int SourceFieldArtifactTypeID { get; set; }
  • public string SourceFieldArtifactTypeTableName { get; set; }
  • public string SourceFieldName { get; set; }
  • public ViewFieldResponse()

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 interface INotificationsManager : IDisposable
  • Task DismissMOTDAsync(int userId)
  • Task<bool> HasDismissedMOTDAsync(int userId)
  • Task<bool> IsTextOnlyMOTDAsync()
• public class MOTDRef
  • public bool AllowDismiss { get; set; }

Relativity.Services.ObjectType.MassOperation.Models

• public class MassOperationEventHandlerResponse : ObjectIdentifier

Relativity.Services.Objects

• public interface IObjectManager : IDisposable
  • Task UpdateLongTextFromStreamAsync(int workspaceID, UpdateLongTextFromStreamRequest updateLongTextFromStreamRequest, IKeplerStream keplerStream)

Relativity.Services.Objects.DataContracts

• public class ReadResult
  • public string ObjectVersionToken { get; set; }
• public class UpdateLongTextFromStreamRequest
  • public FieldRef Field { get; set; }
  • public RelativityObjectRef Object { get; set; }
  • public UpdateLongTextFromStreamRequest()
• public class UpdateRequest
  • public string ObjectVersionToken { get; set; }

Relativity.Services.Pivot

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

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.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)