Relativity.ObjectManager 10.3.142.22

API Differences between 10.3.142.22 and 10.2.270.1

742 Additions 26 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.DataContracts.DTOs.DynamicReviewQueue

public class DynamicReviewQueueDocument
- public int? FamilyOrder { get; set; }
- public int? LeadDocumentID { get; set; }
- public long ReviewOrder { get; set; }

Relativity.Services.DataGridCheckSyntax

public class CheckSyntaxResult
public interface IDataGridCheckSyntaxModule
public interface IDataGridCheckSyntaxService : IDisposable
public class QuerySyntaxWarning : SyntaxWarning
public class SyntaxWarning

Relativity.Services.EmailNotificationsManager

public interface IEmailNotificationsManager : IDisposable
- Task<EmailNotificationResponse> SendEmailNotificationAsync(string applicationId, EmailNotificationRequest request)

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

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

Relativity.Services.FileField

public interface IFileFieldManager : IDisposable
- Task<DynamicFileResponse[]> GetFilesForDynamicObjectsAsync(int workspaceID, int fileFieldArtifactID, int[] objectIDs)

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.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 MODULE_PREFIX = "Relativity.Choices"
public interface IChoiceManager : IDisposable
- Task<ChoiceResponse> ReadAsync(int workspaceID, int choiceID, bool includeActions)
- Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid, bool includeActions)
- Task<ChoiceResponse> ReadAsync(int workspaceID, int choiceID, bool includeMetadata, bool includeActions)
- Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid, bool includeMetadata, bool includeActions)

Relativity.Services.Interfaces.Choice.Models

public class ChoiceResponse : DisplayableObjectIdentifier
- public Meta Meta { get; set; }

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

public class DtSearchIndexConstants
public interface IDtSearchIndexManager : IDisposable
public interface IDtSearchIndexModule

Relativity.Services.Interfaces.DtSearchIndexManager.Models

public class DtSearchIndexRequest
public class DtSearchIndexResponse
public class DtSearchIndexStatus
public class DtSearchSubIndexResponse

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

public class BaseFieldRequest
- public string Source { get; set; }
public class FieldResponse : DisplayableObjectIdentifier
- public string FriendlyName { get; set; }
- public ImportBehavior ImportBehavior { get; set; }
- public bool IsRelational { get; set; }
- public int Order { get; set; }
- public PaneIcon PaneIcon { get; set; }
- public Securable<DisplayableObjectIdentifier> RelationalView { get; set; }
- public FieldSource Source { get; set; }
public class FieldSource
- public string FriendlyName { get; set; }
- public string SourceName { get; set; }
- public FieldSource()
public enum FilterType
- DatePicker = 7
public class FixedLengthFieldRequest : BaseFieldRequest
- public string FriendlyName { get; set; }
- public ImportBehavior ImportBehavior { get; set; }
- public int Order { get; set; }
- public PaneIcon PaneIcon { get; set; }
- public Securable<ObjectIdentifier> RelationalView { get; set; }
public class PaneIcon
- public string FileName { get; set; }
- public string ImageBase64 { get; set; }
- public PaneIcon()

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

public interface IApplicationInstallManager : IDisposable
- 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 DeleteAsync(int workspaceID, int applicationID)
- Task DeleteAsync(int workspaceID, Guid applicationGuid)
- 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)
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 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.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.Script

public interface IScriptManager : IDisposable
- Task<int> CreateAsync(int workspaceID, ScriptRequest scriptRequest)
- Task DeleteAsync(int workspaceID, int scriptID)
- Task<ScriptResult> ExecuteScriptAsync(int workspaceID, int scriptID, List<ScriptInput> inputs)
- 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<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 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 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 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.Shared.Models

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; }

Relativity.Services.Interfaces.Tab.Models

public class TabRequest
- public Securable<RelativityObjectRef> ObjectArtifactTypeID { get; set; }
- public ObjectTypeIdentifier ObjectType { get; set; }
- public Securable<RelativityObjectRef> ParentID { get; set; }
- public Securable<ObjectIdentifier> Parent { get; set; }
- public TabRequest(TabResponse response)
public class TabResponse : DisplayableObjectIdentifier
- public int ArtifactID { get; set; }
- public NameIDPair CreatedBy { get; set; }
- public DisplayableObjectIdentifier CreatedBy { get; set; }
- public NameIDPair LastModifiedBy { get; set; }
- public DisplayableObjectIdentifier LastModifiedBy { get; set; }
- public string Name { get; set; }
- public Securable<NameIDPair> ObjectType { get; set; }
- public ObjectTypeIdentifier ObjectType { get; set; }
- public Securable<NameIDPair> Parent { get; set; }
- public Securable<DisplayableObjectIdentifier> Parent { get; set; }

Relativity.Services.Interfaces.UserInfo

public interface IUserInfoManager : IDisposable
- Task<UserResponse> CreateAsync(UserRequest userRequest)
- Task DeleteAsync(int userID)
- 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<UserResponse> UpdateAsync(int userID, UserRequest userRequest)
- Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest)
- Task<UserSettingResponse> UpdateAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn)
public class UserConstants

Relativity.Services.Interfaces.UserInfo.Models

public enum DocumentSkip
- Default = 0
- Disabled = 2
- Enabled = 1
- ForceEnabled = 3
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 AllowDocumentViewerChange { get; set; }
- public bool AllowKeyboardShortcuts { get; set; }
- public DocumentViewerFileType DefaultSelectedFileType { get; set; }
- public DocumentSkip DocumentSkip { get; set; }
- public DocumentViewer DocumentViewer { get; set; }
- public bool SkipDefaultPreference { get; set; }
- public DocumentViewerProperties()
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 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 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 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 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<ViewFieldIDResponse[]> ReadViewFieldIDsFromProductionAsync(int workspaceID, int artifactTypeID, int viewArtifactID)
- Task<ViewFieldIDResponse[]> ReadViewFieldIDsFromProductionAsync(int workspaceID, int productionArtifactID)

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

public interface IObjectManager : IDisposable
- Task<RelativityObjectSlim[]> RetrieveResultsBlockFromExportAsync(int workspaceID, Guid runID, int resultsBlockSize, int exportIndexID)

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)

Relativity.Services.ResourcePool

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

Relativity.Services.ResourceServer

public class CacheLocationResourceServer : ResourceServerRef
- public string FriendlyName { get; set; }
public class FileShareResourceServer : ResourceServerRef
- public string FriendlyName { get; set; }

Relativity.Services.Review.DynamicReviewQueue

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

public class ScriptResult
- public string ErrorMessage { get; set; }
- public List<ScriptTableResult> Results { get; set; }
- public bool Success { get; set; }
- public ScriptResult()
public class ScriptTableResult
- public int Count { get; set; }
- public string Name { get; set; }
- public List<Dictionary<string, string>> Rows { get; set; }
- public ScriptTableResult()

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