Relativity.ObjectManager 10.2.227.16

API Differences between 10.2.227.16 and 9.6.204.22

1356 Additions 19 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.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.DataContracts.DTOs.ItemListView

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

Relativity.Services.DataContracts.DTOs.Results

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

Relativity.Services.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.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.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 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 IsExtensible { 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 CONTENT_ANALYST_DLL = "kCura.EDDS.ContentAnalystSearchProvider.dll"
- public const string DT_SEARCH_DLL = "kCura.EDDS.DTSearchSearchProvider.dll"
- public const string KEYWORD_SEARCH_DLL = "kCura.EDDS.SQLServer2005SearchProvider.dll"
- 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 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 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 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()
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 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.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.Objects

public class ObjectRef
- public bool ItemSecured { get; set; }
public interface IObjectManager : IDisposable
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects, CancellationToken cancel)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects, CancellationToken cancel, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<List<Dependency>> GetDependencyListAsync(int workspaceID, DependencyListByObjectIdentifiersRequest request)
- Task<ExportInitializationResults> InitializeExportAsync(int workspaceID, QueryRequest queryRequest, int start)
- Task<ExportInitializationResults> InitializeExportAsync(int workspaceID, QueryRequest queryRequest, Guid requestKey, int start)
- Task<RelativityObjectSlim[]> RetrieveNextResultsBlockFromExportAsync(int workspaceID, Guid runID, int batchSize)
- Task<IKeplerStream> StreamLongTextAsync(int workspaceID, RelativityObjectRef exportObject, FieldRef longTextField)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task UpdateLongTextFromStreamAsync(int workspaceID, UpdateLongTextFromStreamRequest updateLongTextFromStreamRequest, IKeplerStream keplerStream)

Relativity.Services.Objects.DataContracts

public class DependencyListByObjectIdentifiersRequest
- public IEnumerable<RelativityObjectRef> Objects { get; set; }
- public DependencyListByObjectIdentifiersRequest()
public enum FieldUpdateBehavior
- Remove = 2
public interface IHasArtifactTypeID : IHasIdentifyingInformation
- int ArtifactTypeID { get; set; }
public interface IHasIdentifyingInformation
public interface IHasObjectIdentificationCriteria
- ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
public interface IHasViewFieldID : IHasIdentifyingInformation
- int ViewFieldID { get; set; }
public interface IObjectType : IHasArtifactID, IHasIdentifyingInformation, IHasName, IHasArtifactTypeID
public class MassCreateRequest
- public IEnumerable<FieldRef> Fields { get; set; }
- public IReadOnlyList<FieldRef> Fields { get; set; }
public class MassDeletePerObjectsRequest
public class MassDeleteByObjectIdentifiersRequest
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public MassDeleteByObjectIdentifiersRequest()
public class MassDeleteResult
- public string Message { get; set; }
- public bool Success { get; set; }
public class MassOperationsStateProgress
- public int OperationsCompleted { get; set; }
- public int TotalOperations { get; set; }
- public double PercentageComplete { get; set; }
- public MassOperationsStateProgress(int totalOperations, int operationsCompleted)
public class ObjectRefValuesPair
- public IEnumerable<object> Values { get; set; }
- public IReadOnlyList<object> Values { get; set; }
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 UpdateLongTextFromStreamRequest
- public FieldRef Field { get; set; }
- public RelativityObjectRef Object { get; set; }
- public UpdateLongTextFromStreamRequest()
public class UpdateRequest
- public string ObjectVersionToken { get; set; }

Relativity.Services.Objects.Exceptions

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

Relativity.Services.Objects.Extensions

public static class GuidListExtensions
- public static Guid? GetOptionalGuid(this IEnumerable<Guid> guids)
public static class IObjectTypeExtensions
- public static Guid GetGuid(this IObjectType objectType)
- public static bool IsIdentifiedByGuid(this IObjectType objectType)

Relativity.Services.Objects.Helpers

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

Relativity.Services.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()

Relativity.Services.Serialization.Foundation

public interface IChoiceRefHelper
public interface IRelativityObjectRefHelper
public interface IUserRefHelper

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

API Differences between 10.2.227.16 and 9.6.204.22

Relativity.Services.ChoiceQuery

Relativity.Services.DBStatus

Relativity.Services.DataContracts.DTOs.EmailNotifications

Relativity.Services.DataContracts.DTOs.ItemListView

Relativity.Services.DataContracts.DTOs.Results

Relativity.Services.DataContracts.ImportExport

Relativity.Services.EmailNotificationsManager

Relativity.Services.Exceptions

Relativity.Services.FileField

Relativity.Services.Files

Relativity.Services.Interfaces.Agent

Relativity.Services.Interfaces.Agent.Models

Relativity.Services.Interfaces.Choice

Relativity.Services.Interfaces.Choice.Models

Relativity.Services.Interfaces.DtSearchIndexManager

Relativity.Services.Interfaces.DtSearchIndexManager.Models

Relativity.Services.Interfaces.EventHandler

Relativity.Services.Interfaces.EventHandler.Models

Relativity.Services.Interfaces.Field

Relativity.Services.Interfaces.Field.Models

Relativity.Services.Interfaces.InstanceSetting

Relativity.Services.Interfaces.InstanceSetting.Model

Relativity.Services.Interfaces.MassOperation

Relativity.Services.Interfaces.MassOperation.Models

Relativity.Services.Interfaces.ObjectRules

Relativity.Services.Interfaces.ObjectRules.Models

Relativity.Services.Interfaces.ObjectType

Relativity.Services.Interfaces.ObjectType.Models

Relativity.Services.Interfaces.SearchProvider

Relativity.Services.Interfaces.SearchProvider.Models

Relativity.Services.Interfaces.Shared

Relativity.Services.Interfaces.Shared.Constants

Relativity.Services.Interfaces.Shared.Models

Relativity.Services.Interfaces.SystemArtifact

Relativity.Services.Interfaces.Tab

Relativity.Services.Interfaces.Tab.Models

Relativity.Services.Interfaces.UserInfo

Relativity.Services.Interfaces.UserInfo.Models

Relativity.Services.Interfaces.ViewField

Relativity.Services.Interfaces.ViewField.Models

Relativity.Services.ItemListView

Relativity.Services.KeyboardShortcuts

Relativity.Services.KeyboardShortcuts.Models

Relativity.Services.Notifications

Relativity.Services.Objects

Relativity.Services.Objects.DataContracts

Relativity.Services.Objects.Exceptions

Relativity.Services.Objects.Extensions

Relativity.Services.Objects.Helpers

Relativity.Services.Permission

Relativity.Services.Pipeline

Relativity.Services.Pivot

Relativity.Services.Proxy.LRP

Relativity.Services.ResourceServer

Relativity.Services.Review.DynamicReviewQueue

Relativity.Services.Serialization.Foundation

Relativity.Services.ServiceProxy

Relativity.Services.StaticObject

Relativity.Services.SystemArtifact

Relativity.Services.User

Relativity.Services.Workspace