Relativity.ObjectManager 11.0.162.34

API Differences between 11.0.162.34 and 9.6.125.89

2485 Additions 14 Removals

Relativity.Kepler.Transport

public interface IKeplerStream : IDisposable
- string CacheControl { get; set; }
public class KeplerResponseStream : IKeplerStream, IDisposable
- public string CacheControl { get; set; }
public class KeplerStream : IKeplerStream, IDisposable
- public string CacheControl { get; set; }

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

public class DynamicReviewQueueDocument
- public int? FamilyOrder { get; set; }
- public int? LeadDocumentID { get; set; }
- public long ReviewOrder { get; set; }
public class RelationalReviewStatistics
- public int AbandonedDocumentsCount { get; set; }
- public Dictionary<int, int> CodedDocumentsCountByChoice { get; set; }
- public int TotalReviewedCount { get; set; }
- public RelationalReviewStatistics()

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.EmailValidation.Models

public class EmailValidationResponseObject
- public HashSet<string> InvalidEmails { get; }
- public HashSet<string> ValidEmails { get; }
- public EmailValidationResponseObject(HashSet<string> validEmails, HashSet<string> invalidEmails)

Relativity.Services.Exceptions

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

Relativity.Services.Field.Models

public enum ImportBehavior
- LeaveBlankValuesUnchanged = 1
- None = 0
- ReplaceBlankValuesWithIdentifier = 2

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<DynamicFileResponse[]> GetFilesForDynamicObjectsAsync(int workspaceID, int fileFieldArtifactID, int[] objectIDs)
- 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.FileField.Models

public class DynamicFileResponse
- public int FileID { get; set; }
- public string FileName { get; set; }
- public string Location { get; set; }
- public int ObjectArtifactID { get; set; }
- public int Size { get; set; }
- public DynamicFileResponse()

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

public interface IApplicationManager
- Task<CreateApplicationResponse> CreateAsync(int workspaceID, CreateApplicationRequest request)
- Task<KeplerStream> ExportAsync(int workspaceID, int applicationID)
- Task<KeplerStream> ExportAsync(int workspaceID, Guid applicationGUID)
- Task<KeplerStream> ExportSchemaAsync(int workspaceID, int applicationID)
- Task<KeplerStream> ExportSchemaAsync(int workspaceID, Guid applicationGUID)
- Task<Application> GetApplicationAsync(int workspaceID, int applicationID)
- Task<Application> GetApplicationAsync(int workspaceID, Guid applicationGUID)
- Task<KeplerStream> GetVisualizationAsync(int workspaceID, int applicationID)
- Task<KeplerStream> GetVisualizationAsync(int workspaceID, Guid applicationGUID)
- Task LockAsync(int workspaceID, int applicationID)
- Task LockAsync(int workspaceID, Guid applicationGUID)
- Task<int> PublishToLibraryAsync(int workspaceID, int applicationID)
- Task<int> PublishToLibraryAsync(int workspaceID, Guid applicationGUID)
- Task UnlockAsync(int workspaceID, int applicationID)
- Task UnlockAsync(int workspaceID, Guid applicationGUID)
- Task<ValidateApplicationResponse> ValidateApplicationAsync(int workspaceID, int applicationID)
- Task<ValidateApplicationResponse> ValidateApplicationAsync(int workspaceID, Guid applicationGUID)
public interface IApplicationModule

Relativity.Services.Interfaces.Application.Models

public class Application
- public List<Action> Actions { get; set; }
- public ObjectIdentifier ArtifactID { get; set; }
- public List<ApplicationComponentDetail> Components { get; set; }
- public Application()
public class ApplicationComponentDetail
- public DisplayableObjectIdentifier Artifact { get; set; }
- public DisplayableObjectIdentifier ArtifactType { get; set; }
- public List<Guid> Guids { get; set; }
- public Version Version { get; set; }
- public ApplicationComponentDetail()
public class CreateApplicationRequest
- public string Name { get; set; }
- public string UserFriendlyURL { get; set; }
- public Version Version { get; set; }
- public CreateApplicationRequest()
public class CreateApplicationResponse
- public ObjectIdentifier ApplicationID { get; set; }
- public CreateApplicationResponse()
public enum ErrorLevel
- Error = 1
- Unknown = 0
- Warning = 2
public class ValidateApplicationResponse
- public List<ValidationMessage> Messages { get; set; }
- public ValidateApplicationResponse()
public class ValidationMessage
- public string Message { get; set; }
- public Action ResolutionAction { get; set; }
- public ErrorLevel Type { get; set; }
- public ValidationMessage()

Relativity.Services.Interfaces.Choice

public static class ChoiceConstants
- public const string CHOICE_ROUTE = "choice"
- public const string MODULE_PREFIX = "Relativity.Choices"
public interface IChoiceManager : IDisposable
- Task<int> CreateAsync(int workspaceID, ChoiceRequest choiceRequest)
- Task<MassCreateChoiceResponse> CreateAsync(int workspaceID, MassCreateChoiceRequest massCreateChoiceRequest)
- Task DeleteAsync(int workspaceID, int choiceID)
- Task DeleteAsync(int workspaceID, Guid choiceGuid)
- Task<MassActionChoiceResponse> DeleteAsync(int workspaceID, MassDeleteChoiceRequest massDeleteRequest)
- Task<List<DisplayableObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, ObjectIdentifier fieldIdentifier)
- Task<List<DisplayableObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, int choiceID)
- Task<List<DisplayableObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, Guid choiceGuid)
- Task<List<NameIDPair>> GetColorsListAsync(int workspaceID)
- Task<MassActionChoiceResponse> MoveAsync(int workspaceID, int fieldID, ObjectIdentifier[] choiceObjectIdentifiers, ChoiceMoveTypeEnum moveListTo)
- Task<MassActionChoiceResponse> MoveAsync(int workspaceID, int fieldID, ObjectIdentifier[] choiceObjectIdentifiers, ObjectIdentifier choiceID)
- Task<ChoiceResponse> ReadAsync(int workspaceID, int choiceID)
- Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid)
- Task<ChoiceResponse> ReadAsync(int workspaceID, int choiceID, bool includeMetadata, bool includeActions)
- Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid, bool includeMetadata, bool includeActions)
- Task<MassActionChoiceResponse> SortAsync(int workspaceID, int fieldID, ChoiceReorderTypeEnum sortType)
- 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)
- Task<MassActionChoiceResponse> UpdateAsync(int workspaceID, MassUpdateChoiceRequest[] massUpdateChoices)
- Task<MassActionChoiceResponse> UpdateAsync(int workspaceID, MassUpdateChoiceRequest[] massUpdateChoices, CancellationToken cancel, IProgress<ProgressReport> progress)
public interface IChoiceModule

Relativity.Services.Interfaces.Choice.Models

public enum ChoiceMoveTypeEnum
- Beginning = 0
- End = 1
public enum ChoiceReorderTypeEnum
- Ascending = 0
- Descending = 1
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 Meta Meta { 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()
public class MassActionChoiceResponse
- public string Message { get; set; }
- public bool Success { get; set; }
- public int TotalChoices { get; set; }
- public MassActionChoiceResponse()
public class MassCreateChoiceModel
- public ObjectIdentifier Field { get; set; }
- public string Keywords { get; set; }
- public string Notes { get; set; }
- public List<ObjectIdentifier> RelativityApplications { get; set; }
- public MassCreateChoiceModel()
public class MassCreateChoiceRequest
- public List<MassCreateChoiceStructure> Choices { get; set; }
- public MassCreateChoiceModel ChoiceTemplateData { get; set; }
- public MassCreateChoiceRequest()
public class MassCreateChoiceResponse
- public List<MassCreatedChoice> ChoicesCreated { get; set; }
- public string Message { get; set; }
- public bool Success { get; set; }
- public MassCreateChoiceResponse()
public class MassCreateChoiceStructure
- public List<MassCreateChoiceStructure> Children { get; set; }
- public string Name { get; set; }
- public MassCreateChoiceStructure()
public class MassCreatedChoice : DisplayableObjectIdentifier
- public DisplayableObjectIdentifier ParentChoice { get; set; }
- public MassCreatedChoice()
public class MassDeleteChoiceRequest
- public IReadOnlyList<ObjectIdentifier> ChoiceIDs { get; set; }
- public MassDeleteChoiceRequest()
public class MassUpdateChoiceRequest : ObjectIdentifier
- public int Color { get; set; }
- public ObjectIdentifier Field { get; set; }
- public string Keywords { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public List<ObjectIdentifier> RelativityApplications { get; set; }
- public MassUpdateChoiceRequest()

Relativity.Services.Interfaces.Client

public interface IClientManager : IDisposable
- Task<ClientResponse> CreateAsync(ClientRequest clientRequest)
- Task DeleteAsync(int clientID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleStatusesAsync()
- Task<QueryResultSlim> QueryGroupsAsync(QueryRequest request, int start, int length, int clientID)
- Task<QueryResultSlim> QueryGroupsAsync(QueryRequest request, int start, int length, int clientID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryGroupsAsync(QueryRequest request, int start, int length, int clientID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryMattersAsync(QueryRequest request, int start, int length, int clientID)
- Task<QueryResultSlim> QueryMattersAsync(QueryRequest request, int start, int length, int clientID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryMattersAsync(QueryRequest request, int start, int length, int clientID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryUsersAsync(QueryRequest request, int start, int length, int clientID)
- Task<QueryResultSlim> QueryUsersAsync(QueryRequest request, int start, int length, int clientID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryUsersAsync(QueryRequest request, int start, int length, int clientID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<ClientResponse> ReadAsync(int clientID)
- Task<ClientResponse> ReadAsync(int clientID, bool includeMetadata, bool includeActions)
- Task<ClientResponse> UpdateAsync(int clientID, ClientRequest clientRequest)
- Task<ClientResponse> UpdateAsync(int clientID, ClientRequest clientRequest, DateTime lastModifiedOn)
public interface IClientModule

Relativity.Services.Interfaces.Client.Models

public class ClientRequest : IHaveKeywordsAndNotes
- public string Keywords { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public string Number { get; set; }
- public ObjectIdentifier Status { get; set; }
- public ClientRequest()
- public ClientRequest(ClientResponse clientResponse)
- public static ClientRequest op_Implicit(ClientResponse clientResponse)
public class ClientResponse : ObjectIdentifier, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public List<Action> Actions { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public bool IsClientDomain { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Meta Meta { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public string Number { get; set; }
- public DisplayableObjectIdentifier Status { get; set; }
- public ClientResponse()

Relativity.Services.Interfaces.Document

public interface IDocumentFileManager : IDisposable
- Task<IKeplerStream> DownloadFileAsync(int workspaceID, Guid fileGuid)
- Task<IKeplerStream> DownloadNativeFileAsync(int workspaceID, int documentID)
- Task<List<DocumentFile>> GetFileInfoAsync(int workspaceID, int documentID)
public interface IDocumentModule

Relativity.Services.Interfaces.Document.Models

public class DocumentFile
- public string Filename { get; set; }
- public DocumentFileType FileType { get; set; }
- public Guid Guid { get; set; }
- public string Identifier { get; set; }
- public int Order { get; set; }
- public DocumentFileRotation Rotation { get; set; }
- public long Size { get; set; }
- public DocumentFile()
public enum DocumentFileRotation
- NinentyDegrees = 2
- NotSet = 0
- OneHundredEightyDegrees = 3
- TwoHundredSeventyDegrees = 4
- ZeroDegrees = 1
public enum DocumentFileType
- Native = 0
- OriginalImage = 1
- ProducedImage = 2

Relativity.Services.Interfaces.EmailValidation

public class EmailValidationConstants
- public const string MODULE_PREFIX = "Relativity.EmailValidation"
- public const string SERVICE_ROUTE = "emailvalidation"
- public EmailValidationConstants()
public interface IEmailValidationManager : IDisposable
- Task<EmailValidationResponseObject> VerifyEmails(string emailList)
public interface IEmailValidationModule

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<RelationalFieldOrder>> GetRelationalOrderAsync(int workspaceID)
- 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 bool AllowSortTally { 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 string Source { get; set; }
- public int? Width { get; set; }
- public BaseFieldRequest()
public class CurrencyFieldRequest : BaseFieldRequest
- 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 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 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 string FriendlyName { get; set; }
- public bool HasUnicode { get; set; }
- public ImportBehavior ImportBehavior { get; set; }
- public bool IncludeInTextIndex { get; set; }
- public bool IsIdentifier { get; set; }
- public bool IsLinked { get; set; }
- public bool IsRelational { 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 int Order { get; set; }
- public OverlayBehavior OverlayBehavior { get; set; }
- public PaneIcon PaneIcon { get; set; }
- public Securable<DisplayableObjectIdentifier> PopupPickerView { get; set; }
- public SecurableList<DisplayableObjectIdentifier> PropagateTo { get; set; }
- public Securable<DisplayableObjectIdentifier> RelationalView { get; set; }
- public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
- public bool SHIFT { get; set; }
- public FieldSource Source { get; set; }
- public int? Width { get; set; }
- public bool Wrapping { get; set; }
- public FieldResponse()
public class FieldSource
- public string FriendlyName { get; set; }
- public string SourceName { get; set; }
- public FieldSource()
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 Wrapping { get; set; }
- public FileFieldRequest()
public enum FilterType
- Boolean = 4
- CustomOnly = 5
- DatePicker = 7
- List = 1
- MultiList = 3
- None = 0
- Popup = 6
- TextBox = 2
public class FixedLengthFieldRequest : BaseFieldRequest
- public bool AllowHtml { get; set; }
- public bool ALT { get; set; }
- public bool CTRL { get; set; }
- public string FriendlyName { get; set; }
- public bool HasUnicode { get; set; }
- public ImportBehavior ImportBehavior { 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 int Order { get; set; }
- public PaneIcon PaneIcon { get; set; }
- public Securable<ObjectIdentifier> RelationalView { 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 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 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 PaneIcon
- public string FileName { get; set; }
- public string ImageBase64 { get; set; }
- public PaneIcon()
public class RelationalFieldOrder
- public string Name { get; set; }
- public int Order { get; set; }
- public string Type { get; set; }
- public RelationalFieldOrder()
public class SingleChoiceFieldRequest : BaseFieldRequest
- 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 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 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 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 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.File

public static class FileConstants
- public const string MODULE_PREFIX = "Relativity.Files"
- public const string SERVICE_ROUTE = "files"
public interface IFileModule

Relativity.Services.Interfaces.File.Models

public class DocumentImageResponse
- public bool Billable { get; set; }
- public int ByteRange { get; set; }
- public string Details { get; set; }
- public int DocumentArtifactID { get; set; }
- public int FileID { get; set; }
- public string FileName { get; set; }
- public string Guid { get; set; }
- public string Identifier { get; set; }
- public bool InRepository { get; set; }
- public string Location { get; set; }
- public int Order { get; set; }
- public int PageID { get; set; }
- public int Rotation { get; set; }
- public int Size { get; set; }
- public int Type { get; set; }
- public DocumentImageResponse()
public class ExportProductionDocumentImageResponse
- public string BatesNumber { get; set; }
- public int ByteRange { get; set; }
- public int DocumentArtifactID { get; set; }
- public string ImageFileName { get; set; }
- public string ImageGuid { get; set; }
- public int? ImageSize { get; set; }
- public string Location { get; set; }
- public int Order { get; set; }
- public int PageID { get; set; }
- public int ProductionArtifactID { get; set; }
- public string SourceGuid { get; set; }
- public ExportProductionDocumentImageResponse()
public class FileResponse
- public bool Billable { get; set; }
- public string Details { get; set; }
- public int DocumentArtifactID { get; set; }
- public string Filename { get; set; }
- public string Guid { get; set; }
- public string Identifier { get; set; }
- public bool InRepository { get; set; }
- public string Location { get; set; }
- public int Order { get; set; }
- public int Rotation { get; set; }
- public long Size { get; set; }
- public int Type { get; set; }
- public FileResponse()
public class ProductionDocumentImageResponse
- public string BatesNumber { get; set; }
- public int ByteRange { get; set; }
- public int DocumentArtifactID { get; set; }
- public string ImageFileName { get; set; }
- public string ImageGuid { get; set; }
- public int? ImageSize { get; set; }
- public string Location { get; set; }
- public string NativeIdentifier { get; set; }
- public int PageID { get; set; }
- public string SourceGuid { get; set; }
- public ProductionDocumentImageResponse()

Relativity.Services.Interfaces.Group

public interface IGroupManager : IDisposable
- Task AddMembersAsync(int groupID, List<ObjectIdentifier> users)
- Task AddMembersAsync(int groupID, List<ObjectIdentifier> users, IProgress<ProgressReport> progress)
- Task AddMembersAsync(int groupID, List<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task AddMembersAsync(int groupID, ObjectIdentifier user)
- Task<GroupResponse> CreateAsync(GroupRequest groupRequest)
- Task DeleteAsync(int groupID)
- Task DeleteAsync(int groupID, IProgress<ProgressReport> progress)
- Task DeleteAsync(int groupID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> GetEligibleClients(QueryRequest request, int start, int length)
- Task<QueryResultSlim> GetEligibleClients(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> GetEligibleClients(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> GetEligibleUsers(QueryRequest request, int start, int length)
- Task<QueryResultSlim> GetEligibleUsers(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> GetEligibleUsers(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups)
- Task MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, IProgress<ProgressReport> progress)
- Task MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups)
- Task MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, IProgress<ProgressReport> progress)
- Task MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryGroupsByUserAsync(QueryRequest request, int start, int length, int userID)
- Task<QueryResultSlim> QueryGroupsByUserAsync(QueryRequest request, int start, int length, int userID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryGroupsByUserAsync(QueryRequest request, int start, int length, int userID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryMembersAsync(QueryRequest request, int start, int length, int groupID)
- Task<QueryResultSlim> QueryMembersAsync(QueryRequest request, int start, int length, int groupID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryMembersAsync(QueryRequest request, int start, int length, int groupID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<GroupResponse> ReadAsync(int groupID)
- Task<GroupResponse> ReadAsync(int groupID, bool includeMetadata, bool includeActions)
- Task RemoveMembersAsync(int groupID, List<ObjectIdentifier> users)
- Task RemoveMembersAsync(int groupID, List<ObjectIdentifier> users, IProgress<ProgressReport> progress)
- Task RemoveMembersAsync(int groupID, List<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task RemoveMembersAsync(int groupID, ObjectIdentifier user)
- Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest)
- Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, IProgress<ProgressReport> progress)
- Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, DateTime lastModifiedOn)
- Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, DateTime lastModifiedOn, IProgress<ProgressReport> progress)
- Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, DateTime lastModifiedOn, CancellationToken cancel, IProgress<ProgressReport> progress)
public interface IGroupModule

Relativity.Services.Interfaces.Group.Models

public class GroupRequest
- public Securable<ObjectIdentifier> Client { get; set; }
- public string Keywords { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public GroupRequest(GroupResponse groupResponse)
- public GroupRequest()
- public static GroupRequest op_Implicit(GroupResponse response)
public class GroupResponse : DisplayableObjectIdentifier
- public List<Action> Actions { get; set; }
- public Securable<DisplayableObjectIdentifier> Client { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public GroupType GroupType { 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 GroupResponse()
public enum GroupType
- Everyone = 3
- SystemAdmin = 1
- SystemGroup = 2

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

public interface IApplicationInstallManager : IDisposable
- Task<CancelApplicationInstallResponse> CancelAllAsync(int workspaceID, int applicationID)
- Task<CancelApplicationInstallResponse> CancelAllAsync(int workspaceID, Guid applicationGuid)
- Task<CancelApplicationInstallResponse> CancelAsync(int workspaceID, int applicationID, int applicationInstallID)
- Task<CancelApplicationInstallResponse> CancelAsync(int workspaceID, Guid applicationGuid, int applicationInstallID)
- Task<CancelApplicationInstallResponse> CancelAsync(int workspaceID, int applicationID, List<int> applicationInstallIDs)
- Task<CancelApplicationInstallResponse> CancelAsync(int workspaceID, Guid applicationGuid, List<int> applicationInstallIDs)
- Task<GetAllInstallStatusResponse> GetAllInstallStatusAsync(int workspaceID, int applicationID, int start, int length)
- Task<GetAllInstallStatusResponse> GetAllInstallStatusAsync(int workspaceID, Guid applicationGuid, int start, int length)
- Task<GetAllInstallStatusResponse> GetAllInstallStatusAsync(int workspaceID, int applicationID, int start, int length, bool includeActions)
- Task<GetAllInstallStatusResponse> GetAllInstallStatusAsync(int workspaceID, Guid applicationGuid, int start, int length, bool includeActions)
- Task<GetApplicationInstallDetailsResponse> GetApplicationInstallDetailsAsync(int workspaceID, int applicationID, int applicationInstallID, int start, int length)
- Task<GetApplicationInstallDetailsResponse> GetApplicationInstallDetailsAsync(int workspaceID, Guid applicationGuid, int applicationInstallID, int start, int length)
- Task<GetApplicationInstallDetailsResponse> GetApplicationInstallDetailsAsync(int workspaceID, int applicationID, int applicationInstallID, int start, int length, bool includeActions)
- Task<GetApplicationInstallDetailsResponse> GetApplicationInstallDetailsAsync(int workspaceID, Guid applicationGuid, int applicationInstallID, int start, int length, bool includeActions)
- Task<GetInstallStatusResponse> GetStatusAsync(int workspaceID, int applicationID, int applicationInstallID)
- Task<GetInstallStatusResponse> GetStatusAsync(int workspaceID, Guid applicationGuid, int applicationInstallID)
- Task<GetInstallStatusResponse> GetStatusAsync(int workspaceID, int applicationID, int applicationInstallID, bool includeActions)
- Task<GetInstallStatusResponse> GetStatusAsync(int workspaceID, Guid applicationGuid, int applicationInstallID, bool includeActions)
- Task<InstallApplicationResponse> InstallApplicationAllAsync(int workspaceID, int applicationID, InstallApplicationAllRequest request)
- Task<InstallApplicationResponse> InstallApplicationAllAsync(int workspaceID, Guid applicationGUID, InstallApplicationAllRequest request)
- Task<InstallApplicationResponse> InstallApplicationAllAsync(int workspaceID, int applicationID, InstallApplicationAllRequest request, bool includeActions)
- Task<InstallApplicationResponse> InstallApplicationAllAsync(int workspaceID, Guid applicationGUID, InstallApplicationAllRequest request, bool includeActions)
- Task<InstallApplicationResponse> InstallApplicationAsync(int workspaceID, int applicationID, InstallApplicationRequest request)
- Task<InstallApplicationResponse> InstallApplicationAsync(int workspaceID, Guid applicationGUID, InstallApplicationRequest request)
- Task<InstallApplicationResponse> InstallApplicationAsync(int workspaceID, int applicationID, InstallApplicationRequest request, bool includeActions)
- Task<InstallApplicationResponse> InstallApplicationAsync(int workspaceID, Guid applicationGUID, InstallApplicationRequest request, bool includeActions)
public interface ILibraryApplicationManager : IDisposable
- Task<CancelLibraryInstallResponse> CancelLibraryInstallAsync(int workspaceID, int applicationID)
- Task<CancelLibraryInstallResponse> CancelLibraryInstallAsync(int workspaceID, Guid applicationGuid)
- Task<CreateLibraryApplicationResponse> CreateAsync(int workspaceID, IKeplerStream rapStream)
- Task<CreateLibraryApplicationResponse> CreateAsync(int workspaceID, IKeplerStream rapStream, bool includeActions)
- Task<CreateLibraryApplicationResponse> CreateAsync(int workspaceID, Guid packageGuid)
- Task<CreateLibraryApplicationResponse> CreateAsync(int workspaceID, Guid packageGuid, bool includeActions)
- Task DeleteAsync(int workspaceID, int applicationID)
- Task DeleteAsync(int workspaceID, Guid applicationGuid)
- Task DeletePackageAsync(int workspaceID, Guid packageGuid)
- Task<IKeplerStream> DownloadPackageAsync(int workspaceID, Guid packageGuid)
- Task<GetInstallStatusResponse> GetLibraryInstallStatusAsync(int workspaceID, int applicationID)
- Task<GetInstallStatusResponse> GetLibraryInstallStatusAsync(int workspaceID, Guid applicationGuid)
- Task<GetInstallStatusResponse> GetLibraryInstallStatusAsync(int workspaceID, int applicationID, bool includeActions)
- Task<GetInstallStatusResponse> GetLibraryInstallStatusAsync(int workspaceID, Guid applicationGuid, bool includeActions)
- Task<List<LibraryApplicationResponse>> ReadAllAsync(int workspaceID)
- Task<List<LibraryApplicationResponse>> ReadAllAsync(int workspaceID, bool includeMetadata, bool includeActions)
- Task<IKeplerStream> ReadApplicationContentsAsync(int workspaceID, int applicationID)
- Task<IKeplerStream> ReadApplicationContentsAsync(int workspaceID, Guid applicationGUID)
- Task<LibraryApplicationResponse> ReadAsync(int workspaceID, int applicationID)
- Task<LibraryApplicationResponse> ReadAsync(int workspaceID, int applicationID, bool includeMetadata, bool includeActions)
- Task<LibraryApplicationResponse> ReadAsync(int workspaceID, Guid applicationGUID)
- Task<LibraryApplicationResponse> ReadAsync(int workspaceID, Guid applicationGUID, bool includeMetadata, bool includeActions)
- Task<RetryLibraryInstallResponse> RetryLibraryInstallAsync(int workspaceID, int applicationID)
- Task<RetryLibraryInstallResponse> RetryLibraryInstallAsync(int workspaceID, Guid applicationGUID)
- Task<UpdateLibraryApplicationResponse> UpdateAsync(int workspaceID, IKeplerStream rapStream, UpdateLibraryApplicationRequest request)
- Task<UpdateLibraryApplicationResponse> UpdateAsync(int workspaceID, IKeplerStream rapStream, UpdateLibraryApplicationRequest request, bool includeActions)
- Task<UpdateLibraryApplicationResponse> UpdateAsync(int workspaceID, Guid packageGuid, UpdateLibraryApplicationRequest request)
- Task<UpdateLibraryApplicationResponse> UpdateAsync(int workspaceID, Guid packageGuid, UpdateLibraryApplicationRequest request, bool includeActions)
- Task<PackageDetailsResponse> UploadPackageAsync(int workspaceID, IKeplerStream rapStream)
public interface ILibraryApplicationModule

Relativity.Services.Interfaces.LibraryApplication.Models

public class ApplicationInstallConflict
- public DisplayableObjectIdentifier ConflictArtifactIdentifier { get; set; }
- public int ConflictCorrelationID { get; set; }
- public string Description { get; set; }
- public List<ApplicationInstallConflictResolutionType> Options { get; set; }
- public ApplicationInstallConflict()
public class ApplicationInstallConflictResolution
- public int ConflictArtifactID { get; set; }
- public int ConflictCorrelationID { get; set; }
- public ApplicationInstallConflictResolutionType ResolutionType { get; set; }
- public string Value { get; set; }
- public int WorkspaceID { get; set; }
- public ApplicationInstallConflictResolution()
public enum ApplicationInstallConflictResolutionType
- MapField = 3
- RenameField = 1
- RenameRelationalFriendlyName = 2
- Unknown = 0
- UnlockAssociatedApplications = 4
public class ApplicationInstallDetail : DisplayableObjectIdentifier
- public string ArtifactStatus { get; set; }
- public string ArtifactTypeName { get; set; }
- public DateTime CreatedOn { get; set; }
- public ApplicationInstallDetail()
public enum ApplicationInstallTargetOption
- ForceInstall = 1
- Unknown = 0
- UpgradeOnly = 2
public class CancelApplicationInstallResponse
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public List<CancelApplicationInstallResult> Results { get; set; }
- public CancelApplicationInstallResponse()
public class CancelApplicationInstallResult
- public int ApplicationInstallID { get; set; }
- public bool IsSuccessful { get; set; }
- public string Message { get; set; }
- public ObjectIdentifier WorkspaceIdentifier { get; set; }
- public CancelApplicationInstallResult()
public class CancelLibraryInstallResponse
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public int ApplicationInstallID { get; set; }
- public bool IsSuccessful { get; set; }
- public string Message { get; set; }
- public CancelLibraryInstallResponse()
public class CreateLibraryApplicationResponse : IHasInstallStatus
- public List<Action> Actions { get; set; }
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public int ApplicationInstallID { get; set; }
- public InstallStatus InstallStatus { get; set; }
- public CreateLibraryApplicationResponse()
public class GetAllInstallStatusResponse : IPagedResponse
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public int CurrentStartIndex { get; set; }
- public Action FirstPage { get; set; }
- public Action LastPage { get; set; }
- public Action NextPage { get; set; }
- public Action PreviousPage { get; set; }
- public int ResultCount { get; set; }
- public List<GetInstallStatusResponse> Results { get; set; }
- public int TotalCount { get; set; }
- public GetAllInstallStatusResponse()
public class GetApplicationInstallDetailsResponse : IPagedResponse, IHasInstallStatus
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public int ApplicationInstallID { get; set; }
- public int CurrentStartIndex { get; set; }
- public List<ApplicationInstallDetail> Details { get; set; }
- public Action FirstPage { get; set; }
- public InstallStatus InstallStatus { get; set; }
- public Action LastPage { get; set; }
- public List<string> Messages { get; set; }
- public Action NextPage { get; set; }
- public Action PreviousPage { get; set; }
- public int ResultCount { get; set; }
- public int TotalCount { get; set; }
- public Version Version { get; set; }
- public GetApplicationInstallDetailsResponse()
public class GetInstallStatusResponse : IHasInstallStatus
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public int ApplicationInstallID { get; set; }
- public DateTime? CompletedOn { get; set; }
- public Action GetCurrentInstallStatus { get; set; }
- public DisplayableObjectIdentifier InstalledBy { get; set; }
- public InstallStatus InstallStatus { get; set; }
- public DateTime? StartedOn { get; set; }
- public List<string> ValidationMessages { get; set; }
- public InstallValidationResult ValidationResult { get; set; }
- public string Version { get; set; }
- public ObjectIdentifier WorkspaceIdentifier { get; set; }
- public GetInstallStatusResponse()
public interface IHasInstallStatus
- int ApplicationInstallID { get; set; }
- InstallStatus InstallStatus { get; set; }
public interface IInstallApplicationRequest
- List<int> WorkspaceIDs { get; set; }
public interface IInstallApplicationResponse
- ObjectIdentifier ApplicationIdentifier { get; set; }
- List<InstallApplicationResult> Results { get; set; }
public class InstallApplicationAllRequest
- public ApplicationInstallTargetOption Mode { get; set; }
- public bool UnlockApplications { get; set; }
- public InstallApplicationAllRequest()
public class InstallApplicationRequest : IInstallApplicationRequest
- public List<ApplicationInstallConflictResolution> ConflictResolutions { get; set; }
- public bool UnlockApplications { get; set; }
- public List<int> WorkspaceIDs { get; set; }
- public InstallApplicationRequest()
public class InstallApplicationResponse : IInstallApplicationResponse
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public List<string> Messages { get; set; }
- public List<InstallApplicationResult> Results { get; set; }
- public InstallApplicationResponse()
public class InstallApplicationResult : IHasInstallStatus
- public int ApplicationInstallID { get; set; }
- public InstallStatus InstallStatus { get; set; }
- public List<string> Messages { get; set; }
- public ObjectIdentifier WorkspaceIdentifier { get; set; }
- public InstallApplicationResult()
public class InstallStatus
- public Action CancelInstallAction { get; set; }
- public InstallStatusCode Code { get; set; }
- public Action GetDetailsAction { get; set; }
- public string Message { get; set; }
- public Action RetryInstallAction { get; set; }
- public InstallStatus()
public enum InstallStatusCode
- Canceled = 5
- Completed = 4
- Failed = 3
- InProgress = 2
- Pending = 1
- Unknown = 0
public class InstallValidationResult
- public List<ApplicationInstallConflict> InstallConflicts { get; set; }
- public Action RetryInstallAction { get; set; }
- public InstallApplicationRequest RetryInstallRequestTemplate { get; set; }
- public InstallValidationResult()
public enum LibraryApplicationRequiredFlag
- Optional = 0
- Required = 1
- RequiredIfPresent = 2
- Unknown = 3
public class LibraryApplicationResponse : DisplayableObjectIdentifier
- public List<Action> Actions { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public string FileName { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public LibraryApplicationRequiredFlag Required { get; set; }
- public string TreeView { get; set; }
- public string UserFriendlyURL { get; set; }
- public string Version { get; set; }
- public LibraryApplicationResponse()
public class PackageDetailsResponse
- public string FileName { get; set; }
- public string Name { get; set; }
- public Guid PackageGUID { get; set; }
- public string TreeView { get; set; }
- public string UserFriendlyURL { get; set; }
- public string Version { get; set; }
- public PackageDetailsResponse()
public class RetryLibraryInstallResponse : IHasInstallStatus
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public int ApplicationInstallID { get; set; }
- public InstallStatus InstallStatus { get; set; }
- public RetryLibraryInstallResponse()
public class UpdateLibraryApplicationRequest
- public bool CreateIfMissing { get; set; }
- public string FileName { get; set; }
- public bool IgnoreVersion { get; set; }
- public bool RefreshCustomPages { get; set; }
- public UpdateLibraryApplicationRequest()
public class UpdateLibraryApplicationResponse : IHasInstallStatus
- public List<Action> Actions { get; set; }
- public ObjectIdentifier ApplicationIdentifier { get; set; }
- public int ApplicationInstallID { get; set; }
- public InstallStatus InstallStatus { get; set; }
- public List<string> Messages { get; set; }
- public UpdateLibraryApplicationResponse()

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

public interface IMatterManager : IDisposable
- Task<int> CreateAsync(int workspaceID, MatterRequest matterRequest)
- Task DeleteAsync(int workspaceID, int matterID)
- Task<List<DisplayableObjectIdentifier>> GetAvailableClientsAsync(int workspaceID)
- Task<List<DisplayableObjectIdentifier>> GetAvailableStatusesAsync(int workspaceID)
- Task<MatterResponse> ReadAsync(int workspaceID, int matterID)
- Task<MatterResponse> ReadAsync(int workspaceID, int matterID, bool includeMetadata, bool includeActions)
- Task UpdateAsync(int workspaceID, int matterID, MatterRequest matterRequest)
- Task UpdateAsync(int workspaceID, int matterID, MatterRequest matterRequest, DateTime lastModifiedOn)
public interface IMatterModule

Relativity.Services.Interfaces.Matter.Models

public class MatterRequest
- public Securable<ObjectIdentifier> Client { get; set; }
- public string Keywords { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public string Number { get; set; }
- public Securable<ObjectIdentifier> Status { get; set; }
- public MatterRequest(MatterResponse response)
- public MatterRequest()
public class MatterResponse : DisplayableObjectIdentifier
- public List<Action> Actions { get; set; }
- public Securable<DisplayableObjectIdentifier> Client { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Meta Meta { get; set; }
- public string Notes { get; set; }
- public string Number { get; set; }
- public Securable<DisplayableObjectIdentifier> Status { get; set; }
- public MatterResponse()

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<SubListObjectIdentifier>> GetAvailableAssociatedObjectsAsync(int workspaceID, int objectTypeID)
- Task<List<SubListObjectIdentifier>> 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 enum ListType
- ChildObject = 1
- MultipleObjectField = 2
- SingleObjectField = 3
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<SubListObjectIdentifier> 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()
- public SubListButtonVisibilityRuleRequest(ObjectRuleResponse objectRuleResponse)
public class SubListObjectIdentifier
- public int ArtifactID { get; set; }
- public int ArtifactTypeID { get; set; }
- public List<Guid> Guids { get; set; }
- public ListType ListType { get; set; }
- public string Name { get; set; }
- public SubListObjectIdentifier()

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

public interface IResourcePoolManager : IDisposable
- Task AddResourceAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)
- Task AddResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources)
- Task AddResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, IProgress<ProgressReport> progress)
- Task AddResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<ResourcePoolResponse> CreateAsync(ResourcePoolRequest resourcePoolRequest)
- Task DeleteAsync(int resourcePoolID)
- Task<QueryResultSlim> QueryClientsAsync(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryClientsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryClientsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleToAddResourcesAsync(int resourcePoolID, string resourceType, QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleToAddResourcesAsync(int resourcePoolID, string resourceType, QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleToAddResourcesAsync(int resourcePoolID, string resourceType, QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryResourcesAsync(int resourcePoolID, string resourceType, QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryResourcesAsync(int resourcePoolID, string resourceType, QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryResourcesAsync(int resourcePoolID, string resourceType, QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<ResourcePoolResponse> ReadAsync(int resourcePoolID)
- Task<ResourcePoolResponse> ReadAsync(int resourcePoolID, bool includeMetadata, bool includeActions)
- Task RemoveResourceAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)
- Task RemoveResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources)
- Task RemoveResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, IProgress<ProgressReport> progress)
- Task RemoveResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<ResourcePoolResponse> UpdateAsync(int resourcePoolID, ResourcePoolRequest resourcePoolRequest)
- Task<ResourcePoolResponse> UpdateAsync(int resourcePoolID, ResourcePoolRequest resourcePoolRequest, DateTime lastModifiedOn)
public interface IResourcePoolModule

Relativity.Services.Interfaces.ResourcePool.Models

public class ResourcePoolRequest : IHaveKeywordsAndNotes
- public Securable<ObjectIdentifier> Client { get; set; }
- public bool IsVisible { get; set; }
- public string Keywords { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public ResourcePoolRequest()
public class ResourcePoolResponse : DisplayableObjectIdentifier, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
- public List<Action> Actions { get; set; }
- public Securable<DisplayableObjectIdentifier> Client { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public bool IsVisible { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Meta Meta { get; set; }
- public string Notes { get; set; }
- public ResourcePoolResponse()

Relativity.Services.Interfaces.Script

public interface IScriptManager : IDisposable
- Task<int> CreateAsync(int workspaceID, ScriptRequest scriptRequest)
- Task DeleteAsync(int workspaceID, int scriptID)
- Task DeleteScriptExecutionAsync(int workspaceID, int scriptID, Guid executionID)
- Task<ScriptExecutionInfo> ExecuteScriptAsync(int workspaceID, int scriptID, List<ScriptInput> inputs)
- Task<ScriptExecutionInfo> ExecuteScriptAsync(int workspaceID, int scriptID, List<ScriptInput> inputs, IProgress<ScriptExecutionProgress> progress)
- Task<KeplerStream> ExportScriptActionResultsAsync(int workspaceID, int scriptID, Guid executionID, Guid actionID)
- Task<List<ScriptExecutionAction>> GetScriptExecutionActionsAsync(int workspaceID, int scriptID, Guid executionID)
- Task<List<ScriptExecutionError>> GetScriptExecutionErrors(int workspaceID, int scriptID, Guid executionID)
- Task<ScriptExecutionStatusInfo> GetScriptExecutionStatusAsync(int workspaceID, int scriptID, Guid executionID)
- Task<ScriptExecutionStatusInfo> GetScriptExecutionStatusAsync(int workspaceID, int scriptID, Guid executionID, IProgress<ScriptExecutionProgress> progress)
- Task<List<ScriptParameterDetails>> GetScriptParametersAsync(int workspaceID, int scriptID)
- Task<int> ImportAsync(int workspaceID, ScriptImportRequest scriptImportRequest)
- Task<string> PreviewScriptAsync(int workspaceID, int scriptID, List<ScriptInput> inputs)
- Task<string> PreviewScriptAsync(int workspaceID, int scriptID, List<ScriptInput> inputs, double timeZoneOffset)
- Task<string> PreviewScriptAsync(int workspaceID, int scriptID, List<ScriptInput> inputs, TimeSpan timeZoneSpan)
- Task<ScriptActionResult> QueryScriptActionResultsAsync(int workspaceID, int scriptID, Guid executionID, Guid actionID, ScriptQueryRequest request)
- Task<ScriptResponse> ReadAsync(int workspaceID, int scriptID)
- Task<ScriptResponse> ReadAsync(int workspaceID, int scriptID, bool includeMetadata, bool includeActions)
- Task UpdateAsync(int workspaceID, int scriptID, ScriptRequest scriptRequest)
- Task UpdateAsync(int workspaceID, int scriptID, ScriptRequest scriptRequest, DateTime lastModifiedOn)
public interface IScriptModule
public class ScriptConstants
- public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/scripts"
- public const string MODULE_PREFIX = "Relativity.Scripts"
- public const string SERVICE_MODULE_NAME = "Script Module"
- public const string SERVICE_NAME = "Script Manager"
- public const string SERVICE_ROUTE = "scripts"
- public ScriptConstants()

Relativity.Services.Interfaces.Scripts.Models

public class MultipleScriptInput : ScriptInput
- public List<string> Value { get; set; }
- public MultipleScriptInput()
public class ScriptActionResult
- public int CurrentStartIndex { get; set; }
- public string ErrorMessage { get; set; }
- public List<ScriptResultField> Fields { get; set; }
- public List<List<object>> Objects { get; set; }
- public int ResultCount { get; set; }
- public bool Success { get; set; }
- public int TotalCount { get; set; }
- public ScriptActionResult()
public enum ScriptActionReturnType
- Status = 1
- Table = 0
public class ScriptExecutionAction
- public Guid ActionID { get; set; }
- public ScriptExecutionDisplayType DisplayType { get; set; }
- public List<ScriptResultField> Fields { get; set; }
- public string Name { get; set; }
- public ScriptActionReturnType ReturnType { get; set; }
- public ScriptExecutionAction()
public enum ScriptExecutionDisplayType
- Report = 1
- Table = 0
public class ScriptExecutionError
- public Guid ActionID { get; set; }
- public string ErrorMessage { get; set; }
- public ScriptExecutionError()
public class ScriptExecutionInfo
- public List<Guid> ActionIDs { get; set; }
- public Guid ExecutionID { get; set; }
- public ScriptExecutionInfo()
public class ScriptExecutionProgress
- public int ScriptID { get; set; }
- public ScriptExecutionStatusInfo Status { get; set; }
- public int WorkspaceID { get; set; }
- public ScriptExecutionProgress()
public enum ScriptExecutionStatus
- Completed = 2
- Errored = 3
- InProgress = 1
- Queued = 0
public class ScriptExecutionStatusInfo
- public ScriptExecutionStatus Status { get; set; }
- public DateTime StatusTime { get; set; }
- public ScriptExecutionStatusInfo()
public class ScriptFieldSort
- public SortEnum Direction { get; set; }
- public string FieldName { get; set; }
- public ScriptFieldSort()
public class ScriptImportRequest
- public ObjectIdentifier LibraryScript { get; set; }
- public List<ObjectIdentifier> RelativityApplications { get; set; }
- public ScriptImportRequest()
public abstract class ScriptInput
- public string ID { get; set; }
- protected ScriptInput()
public class ScriptParameterDetails
- public Dictionary<string, string> Attributes { get; set; }
- public string Id { get; set; }
- public bool IsRequired { get; set; }
- public string Name { get; set; }
- public List<ScriptParameterValue> PossibleValues { get; set; }
- public ScriptParameterType Type { get; set; }
- public ScriptParameterDetails()
public enum ScriptParameterType
- Date = 0
- DateTime = 1
- Field = 6
- Number = 2
- Object = 10
- SavedSearch = 7
- SearchProvider = 8
- Sql = 9
- Text = 3
- Timezone = 5
- User = 4
public class ScriptParameterValue
- public string DisplayValue { get; set; }
- public string Identifier { get; set; }
- public ScriptParameterValue()
public class ScriptQueryRequest
- public string Condition { get; set; }
- public int Length { get; set; }
- public List<ScriptFieldSort> Sorts { get; set; }
- public int StartIndex { get; set; }
- public ScriptQueryRequest()
public class ScriptRequest
- public List<ObjectIdentifier> RelativityApplications { get; set; }
- public string ScriptBody { get; set; }
- public ScriptRequest()
public class ScriptResponse : DisplayableObjectIdentifier
- public List<Action> Actions { get; set; }
- public string Category { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public string Description { get; set; }
- public bool IsLinkedScript { get; set; }
- public string Key { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Meta Meta { get; set; }
- public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
- public string ReportGroupURL { get; set; }
- public string ScriptBody { get; set; }
- public string Version { get; set; }
- public ScriptResponse()
public class ScriptResultField
- public FieldType FieldType { get; set; }
- public string Name { get; set; }
- public ScriptResultField()
public class SingleScriptInput : ScriptInput
- public string Value { get; set; }
- public SingleScriptInput()

Relativity.Services.Interfaces.Scripts.Serialization

public class ScriptInputSerializer : IModelSerializer<ScriptInput>, IModelSerializer
- public ScriptInputSerializer()
- public ScriptInput TransformForDeserialize(object data)
- public object TransformForSerialize(ScriptInput model)

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 interface IPagedResponse
- int CurrentStartIndex { get; set; }
- Action FirstPage { get; set; }
- Action LastPage { get; set; }
- Action NextPage { get; set; }
- Action PreviousPage { get; set; }
- int ResultCount { get; set; }
- int TotalCount { get; set; }
public class KeyboardShortcutCombination
- public bool Alt { get; set; }
- public bool Ctrl { get; set; }
- public int Key { get; set; }
- public bool Shift { get; set; }
- 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 ObjectIdentifier(ObjectIdentifier toCopy)
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 ObjectTypeIdentifier ObjectType { get; set; }
- public int Order { get; set; }
- public Securable<ObjectIdentifier> Parent { get; set; }
- public List<ObjectIdentifier> RelativityApplications { get; set; }
- public TabRequest()
- public TabRequest(TabResponse response)
public class TabResponse : DisplayableObjectIdentifier
- public List<Action> Actions { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public bool? IsDefault { get; set; }
- public bool IsVisible { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public string Link { get; set; }
- public TabLinkTypeEnum LinkType { get; set; }
- public Meta Meta { get; set; }
- public ObjectTypeIdentifier ObjectType { get; set; }
- public int Order { get; set; }
- public Securable<DisplayableObjectIdentifier> 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<UserResponse> CreateAsync(UserRequest userRequest)
- Task DeleteAsync(int userID)
- Task DeleteAsync(int userID, IProgress<ProgressReport> progress)
- Task DeleteAsync(int userID, CancellationToken cancel)
- Task DeleteAsync(int userID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<List<DisplayableObjectIdentifier>> GetAvailableTypesAsync()
- Task<UserResponse> ReadAsync(int userID)
- Task<UserResponse> ReadAsync(int userID, bool includeMetadata, bool includeActions)
- Task<UserSettingResponse> ReadSettingsAsync()
- Task<UserSettingResponse> ReadSettingsAsync(bool includeMetadata, bool includeActions)
- Task<List<UserInfo>> RetrieveAll(int workspaceID)
- Task<UserInfoQueryResultSet> RetrieveUsersBy(int workspaceID, QueryRequest query, int start, int length)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, IProgress<ProgressReport> progress)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, CancellationToken cancel)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn, IProgress<ProgressReport> progress)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn, CancellationToken cancel)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, IProgress<ProgressReport> progress)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, CancellationToken cancel)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, IProgress<ProgressReport> progress)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, CancellationToken cancel)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, CancellationToken cancel, IProgress<ProgressReport> progress)
public interface IUserInfoModule

Relativity.Services.Interfaces.UserInfo.Models

public enum DocumentViewer
- ActiveX = 2
- Default = 0
- HTML = 1
public enum DocumentViewerFileType
- Default = 0
- Image = 2
- LongText = 3
- Native = 4
- Production = 5
- Viewer = 1
public class DocumentViewerProperties
- public bool AllowDocumentSkipPreferenceChange { get; set; }
- public bool AllowDocumentViewerChange { get; set; }
- public bool AllowKeyboardShortcuts { get; set; }
- public DocumentViewerFileType DefaultSelectedFileType { get; set; }
- public DocumentViewer DocumentViewer { get; set; }
- public bool SkipDefaultPreference { get; set; }
- public DocumentViewerProperties()
public enum EmailPreference
- All = 1
- Default = 0
- ErrorOnly = 2
- None = 3
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()
public class UserRequest
- public bool AllowSettingsChange { get; set; }
- public Securable<ObjectIdentifier> Client { get; set; }
- public bool DefaultFilterVisibility { get; set; }
- public DateTime? DisableOnDate { get; set; }
- public DocumentViewerProperties DocumentViewerProperties { get; set; }
- public string EmailAddress { get; set; }
- public EmailPreference EmailPreference { get; set; }
- public string FirstName { get; set; }
- public int ItemListPageLength { get; set; }
- public string Keywords { get; set; }
- public string LastName { get; set; }
- public string Notes { get; set; }
- public bool RelativityAccess { get; set; }
- public bool SavedSearchDefaultsToPublic { get; set; }
- public string TrustedIPs { get; set; }
- public ObjectIdentifier Type { get; set; }
- public UserRequest()
- public UserRequest(UserResponse userResponse)
- public static UserRequest op_Implicit(UserResponse response)
public class UserResponse : ObjectIdentifier
- public List<Action> Actions { get; set; }
- public bool AllowSettingsChange { get; set; }
- public Securable<DisplayableObjectIdentifier> Client { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public bool DefaultFilterVisibility { get; set; }
- public DateTime? DisableOnDate { get; set; }
- public DocumentViewerProperties DocumentViewerProperties { get; set; }
- public string EmailAddress { get; set; }
- public EmailPreference EmailPreference { get; set; }
- public string FirstName { get; set; }
- public int ItemListPageLength { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public string LastName { get; set; }
- public Meta Meta { get; set; }
- public string Notes { get; set; }
- public bool RelativityAccess { get; set; }
- public bool SavedSearchDefaultsToPublic { get; set; }
- public string TrustedIPs { get; set; }
- public DisplayableObjectIdentifier Type { get; set; }
- public UserResponse()
public class UserSettingRequest
- public bool DefaultFilterVisibility { get; set; }
- public DocumentViewerFileType DefaultSelectedFileType { get; set; }
- public string EmailAddress { get; set; }
- public EmailPreference EmailPreference { get; set; }
- public string FirstName { get; set; }
- public int ItemListPageLength { get; set; }
- public string LastName { get; set; }
- public bool SavedSearchDefaultsToPublic { get; set; }
- public bool SkipDefaultPreference { get; set; }
- public UserSettingRequest()
- public UserSettingRequest(UserSettingResponse userSettingResponse)
- public static UserSettingRequest op_Implicit(UserSettingResponse response)
public class UserSettingResponse
- public List<Action> Actions { get; set; }
- public bool DefaultFilterVisibility { get; set; }
- public DocumentViewerFileType DefaultSelectedFileType { get; set; }
- public string EmailAddress { get; set; }
- public EmailPreference EmailPreference { get; set; }
- public string FirstName { get; set; }
- public int ItemListPageLength { get; set; }
- public string LastName { get; set; }
- public Meta Meta { get; set; }
- public bool SavedSearchDefaultsToPublic { get; set; }
- public bool SkipDefaultPreference { get; set; }
- public UserSettingResponse()

Relativity.Services.Interfaces.ViewField

public interface IViewFieldManager : IDisposable
- Task<ViewFieldResponse[]> ReadExportableViewFieldsAsync(int workspaceID, int artifactTypeID)
- Task<ViewFieldIDResponse[]> ReadViewFieldIDsFromProductionAsync(int workspaceID, int productionArtifactID)
- 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.Interfaces.Workspace

public interface IWorkspaceManager : IDisposable
- Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest)
- Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest, IProgress<ProgressReport> progress)
- Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest, CancellationToken cancel)
- Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task DeleteAsync(int workspaceID)
- Task DeleteAsync(int workspaceID, IProgress<ProgressReport> progress)
- Task DeleteAsync(int workspaceID, CancellationToken cancel)
- Task DeleteAsync(int workspaceID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<List<DisplayableObjectIdentifier>> GetEligibleCacheLocations(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleFileRepositories(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleResourcePools()
- Task<List<string>> GetEligibleSqlFullTextLanguages()
- Task<List<DisplayableObjectIdentifier>> GetEligibleSqlServers(int resourcePoolID)
- Task<List<DisplayableObjectIdentifier>> GetEligibleStatuses()
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleGroups(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleMatters(QueryRequest request, int start, int length, int client, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleSavedSearches(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length, CancellationToken cancel)
- Task<QueryResultSlim> QueryEligibleTemplates(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID)
- Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID, IProgress<ProgressReport> progress)
- Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID, CancellationToken cancel)
- Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID, CancellationToken cancel, IProgress<ProgressReport> progress)
- Task<WorkspaceResponse> ReadAsync(int workspaceID)
- Task<WorkspaceResponse> ReadAsync(int workspaceID, bool includeMetadata, bool includeActions)
- Task<WorkspaceResponse> UpdateAsync(int workspaceID, WorkspaceRequest workspaceRequest)
- Task<WorkspaceResponse> UpdateAsync(int workspaceID, WorkspaceRequest workspaceRequest, DateTime lastModifiedOn)
public interface IWorkspaceModule

Relativity.Services.Interfaces.Workspace.Models

public class ResourceInformation<TObjectIdentifier> where TObjectIdentifier : ObjectIdentifier
- public Securable<TObjectIdentifier> DataGridFileRepository { get; set; }
- public Securable<TObjectIdentifier> DefaultCacheLocation { get; set; }
- public Securable<TObjectIdentifier> DefaultFileRepository { get; set; }
- public TObjectIdentifier ResourcePool { get; set; }
- public Securable<TObjectIdentifier> SqlServer { get; set; }
- public ResourceInformation()
public class WorkspaceRequest
- public Securable<ObjectIdentifier> Client { get; set; }
- public string DownloadHandlerUrl { get; set; }
- public bool EnableDataGrid { get; set; }
- public string Keywords { get; set; }
- public Securable<ObjectIdentifier> Matter { get; set; }
- public string Name { get; set; }
- public string Notes { get; set; }
- public Securable<ObjectIdentifier> ProductionRestrictions { get; set; }
- public Securable<ResourceInformation<ObjectIdentifier>> ResourceInformation { get; set; }
- public string SqlFullTextLanguage { get; set; }
- public ObjectIdentifier Status { get; set; }
- public Securable<ObjectIdentifier> Template { get; set; }
- public Securable<ObjectIdentifier> WorkspaceAdminGroup { get; set; }
- public WorkspaceRequest()
- public WorkspaceRequest(WorkspaceResponse workspaceResponse)
- public static WorkspaceRequest op_Implicit(WorkspaceResponse response)
public class WorkspaceResponse : DisplayableObjectIdentifier
- public List<Action> Actions { get; set; }
- public Securable<DisplayableObjectIdentifier> Client { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public string DownloadHandlerUrl { get; set; }
- public bool EnableDataGrid { get; set; }
- public string Keywords { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public Securable<DisplayableObjectIdentifier> Matter { get; set; }
- public Meta Meta { get; set; }
- public string Notes { get; set; }
- public Securable<DisplayableObjectIdentifier> ProductionRestrictions { get; set; }
- public Securable<ResourceInformation<DisplayableObjectIdentifier>> ResourceInformation { get; set; }
- public string SqlFullTextLanguage { get; set; }
- public ObjectIdentifier Status { get; set; }
- public Securable<DisplayableObjectIdentifier> Template { get; set; }
- public Securable<DisplayableObjectIdentifier> WorkspaceAdminGroup { get; set; }
- public WorkspaceResponse()

Relativity.Services.ItemListView

public class PermissionResultSet
- public bool CanPreviewDocument { get; set; }
- 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.Matter

public class MatterConstants
- public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/matters"
- public const string MODULE_PREFIX = "Relativity.Matters"
- public const string SERVICE_MODULE_NAME = "Matter Module"
- public const string SERVICE_NAME = "Matter Manager"
- public const string SERVICE_ROUTE = "matters"
- public MatterConstants()

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<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest)
- Task<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest, CancellationToken cancel)
- Task<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest, IProgress<MassOperationsStateProgress> progress)
- Task<MassCreateResult> CreateAsync(int workspaceID, MassCreateRequest massRequest, CancellationToken cancel, IProgress<MassOperationsStateProgress> 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)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, CancellationToken cancel)
- 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<RelativityObjectSlim[]> RetrieveResultsBlockFromExportAsync(int workspaceID, Guid runID, int resultsBlockSize, int exportIndexID)
- Task<IKeplerStream> StreamLongTextAsync(int workspaceID, RelativityObjectRef exportObject, FieldRef longTextField)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, MassUpdateOptions options, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, MassUpdateOptions options, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, CancellationToken cancel, 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 class FileObject
- public int FileFieldArtifactID { get; set; }
- public int FileID { get; set; }
- public string FileName { get; set; }
- public FileObject()
public interface IHasArtifactID : IHasIdentifyingInformation
- int ArtifactID { get; set; }
public interface IHasArtifactTypeID : IHasIdentifyingInformation
- int ArtifactTypeID { get; set; }
public interface IHasGuid : IHasIdentifyingInformation
- Guid? Guid { get; set; }
public interface IHasGuids : IHasIdentifyingInformation
- List<Guid> Guids { get; set; }
public interface IHasIdentifyingInformation
public interface IHasName : IHasIdentifyingInformation
- string Name { get; set; }
public interface IHasObjectIdentificationCriteria
- ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
public interface IHasViewFieldID : IHasIdentifyingInformation
- int ViewFieldID { get; set; }
public interface IObjectType : IHasArtifactID, IHasIdentifyingInformation, IHasName, IHasArtifactTypeID
public interface IRelativityObject
- FieldValuePair this[int artifactId] { get; }
- bool FieldValuePairExists(int artifactId)
public class MassCreateRequest
- public IReadOnlyList<FieldRef> Fields { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public RelativityObjectRef ParentObject { get; set; }
- public IReadOnlyList<IReadOnlyList<object>> ValueLists { get; set; }
- public MassCreateRequest()
public class MassCreateResult
- public string Message { get; set; }
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public bool Success { get; set; }
- public MassCreateResult()
public class MassDeleteByCriteriaRequest : IHasObjectIdentificationCriteria
- public ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
- public MassDeleteByCriteriaRequest()
public class MassDeleteByObjectIdentifiersRequest
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public MassDeleteByObjectIdentifiersRequest()
public class MassDeleteResult
- public string Message { get; set; }
- public DeleteReport Report { get; set; }
- public bool Success { get; set; }
- public MassDeleteResult()
public class MassOperationsStateProgress
- public double PercentageComplete { get; set; }
- public MassOperationsStateProgress()
public class MassUpdateByCriteriaRequest : IHasObjectIdentificationCriteria
- public IEnumerable<FieldRefValuePair> FieldValues { get; set; }
- public ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
- public MassUpdateByCriteriaRequest()
public class MassUpdateByObjectIdentifiersRequest
- public IEnumerable<FieldRefValuePair> FieldValues { get; set; }
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public MassUpdateByObjectIdentifiersRequest()
public class MassUpdateOptions
- public FieldUpdateBehavior UpdateBehavior { get; set; }
- public MassUpdateOptions()
public class MassUpdatePerObjectsRequest
- public IReadOnlyList<FieldRef> Fields { get; set; }
- public IReadOnlyList<ObjectRefValuesPair> ObjectValues { get; set; }
- public MassUpdatePerObjectsRequest()
public class MassUpdateResult
- public string Message { get; set; }
- public bool Success { get; set; }
- public int TotalObjectsUpdated { get; set; }
- public MassUpdateResult()
public class ObjectIdentificationCriteria
- public string Condition { get; set; }
- public int? ExecutingSavedSearchID { get; set; }
- public int? ExecutingViewID { get; set; }
- public bool IsAdhocQuery { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public string QueryHint { get; set; }
- public FieldRef RelationalField { get; set; }
- public string RowCondition { get; set; }
- public SearchProviderCondition SearchProviderCondition { get; set; }
- public ObjectIdentificationCriteria()
public class ObjectRefValuesPair
- public RelativityObjectRef Object { get; set; }
- public IReadOnlyList<object> Values { get; set; }
- public ObjectRefValuesPair()
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 ExpandoObjectExtensions
- public static FileObject ToFileObject(this ExpandoObject expando)
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.Objects.Serialization

public class QueryResultSlimSerializer : IModelSerializer<QueryResultSlim>, IModelSerializer
- public QueryResultSlimSerializer()
- public QueryResultSlim TransformForDeserialize(object data)
- public object TransformForSerialize(QueryResultSlim model)

Relativity.Services.Permission

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

Relativity.Services.Pipeline

public static class Constants
- public static class CodeGen
public class FilesystemUtilities : IFilesystemUtilities
- public FilesystemUtilities()
- public void CacheObject<T>(T objectToCache, string cacheFile)
- public void CleanDirectory(string dirPath)
- public void EnsureDirectory(string dirPath)
- public string GenerateHash(string relativePath, List<string> filePaths)
- public string GetCodeGenNamespace(string pipelineTag, WireProtocolVersion protocol)
- public string GetHostingDir(string targetDir, WireProtocolVersion protocol)
- public string GetOutputDir(string targetDir, WireProtocolVersion protocol)
- public string GetOutputDLLName(string pipelineTag, WireProtocolVersion protocol)
- public string GetSourceCodeDir(string targetDir, WireProtocolVersion protocol)
- public T OpenCachedObject<T>(string cacheFile)
- public string ReadHash(string hashLocation)
- public void WriteHash(string hashLocation, string hashString)
public interface IFilesystemUtilities
- void CacheObject<T>(T objectToCache, string cacheFile)
- void CleanDirectory(string dirPath)
- void EnsureDirectory(string dirPath)
- string GenerateHash(string relativePath, List<string> filePaths)
- string GetCodeGenNamespace(string pipelineTag, WireProtocolVersion protocol)
- string GetHostingDir(string targetDir, WireProtocolVersion protocol)
- string GetOutputDir(string targetDir, WireProtocolVersion protocol)
- string GetOutputDLLName(string pipelineTag, WireProtocolVersion protocol)
- string GetSourceCodeDir(string targetDir, WireProtocolVersion protocol)
- T OpenCachedObject<T>(string cacheFile)
- string ReadHash(string hashLocation)
- void WriteHash(string hashLocation, string hashString)
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.ResourcePool

public class ResourcePoolRef
- public bool? IsVisible { get; set; }

Relativity.Services.ResourceServer

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

Relativity.Services.Review.DynamicReviewQueue

public class DocumentSqlView
- public int DocumentCount { get; set; }
- public string DocumentIdColumnName { get; set; }
- public string Name { get; set; }
- public string Schema { get; set; }
- public DocumentSqlView()
public class DynamicDocumentReviewState : ReviewerStatus
- public List<int> AssignedDocumentArtifactIDs { get; set; }
public class DynamicReviewQueue
- public int AssociatedViewID { get; set; }
- public int? RelatedFieldArtifactID { get; set; }
public class DynamicReviewQueueRef
public class ReviewerStatus
- public int DocumentReviewCount { get; set; }

Relativity.Services.Search

public interface IKeywordSearchManager : IDisposable
- Task<SearchAccessStatus> GetAccessStatusAsync(int workspaceArtifactID, int artifactID)

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 class User : UserRef
- public DateTime CreatedOn { get; set; }
public interface IUserManager : IDisposable
- Task<WorkspaceUserData> RetrieveAllActiveWithLimitAsync(int workspaceId, bool includeCurrentUser)
- Task<WorkspaceUserData> RetrieveAllWithRelativityAccessAsync(int workspaceId)

Relativity.Services.ViewManager.Models

public class SearchViewResponse
- public int ArtifactID { get; set; }
- public string ArtifactType { get; set; }
- public int ArtifactTypeID { get; set; }
- public bool AvailableInObjectTab { get; set; }
- public int? DashboardArtifactID { get; set; }
- public int? DisplayFieldArtifactID { get; set; }
- public int? GroupDefinitionFieldArtifactID { get; set; }
- public bool IsManualRerun { get; set; }
- public bool IsReport { get; set; }
- public bool IsVisible { get; set; }
- public string Name { get; set; }
- public int? Order { get; set; }
- public int? PayloadFieldArtifactID { get; set; }
- public string QueryHint { get; set; }
- public bool RenderLinks { get; set; }
- public int? SearchProviderID { get; set; }
- public string SearchText { get; set; }
- public int? ThreadMethod { get; set; }
- public string Type { get; set; }
- public int ViewByFamily { get; set; }
- public int VisualizationType { get; set; }
- public SearchViewResponse()
public class ViewResponse
- public int ArtifactID { get; set; }
- public int ArtifactTypeID { get; set; }
- public bool AvailableInObjectTab { get; set; }
- public int? DashboardArtifactID { get; set; }
- public int? DisplayFieldArtifactID { get; set; }
- public int? GroupDefinitionFieldArtifactID { get; set; }
- public bool IsManualRerun { get; set; }
- public bool IsReport { get; set; }
- public bool IsVisible { get; set; }
- public string Name { get; set; }
- public int? Order { get; set; }
- public int? PayloadFieldArtifactID { get; set; }
- public string QueryHint { get; set; }
- public bool RenderLinks { get; set; }
- public int? SearchProviderID { get; set; }
- public string SearchText { get; set; }
- public int? ThreadMethod { get; set; }
- public string Type { get; set; }
- public int ViewByFamily { get; set; }
- public int VisualizationType { get; set; }
- public ViewResponse()

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 11.0.162.34 and 9.6.125.89

Relativity.Kepler.Transport

Relativity.Services.ChoiceQuery

Relativity.Services.DBStatus

Relativity.Services.DataContracts.DTOs.DynamicReviewQueue

Relativity.Services.DataContracts.DTOs.EmailNotifications

Relativity.Services.DataContracts.DTOs.ItemListView

Relativity.Services.DataContracts.DTOs.Results

Relativity.Services.DataContracts.ImportExport

Relativity.Services.DataGridCheckSyntax

Relativity.Services.EmailNotificationsManager

Relativity.Services.EmailValidation.Models

Relativity.Services.Exceptions

Relativity.Services.Field.Models

Relativity.Services.FileField

Relativity.Services.FileField.Models

Relativity.Services.Files

Relativity.Services.Interfaces.Agent

Relativity.Services.Interfaces.Agent.Models

Relativity.Services.Interfaces.Application

Relativity.Services.Interfaces.Application.Models

Relativity.Services.Interfaces.Choice

Relativity.Services.Interfaces.Choice.Models

Relativity.Services.Interfaces.Client

Relativity.Services.Interfaces.Client.Models

Relativity.Services.Interfaces.Document

Relativity.Services.Interfaces.Document.Models

Relativity.Services.Interfaces.EmailValidation

Relativity.Services.Interfaces.EventHandler

Relativity.Services.Interfaces.EventHandler.Models

Relativity.Services.Interfaces.Field

Relativity.Services.Interfaces.Field.Models

Relativity.Services.Interfaces.File

Relativity.Services.Interfaces.File.Models

Relativity.Services.Interfaces.Group

Relativity.Services.Interfaces.Group.Models

Relativity.Services.Interfaces.InstanceSetting

Relativity.Services.Interfaces.InstanceSetting.Model

Relativity.Services.Interfaces.LibraryApplication

Relativity.Services.Interfaces.LibraryApplication.Models

Relativity.Services.Interfaces.MassOperation

Relativity.Services.Interfaces.MassOperation.Models

Relativity.Services.Interfaces.Matter

Relativity.Services.Interfaces.Matter.Models

Relativity.Services.Interfaces.ObjectRules

Relativity.Services.Interfaces.ObjectRules.Models

Relativity.Services.Interfaces.ObjectType

Relativity.Services.Interfaces.ObjectType.Models

Relativity.Services.Interfaces.ResourcePool

Relativity.Services.Interfaces.ResourcePool.Models

Relativity.Services.Interfaces.Script

Relativity.Services.Interfaces.Scripts.Models

Relativity.Services.Interfaces.Scripts.Serialization

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.Interfaces.Workspace

Relativity.Services.Interfaces.Workspace.Models

Relativity.Services.ItemListView

Relativity.Services.KeyboardShortcuts

Relativity.Services.KeyboardShortcuts.Models

Relativity.Services.Matter

Relativity.Services.Notifications

Relativity.Services.Objects

Relativity.Services.Objects.DataContracts

Relativity.Services.Objects.Exceptions

Relativity.Services.Objects.Extensions

Relativity.Services.Objects.Helpers

Relativity.Services.Objects.Serialization

Relativity.Services.Permission

Relativity.Services.Pipeline