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

---

API Differences between 11.2.127.49 and 10.0.119.1

2927 Additions 64 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 DynamicReviewQueueChoiceCount
  • public bool AreFamilyDocuments { get; set; }
• 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 double AverageFamilySize { get; set; }
  • public int FamilyCount { get; set; }
  • public int FiftiethPercentileSize { get; set; }
  • public int MaxFamilySize { get; set; }
  • public int SeventyFifthPercentileSize { get; set; }
  • public int TwentyFifthPercentileSize { 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.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(EmailNotificationRequest request)
• public interface IEmailNotificationsModule

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 SearchProviderException : ServiceException
  • public SearchProviderException()
  • public SearchProviderException(string message)
  • public SearchProviderException(string message, Exception innerException)
  • protected SearchProviderException(SerializationInfo info, StreamingContext context)
• public class TemporarilyUnavailableException : ServiceException
  • public TemporarilyUnavailableException()
  • public TemporarilyUnavailableException(string message)
  • public TemporarilyUnavailableException(string message, Exception innerException)
  • protected TemporarilyUnavailableException(SerializationInfo info, StreamingContext context)

Relativity.Services.Field.Models

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

Relativity.Services.FieldMapping

• public interface IFieldMapping : IDisposable
  • Task<bool> UpdateExternalMappingWithoutValidationAsync(int workspaceArtifactId, ExternalMapping model)

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

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

Relativity.Services.Interfaces.Agent.Models

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

Relativity.Services.Interfaces.Choice

• public static class ChoiceConstants
  • public const string CHOICE_ROUTE = "choice"
  • public 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 ActivateClientDomainAsync(int clientID)
  • Task ActivateClientDomainAsync(int clientID, IProgress<ProgressReport> progress)
  • Task ActivateClientDomainAsync(int clientID, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<ClientResponse> CreateAsync(ClientRequest clientRequest)
  • Task<string> CreateClientDomainRequestKeyAsync(int clientID)
  • 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 SubmitClientDomainActivationKeyAsync(int clientID, string activationKey)
  • Task SubmitClientDomainActivationKeyAsync(int clientID, string activationKey, IProgress<ProgressReport> progress)
  • Task SubmitClientDomainActivationKeyAsync(int clientID, string activationKey, CancellationToken cancel, IProgress<ProgressReport> progress)
  • 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.EventHandler.ObjectType

• public interface IEventHandlerManager

Relativity.Services.Interfaces.Field

• public class FieldConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}"
  • public const string MODULE_PREFIX = "Relativity.Fields"
  • public FieldConstants()
• public interface IFieldManager : IDisposable
  • Task<int> CreateCurrencyFieldAsync(int workspaceID, CurrencyFieldRequest fieldRequest)
  • Task<int> CreateDateFieldAsync(int workspaceID, DateFieldRequest fieldRequest)
  • Task<int> CreateDecimalFieldAsync(int workspaceID, DecimalFieldRequest fieldRequest)
  • Task<int> CreateFileFieldAsync(int workspaceID, FileFieldRequest fieldRequest)
  • Task<int> CreateFixedLengthFieldAsync(int workspaceID, FixedLengthFieldRequest fieldRequest)
  • Task<int> CreateLongTextFieldAsync(int workspaceID, LongTextFieldRequest fieldRequest)
  • Task<int> CreateMultipleChoiceFieldAsync(int workspaceID, MultipleChoiceFieldRequest fieldRequest)
  • Task<int> CreateMultipleObjectFieldAsync(int workspaceID, MultipleObjectFieldRequest fieldRequest)
  • Task<int> CreateSingleChoiceFieldAsync(int workspaceID, SingleChoiceFieldRequest fieldRequest)
  • Task<int> CreateSingleObjectFieldAsync(int workspaceID, SingleObjectFieldRequest fieldRequest)
  • Task<int> CreateUserFieldAsync(int workspaceID, UserFieldRequest fieldRequest)
  • Task<int> CreateWholeNumberFieldAsync(int workspaceID, WholeNumberFieldRequest fieldRequest)
  • Task<int> CreateYesNoFieldAsync(int workspaceID, YesNoFieldRequest fieldRequest)
  • Task DeleteAsync(int workspaceID, int fieldID)
  • Task<List<KeyboardShortcut>> GetAvailableKeyboardShortcutsAsync(int workspaceID)
  • Task<List<ObjectTypeIdentifier>> GetAvailableMultiAssociativeObjectTypesAsync(int workspaceID, ObjectTypeIdentifier objectType)
  • Task<List<ObjectTypeIdentifier>> GetAvailableObjectTypesAsync(int workspaceID)
  • Task<List<Securable<DisplayableObjectIdentifier>>> GetAvailableObjectTypeViewsAsync(int workspaceID, ObjectTypeIdentifier objectType)
  • Task<List<DisplayableObjectIdentifier>> GetAvailablePropagateToFieldsAsync(int workspaceID)
  • Task<List<ObjectTypeIdentifier>> GetAvailableSingleAssociativeObjectTypesAsync(int workspaceID, ObjectTypeIdentifier objectType)
  • Task<List<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<List<Action>> GetMassActionsAsync()
  • Task<List<MassOperationResult>> MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups)
  • Task<List<MassOperationResult>> MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, IProgress<ProgressReport> progress)
  • Task<List<MassOperationResult>> MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<List<MassOperationResult>> MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups)
  • Task<List<MassOperationResult>> MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, IProgress<ProgressReport> progress)
  • Task<List<MassOperationResult>> MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, CancellationToken cancel, IProgress<ProgressReport> progress)
  • 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, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users)
  • Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleUsersToAdd(QueryRequest request, int start, int length, int groupID)
  • Task<QueryResultSlim> QueryEligibleUsersToAdd(QueryRequest request, int start, int length, int groupID, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleUsersToAdd(QueryRequest request, int start, int length, int groupID, 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.Layout

• public interface ILayoutManager : IDisposable
  • Task<LayoutResponse> CreateAsync(int workspaceID, LayoutRequest layoutRequest)
  • Task DeleteAsync(int workspaceID, int layoutID)
  • Task<List<DisplayableObjectIdentifier>> GetEligibleOwnersAsync(int workspaceID)
  • Task<LayoutResponse> ReadAsync(int workspaceID, int layoutID)
  • Task<LayoutResponse> ReadAsync(int workspaceID, int layoutID, bool includeMetadata, bool includeActions)
  • Task<LayoutResponse> UpdateAsync(int workspaceID, int layoutID, LayoutRequest layoutRequest)
  • Task<LayoutResponse> UpdateAsync(int workspaceID, int layoutID, LayoutRequest layoutRequest, DateTime lastModifiedOn)
• public interface ILayoutModule
• public class LayoutConstants
  • public const string BASE_SERVICE_ROUTE = "workspace/{workspaceID:int}/layouts"
  • public const string LAYOUT_ID_STRING = "layoutID"
  • public const string MODULE_PREFIX = "Relativity.Layouts"
  • public const string SERVICE_MODULE_NAME = "Layout Module"
  • public const string SERVICE_NAME = "Layout Manager"
  • public const string SERVICE_ROUTE = "layouts"
  • public LayoutConstants()

Relativity.Services.Interfaces.Layout.Models

• public class LayoutRequest
  • public bool AllowCopyFromPrevious { get; set; }
  • public string Keywords { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public Securable<ObjectTypeIdentifier> ObjectType { get; set; }
  • public string Order { get; set; }
  • public bool OverwriteProtection { get; set; }
  • public ObjectIdentifier Owner { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { get; set; }
  • public LayoutRequest()
  • public LayoutRequest(LayoutResponse layoutResponse)
• public class LayoutResponse : DisplayableObjectIdentifier, IHaveMetaAndActions, IHaveKeywordsAndNotes, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public bool AllowCopyFromPrevious { 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 Securable<ObjectTypeIdentifier> ObjectType { get; set; }
  • public string Order { get; set; }
  • public bool OverwriteProtection { get; set; }
  • public DisplayableObjectIdentifier Owner { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }
  • public LayoutResponse()

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<IKeplerStream> GetApplicationInstallDetailsReportAsync(int workspaceID, int applicationID, int applicationInstallID)
  • Task<IKeplerStream> GetApplicationInstallDetailsReportAsync(int workspaceID, Guid applicationGuid, int applicationInstallID)
  • Task<ApplicationInstallSearchResponse> GetAvailableWorkspacesAsync(int workspaceID, int applicationID, QueryOptions queryOptions, int start = 1, int length = 10, bool includeActions = false)
  • Task<ApplicationInstallSearchResponse> GetAvailableWorkspacesAsync(int workspaceID, Guid applicationGuid, QueryOptions queryOptions, int start = 1, int length = 10, bool includeActions = false)
  • Task<GetOutdatedWorkspacesResponse> GetOutdatedWorkspacesCount(int workspaceID, int applicationID)
  • Task<GetOutdatedWorkspacesResponse> GetOutdatedWorkspacesCount(int workspaceID, Guid applicationGuid)
  • 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<GetInstallStatusResponse> GetStatusAsync(int workspaceID, int applicationID, bool includeActions = false)
  • Task<GetInstallStatusResponse> GetStatusAsync(int workspaceID, Guid applicationGuid, bool includeActions = false)
  • 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)
  • Task<List<NameValidationResponse>> IsNameAvailable(int workspaceID, List<NameValidationRequest> nameValidationItems)
  • Task<ApplicationInstallSearchResponse> SearchApplicationAsync(int workspaceID, int applicationID, QueryOptions queryOptions, int start = 1, int length = 10, bool includeActions = false)
  • Task<ApplicationInstallSearchResponse> SearchApplicationAsync(int workspaceID, Guid applicationGuid, QueryOptions queryOptions, int start = 1, int length = 10, bool includeActions = false)
  • Task<ApplicationInstallSearchResponse> SearchAsync(int workspaceID, QueryOptions queryOptions, int start = 1, int length = 10, bool includeActions = false)
  • Task<List<ValidationResult>> ValidateApplicationInstallation(int workspaceID, int applicationID, List<int> workspaceIDs)
  • Task<List<ValidationResult>> ValidateApplicationInstallation(int workspaceID, Guid applicationGuid, List<int> workspaceIDs)
  • Task<List<ValidationResult>> ValidateApplicationInstallation(int workspaceID, int applicationID, ApplicationInstallTargetOption targetWorkspaces)
  • Task<List<ValidationResult>> ValidateApplicationInstallation(int workspaceID, Guid applicationGuid, ApplicationInstallTargetOption targetWorkspaces)
  • Task<List<ValidationResult>> ValidateApplicationInstallation(int workspaceID, IKeplerStream rapStream, List<int> workspaceIDs)
  • Task<List<ValidationResult>> ValidateApplicationInstallation(int workspaceID, IKeplerStream rapStream, ApplicationInstallTargetOption targetWorkspaces)
• 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<ApplicationHostingStatusResponse> GetApplicationHostingStatusAsync(int workspaceID, Guid applicationGUID)
  • Task<ApplicationHostingStatusResponse> GetApplicationHostingStatusAsync(int workspaceID, int applicationID)
  • 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 enum ApplicationComponentType
  • AgentType = 12
  • Choice = 1
  • CustomPage = 11
  • Dashboard = 19
  • EventHandler = 6
  • Field = 2
  • InstallEventHandler = 13
  • Instance = 10
  • Layout = 3
  • MassOperation = 15
  • MasterAgentType = 16
  • ObjectRule = 5
  • ObjectType = 4
  • ResourceFile = 14
  • SavedSearch = 17
  • Script = 9
  • SearchProvider = 18
  • Tab = 7
  • Unknown = 0
  • View = 8
• public class ApplicationHostingStatusResponse : HostingStatusResponse
  • public List<CustomPageHostingStatusResponse> CustomPages { get; set; }
  • public ApplicationHostingStatusResponse()
• public class ApplicationInstallConflict
  • public ApplicationComponentType ApplicationComponentType { get; set; }
  • public DisplayableObjectIdentifier ConflictApplicationIdentifier { get; set; }
  • public DisplayableObjectIdentifier ConflictArtifactIdentifier { get; set; }
  • public int ConflictCorrelationID { get; set; }
  • public ApplicationInstallConflictType ConflictType { get; set; }
  • public string Description { get; set; }
  • public List<ApplicationInstallConflictResolutionType> Options { get; set; }
  • public List<ApplicationInstallConflictResolution> ResolutionOptions { get; set; }
  • public ApplicationInstallConflict()
• public class ApplicationInstallConflictResolution
  • public ApplicationComponentType ApplicationComponentType { get; set; }
  • public int? ConflictApplicationID { get; set; }
  • public int ConflictArtifactID { get; set; }
  • public int ConflictCorrelationID { get; set; }
  • public List<Guid> FieldIdentifiers { get; set; }
  • public ApplicationInstallConflictResolutionType ResolutionType { get; set; }
  • public string Value { get; set; }
  • public int WorkspaceID { get; set; }
  • public ApplicationInstallConflictResolution()
• public enum ApplicationInstallConflictResolutionType
  • MapField = 3
  • Rename = 1
  • RenameField = 1
  • RenameRelationalFriendlyName = 2
  • Unknown = 0
  • UnlockAssociatedApplications = 4
• public enum ApplicationInstallConflictType
  • FriendlyName = 3
  • LockedApplication = 1
  • Name = 2
  • Unknown = 0
• public class ApplicationInstallDetail : DisplayableObjectIdentifier
  • public string ArtifactStatus { get; set; }
  • public string ArtifactTypeName { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public string Message { get; set; }
  • public ApplicationInstallDetail()
• public class ApplicationInstallSearchItem : IHasInstallStatus
  • public DisplayableObjectIdentifier ApplicationIdentifier { get; set; }
  • public int ApplicationInstallID { get; set; }
  • public DisplayableObjectIdentifier ClientIdentifier { get; set; }
  • public DateTime? CompletedOn { get; set; }
  • public DisplayableObjectIdentifier InstalledBy { get; set; }
  • public InstallStatus InstallStatus { get; set; }
  • public bool IsOutOfDate { get; set; }
  • public DisplayableObjectIdentifier MatterIdentifier { get; set; }
  • public string Message { get; set; }
  • public int RootFolderID { get; set; }
  • public DateTime? StartedOn { get; set; }
  • public string Version { get; set; }
  • public DisplayableObjectIdentifier WorkspaceIdentifier { get; set; }
  • public ApplicationInstallSearchItem()
• public class ApplicationInstallSearchResponse : QueryResponse
  • public List<ApplicationInstallSearchItem> Results { get; set; }
  • public InstallStatusSummary Summary { get; set; }
  • public ApplicationInstallSearchResponse()
• 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 CustomPageHostingStatusResponse : HostingStatusResponse
  • public Securable<DisplayableObjectIdentifier> CustomPage { get; set; }
  • public HttpStatusCode StatusCode { get; set; }
  • public CustomPageHostingStatusResponse()
• 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 InstallStatusSummary Summary { 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 DisplayableObjectIdentifier Client { get; set; }
  • public DateTime? CompletedOn { get; set; }
  • public List<ApplicationInstallDetail> Errors { get; set; }
  • public Action GetCurrentInstallStatus { get; set; }
  • public DisplayableObjectIdentifier InstalledBy { get; set; }
  • public InstallStatus InstallStatus { get; set; }
  • public bool IsOutOfDate { get; set; }
  • public DisplayableObjectIdentifier Matter { get; set; }
  • public string Message { get; set; }
  • public int RootFolderID { 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 string WorkspaceName { get; set; }
  • public GetInstallStatusResponse()
• public class GetOutdatedWorkspacesResponse
  • public ObjectIdentifier ApplicationIdentifier { get; set; }
  • public bool IsGlobalApplication { get; set; }
  • public int OutdatedWorkspacesCount { get; set; }
  • public Action UpdateOutdatedApplications { get; set; }
  • public InstallApplicationAllRequest UpdateOutdatedApplicationsPayload { get; set; }
  • public GetOutdatedWorkspacesResponse()
• public class HostingStatusResponse
  • public List<Action> Actions { get; set; }
  • public string Message { get; set; }
  • public ReadinessState State { get; set; }
  • public HostingStatusResponse()
• 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 InstallApplicationAllRequest(ApplicationInstallTargetOption mode)
• 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 string Details { 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 InstallStatusSummary
  • public int Canceled { get; set; }
  • public int Completed { get; set; }
  • public int Failed { get; set; }
  • public int InProgress { get; set; }
  • public int Other { get; set; }
  • public int Pending { get; set; }
  • public int Total { get; set; }
  • public int TotalActiveInstalls { get; set; }
  • public InstallStatusSummary()
• 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 LicenseStatus License { 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 enum LicenseStatus
  • Expired = 2
  • Invalid = 3
  • NotApplicable = 0
  • Valid = 1
• public class NameValidationRequest
  • public int ConflictArtifactID { get; set; }
  • public ApplicationInstallConflictType ConflictType { get; set; }
  • public string Value { get; set; }
  • public int WorkspaceID { get; set; }
  • public NameValidationRequest()
• public class NameValidationResponse
  • public int ConflictArtifactID { get; set; }
  • public ApplicationInstallConflictType ConflictType { get; set; }
  • public bool IsAvailable { get; set; }
  • public List<string> Messages { get; set; }
  • public int WorkspaceID { get; set; }
  • public NameValidationResponse()
• public class PackageDetailsResponse
  • public Guid ApplicationGUID { get; set; }
  • 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 enum ReadinessState
  • OutOfDate = 2
  • Pending = 1
  • Ready = 0
  • Unavailable = 3
• 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()
• public class ValidationResult
  • public ObjectIdentifier ApplicationIdentifier { get; set; }
  • public List<ApplicationInstallConflict> Conflicts { get; set; }
  • public List<string> Errors { get; set; }
  • public bool Success { get; set; }
  • public ObjectIdentifier WorkspaceIdentifier { get; set; }
  • public ValidationResult()

Relativity.Services.Interfaces.LibraryApplication.Models.Query

• public class QueryOptions
  • public string Condition { get; set; }
  • public List<Sort> Sorts { get; set; }
  • public QueryOptions()
• public class QueryResponse : IPagedResponse
  • 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 int TotalCount { get; set; }
  • public QueryResponse()
• public class Sort
  • public SortDirection Direction { get; set; }
  • public string FieldName { get; set; }
  • public Sort()
• public enum SortDirection
  • Ascending = 0
  • Descending = 1

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 bool OpenInModal { 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 bool OpenInModal { 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 MassDeleteAsync(int workspaceID, List<ObjectIdentifier> objectRules)
  • 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

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

Relativity.Services.Interfaces.ObjectType.EventHandler.Models

• public enum EventHandlerExecution
• public class EventHandlerResponse : ObjectIdentifier

Relativity.Services.Interfaces.ObjectType.MassOperation

• public interface IMassOperationManager

Relativity.Services.Interfaces.ObjectType.MassOperation.Models

• public class MassOperationRequest
• public class MassOperationResponse : ObjectIdentifier

Relativity.Services.Interfaces.ObjectType.Models

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

Relativity.Services.Interfaces.ObjectType.ObjectRule

• public interface IObjectRuleManager

Relativity.Services.Interfaces.ObjectType.ObjectRule.Models

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

Relativity.Services.Interfaces.ResourcePool

• public interface IResourcePoolManager : IDisposable
  • Task AddResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources)
  • Task AddResourcesAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)
  • Task<ResourcePoolResponse> CreateAsync(ResourcePoolRequest resourcePoolRequest)
  • Task DeleteAsync(int resourcePoolID)
  • Task<List<MassOperationResult>> MassAddResourceServersAsync(List<ObjectIdentifier> resourcePools, List<ObjectIdentifier> resourceServers)
  • Task<List<MassOperationResult>> MassAddResourceServersAsync(List<ObjectIdentifier> resourcePools, List<ObjectIdentifier> resourceServers, IProgress<ProgressReport> progress)
  • Task<List<MassOperationResult>> MassAddResourceServersAsync(List<ObjectIdentifier> resourcePools, List<ObjectIdentifier> resourceServers, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<List<MassOperationResult>> MassRemoveResourceServersAsync(List<ObjectIdentifier> resourcePools, List<ObjectIdentifier> resourceServers)
  • Task<List<MassOperationResult>> MassRemoveResourceServersAsync(List<ObjectIdentifier> resourcePools, List<ObjectIdentifier> resourceServers, IProgress<ProgressReport> progress)
  • Task<List<MassOperationResult>> MassRemoveResourceServersAsync(List<ObjectIdentifier> resourcePools, List<ObjectIdentifier> resourceServers, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryByResourceServerAsync(int resourceServerID, QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryByResourceServerAsync(int resourceServerID, QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryByResourceServerAsync(int resourceServerID, QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
  • 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> QueryEligibleByResourceServerAsync(int resourceServerID, QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryEligibleByResourceServerAsync(int resourceServerID, QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleByResourceServerAsync(int resourceServerID, 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 RemoveResourcesAsync(int resourcePoolID, string resourceType, List<ObjectIdentifier> resources)
  • Task RemoveResourcesAsync(int resourcePoolID, string resourceType, ObjectIdentifier resource)
  • 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.ResourceServer

• public interface IAgentServerManager : IDisposable
  • Task<AgentServerResponse> ReadAsync(int serverID)
  • Task<AgentServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task RestartWindowsServiceAsync(int serverID)
  • Task<AgentServerResponse> UpdateAsync(int serverID, AgentServerRequest request)
  • Task<AgentServerResponse> UpdateAsync(int serverID, AgentServerRequest request, DateTime lastModifiedOn)
• public interface IAnalyticsServerManager : IDisposable
  • Task<AnalyticsServerResponse> CreateAsync(AnalyticsServerRequest request)
  • Task DeleteAsync(int serverID)
  • Task<AnalyticsServerDefaultValuesResponse> GetDefaultFieldValuesAsync()
  • Task<List<DisplayableObjectIdentifier>> GetEligibleAnalyticsOperationsAsync()
  • Task<Meta> GetMetadataAsync()
  • Task<AnalyticsServerResponse> ReadAsync(int serverID)
  • Task<AnalyticsServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task RestartWindowsServiceAsync(int serverID)
  • Task<AnalyticsServerResponse> UpdateAsync(int serverID, AnalyticsServerRequest request)
  • Task<AnalyticsServerResponse> UpdateAsync(int serverID, AnalyticsServerRequest request, DateTime lastModifiedOn)
• public interface ICacheLocationServerManager : IDisposable
  • Task<CacheLocationServerResponse> CreateAsync(CacheLocationServerRequest request)
  • Task DeleteAsync(int serverID)
  • Task<Meta> GetMetadataAsync()
  • Task<bool> IsLastVisibleServerAsync(int serverID)
  • Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<CacheLocationServerResponse> ReadAsync(int serverID)
  • Task<CacheLocationServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<CacheLocationServerResponse> UpdateAsync(int serverID, CacheLocationServerRequest request)
  • Task<CacheLocationServerResponse> UpdateAsync(int serverID, CacheLocationServerRequest request, DateTime lastModifiedOn)
• public interface IFileRepositoryServerManager : IDisposable
  • Task<FileRepositoryServerResponse> CreateAsync(FileRepositoryServerRequest request)
  • Task DeleteAsync(int serverID)
  • Task<Meta> GetMetadataAsync()
  • Task<bool> IsLastVisibleServerAsync(int serverID)
  • Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<FileRepositoryServerResponse> ReadAsync(int serverID)
  • Task<FileRepositoryServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<FileRepositoryServerResponse> UpdateAsync(int serverID, FileRepositoryServerRequest request)
  • Task<FileRepositoryServerResponse> UpdateAsync(int serverID, FileRepositoryServerRequest request, DateTime lastModifiedOn)
• public interface IResourceServerManager : IDisposable
  • Task<List<DisplayableObjectIdentifier>> GetEligibleStatusesAsync()
  • Task<ResourceServerResponse> ReadAsync(int serverID)
  • Task<List<ServerTypeResponse>> ReadServerTypesAsync()
• public interface IResourceServerModule
• public interface IServicesServerManager : IDisposable
  • Task<ServicesServerResponse> ReadAsync(int serverID)
  • Task<ServicesServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<ServicesServerResponse> UpdateAsync(int serverID, ServicesServerRequest request)
  • Task<ServicesServerResponse> UpdateAsync(int serverID, ServicesServerRequest request, DateTime lastModifiedOn)
• public interface ISqlDistributedServerManager : IDisposable
  • Task<bool> IsLastVisibleServerAsync(int serverID)
  • Task<SqlDistributedServerResponse> ReadAsync(int serverID)
  • Task<SqlDistributedServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<SqlDistributedServerResponse> UpdateAsync(int serverID, SqlDistributedServerRequest request)
  • Task<SqlDistributedServerResponse> UpdateAsync(int serverID, SqlDistributedServerRequest request, DateTime lastModifiedOn)
• public interface ISqlPrimaryServerManager : IDisposable
  • Task<bool> IsLastVisibleServerAsync(int serverID)
  • Task<SqlPrimaryServerResponse> ReadAsync(int serverID)
  • Task<SqlPrimaryServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<SqlPrimaryServerResponse> UpdateAsync(int serverID, SqlPrimaryServerRequest request)
  • Task<SqlPrimaryServerResponse> UpdateAsync(int serverID, SqlPrimaryServerRequest request, DateTime lastModifiedOn)
• public interface IWebApiFormsAuthServerManager : IDisposable
  • Task<WebApiFormsAuthServerResponse> ReadAsync(int serverID)
  • Task<WebApiFormsAuthServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebApiFormsAuthServerResponse> UpdateAsync(int serverID, WebApiFormsAuthServerRequest request)
  • Task<WebApiFormsAuthServerResponse> UpdateAsync(int serverID, WebApiFormsAuthServerRequest request, DateTime lastModifiedOn)
• public interface IWebApiServerManager : IDisposable
  • Task<WebApiServerResponse> ReadAsync(int serverID)
  • Task<WebApiServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebApiServerResponse> UpdateAsync(int serverID, WebApiServerRequest request)
  • Task<WebApiServerResponse> UpdateAsync(int serverID, WebApiServerRequest request, DateTime lastModifiedOn)
• public interface IWebApiWindowsAuthServerManager : IDisposable
  • Task<WebApiWindowsAuthServerResponse> ReadAsync(int serverID)
  • Task<WebApiWindowsAuthServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebApiWindowsAuthServerResponse> UpdateAsync(int serverID, WebApiWindowsAuthServerRequest request)
  • Task<WebApiWindowsAuthServerResponse> UpdateAsync(int serverID, WebApiWindowsAuthServerRequest request, DateTime lastModifiedOn)
• public interface IWebBackgroundProcessingServerManager : IDisposable
  • Task<WebBackgroundProcessingServerResponse> ReadAsync(int serverID)
  • Task<WebBackgroundProcessingServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task RestartWindowsServiceAsync(int serverID)
  • Task<WebBackgroundProcessingServerResponse> UpdateAsync(int serverID, WebBackgroundProcessingServerRequest request)
  • Task<WebBackgroundProcessingServerResponse> UpdateAsync(int serverID, WebBackgroundProcessingServerRequest request, DateTime lastModifiedOn)
• public interface IWebDistributedFormsAuthServerManager : IDisposable
  • Task<WebDistributedFormsAuthServerResponse> ReadAsync(int serverID)
  • Task<WebDistributedFormsAuthServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebDistributedFormsAuthServerResponse> UpdateAsync(int serverID, WebDistributedFormsAuthServerRequest request)
  • Task<WebDistributedFormsAuthServerResponse> UpdateAsync(int serverID, WebDistributedFormsAuthServerRequest request, DateTime lastModifiedOn)
• public interface IWebDistributedServerManager : IDisposable
  • Task<WebDistributedServerResponse> ReadAsync(int serverID)
  • Task<WebDistributedServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebDistributedServerResponse> UpdateAsync(int serverID, WebDistributedServerRequest request)
  • Task<WebDistributedServerResponse> UpdateAsync(int serverID, WebDistributedServerRequest request, DateTime lastModifiedOn)
• public interface IWebDistributedWindowsAuthServerManager : IDisposable
  • Task<WebDistributedWindowsAuthServerResponse> ReadAsync(int serverID)
  • Task<WebDistributedWindowsAuthServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebDistributedWindowsAuthServerResponse> UpdateAsync(int serverID, WebDistributedWindowsAuthServerRequest request)
  • Task<WebDistributedWindowsAuthServerResponse> UpdateAsync(int serverID, WebDistributedWindowsAuthServerRequest request, DateTime lastModifiedOn)
• public interface IWebFormsAuthServerManager : IDisposable
  • Task<WebFormsAuthServerResponse> ReadAsync(int serverID)
  • Task<WebFormsAuthServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebFormsAuthServerResponse> UpdateAsync(int serverID, WebFormsAuthServerRequest request)
  • Task<WebFormsAuthServerResponse> UpdateAsync(int serverID, WebFormsAuthServerRequest request, DateTime lastModifiedOn)
• public interface IWebServerManager : IDisposable
  • Task<WebServerResponse> ReadAsync(int serverID)
  • Task<WebServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebServerResponse> UpdateAsync(int serverID, WebServerRequest request)
  • Task<WebServerResponse> UpdateAsync(int serverID, WebServerRequest request, DateTime lastModifiedOn)
• public interface IWebWindowsAuthServerManager : IDisposable
  • Task<WebWindowsAuthServerResponse> ReadAsync(int serverID)
  • Task<WebWindowsAuthServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WebWindowsAuthServerResponse> UpdateAsync(int serverID, WebWindowsAuthServerRequest request)
  • Task<WebWindowsAuthServerResponse> UpdateAsync(int serverID, WebWindowsAuthServerRequest request, DateTime lastModifiedOn)
• public interface IWorkerManagerServerManager : IDisposable
  • Task<WorkerManagerServerResponse> CreateAsync(WorkerManagerServerRequest request)
  • Task DeleteAsync(int serverID)
  • Task<WorkerManagerServerDefaultValuesResponse> GetDefaultFieldValuesAsync()
  • Task<WorkerManagerServerResponse> ReadAsync(int serverID)
  • Task<WorkerManagerServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task<WorkerManagerServerResponse> UpdateAsync(int serverID, WorkerManagerServerRequest request)
  • Task<WorkerManagerServerResponse> UpdateAsync(int serverID, WorkerManagerServerRequest request, DateTime lastModifiedOn)
• public interface IWorkerServerManager : IDisposable
  • Task DisableProcessingLicenseAsync(int serverID)
  • Task EnableProcessingLicenseAsync(int serverID)
  • Task<List<EnableableObjectIdentifier>> GetEligibleWorkerDesignatedWorkAsync(int serverID)
  • Task<WorkerServerResponse> ReadAsync(int serverID)
  • Task<WorkerServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)
  • Task StartWorkerAsync(int serverID)
  • Task StopWorkerAsync(int serverID)
  • Task<WorkerServerResponse> UpdateAsync(int serverID, WorkerServerRequest request)
  • Task<WorkerServerResponse> UpdateAsync(int serverID, WorkerServerRequest request, DateTime lastModifiedOn)

Relativity.Services.Interfaces.ResourceServer.Models

• public class AgentServerRequest : IHaveStatus, IHaveTemporaryDirectory, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public string TemporaryDirectory { get; set; }
  • public AgentServerRequest()
  • public AgentServerRequest(AgentServerResponse response)
  • public static AgentServerRequest op_Implicit(AgentServerResponse response)
• public class AgentServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveTemporaryDirectory, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public string TemporaryDirectory { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public string WindowsServiceStatus { get; set; }
  • public AgentServerResponse()
• public class AnalyticsServerDefaultValuesResponse : IHaveDisplayableStatus
  • public int MaximumConnectors { get; set; }
  • public int MaximumTotalConnectors { get; set; }
  • public DisplayableObjectIdentifier Status { get; set; }
  • public AnalyticsServerDefaultValuesResponse()
• public class AnalyticsServerRequest : IHaveName, IHaveStatus, IHaveKeywordsAndNotes
  • public List<ObjectIdentifier> AnalyticsOperations { get; set; }
  • public string Keywords { get; set; }
  • public int MaximumConnectors { get; set; }
  • public int MaximumTotalConnectors { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public string RestApiPassword { get; set; }
  • public string RestApiUsername { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public string Url { get; set; }
  • public AnalyticsServerRequest()
  • public AnalyticsServerRequest(AnalyticsServerResponse response)
  • public AnalyticsServerRequest(AnalyticsServerDefaultValuesResponse defaultValues)
  • public static AnalyticsServerRequest op_Implicit(AnalyticsServerResponse response)
  • public static AnalyticsServerRequest op_Implicit(AnalyticsServerDefaultValuesResponse defaultValues)
• public class AnalyticsServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public List<DisplayableObjectIdentifier> AnalyticsOperations { 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 int MaximumConnectors { get; set; }
  • public int MaximumTotalConnectors { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public string RestApiUsername { get; set; }
  • public DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Url { get; set; }
  • public string Version { get; set; }
  • public string WindowsServiceStatus { get; set; }
  • public AnalyticsServerResponse()
• public class CacheLocationServerRequest : IHaveName, IHaveIsVisible, IHaveUncPath, IHaveFileAccessCredentials, IHaveKeywordsAndNotes
  • public Securable<ObjectIdentifier> FileAccessCredentials { get; set; }
  • public bool IsVisible { get; set; }
  • public string Keywords { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public string UncPath { get; set; }
  • public CacheLocationServerRequest()
  • public CacheLocationServerRequest(CacheLocationServerResponse response)
  • public static CacheLocationServerRequest op_Implicit(CacheLocationServerResponse response)
• public class CacheLocationServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveUncPath, IHaveIsVisible, IHaveDisplayableFileAccessCredentials, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public int CacheLocationCapacityInGigabytes { get; set; }
  • public DisplayableObjectIdentifier CacheLocationCleanUpStatus { get; set; }
  • public int CacheLocationFreeSpaceInGigabytes { get; set; }
  • public int CacheLocationFreeSpaceInPercents { get; set; }
  • public int? CacheLocationLowerThresholdInPercents { get; set; }
  • public int? CacheLocationUpperThresholdInPercents { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public Securable<DisplayableObjectIdentifier> FileAccessCredentials { get; set; }
  • public bool IsDocumentCacheTimeBased { 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 DisplayableObjectIdentifier Type { get; set; }
  • public string UncPath { get; set; }
  • public CacheLocationServerResponse()
• public class FileRepositoryServerRequest : IHaveName, IHaveIsVisible, IHaveUncPath, IHaveFileAccessCredentials, IHaveKeywordsAndNotes
  • public Securable<ObjectIdentifier> FileAccessCredentials { get; set; }
  • public bool IsVisible { get; set; }
  • public string Keywords { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public string UncPath { get; set; }
  • public FileRepositoryServerRequest()
  • public FileRepositoryServerRequest(FileRepositoryServerResponse response)
  • public static FileRepositoryServerRequest op_Implicit(FileRepositoryServerResponse response)
• public class FileRepositoryServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveUncPath, IHaveIsVisible, IHaveDisplayableFileAccessCredentials, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public Securable<DisplayableObjectIdentifier> FileAccessCredentials { 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 DisplayableObjectIdentifier Type { get; set; }
  • public string UncPath { get; set; }
  • public FileRepositoryServerResponse()
• public class ResourceServerResponse : DisplayableObjectIdentifier, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Type { get; set; }
  • public ResourceServerResponse()
• public class ServerTypeResponse : IHasArtifactID, IHasIdentifyingInformation, IHasName
  • public int ArtifactID { get; set; }
  • public string Name { get; set; }
  • public string SystemArtifactIdentifier { get; set; }
  • public string Url { get; set; }
  • public ServerTypeResponse()
• public class ServicesServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public ServicesServerRequest()
  • public ServicesServerRequest(ServicesServerResponse response)
  • public static ServicesServerRequest op_Implicit(ServicesServerResponse response)
• public class ServicesServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public ServicesServerResponse()
• public class SqlDistributedServerRequest : IHaveFriendlyName, IHaveIsVisible, IHaveStatus, IHaveBcpPath, IHaveWorkspaceUpgradeLimit, IHaveKeywordsAndNotes
  • public string BcpPath { get; set; }
  • public string FriendlyName { get; set; }
  • public bool IsVisible { get; set; }
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public int WorkspaceUpgradeLimit { get; set; }
  • public SqlDistributedServerRequest()
  • public SqlDistributedServerRequest(SqlDistributedServerResponse response)
  • public static SqlDistributedServerRequest op_Implicit(SqlDistributedServerResponse response)
• public class SqlDistributedServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveFriendlyName, IHaveIsVisible, IHaveBcpPath, IHaveWorkspaceUpgradeLimit, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public string BcpPath { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public string FriendlyName { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public int WorkspaceUpgradeLimit { get; set; }
  • public SqlDistributedServerResponse()
• public class SqlPrimaryServerRequest : IHaveFriendlyName, IHaveIsVisible, IHaveStatus, IHaveBcpPath, IHaveWorkspaceUpgradeLimit, IHaveKeywordsAndNotes
  • public string BcpPath { get; set; }
  • public string FriendlyName { get; set; }
  • public bool IsVisible { get; set; }
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public int WorkspaceUpgradeLimit { get; set; }
  • public SqlPrimaryServerRequest()
  • public SqlPrimaryServerRequest(SqlPrimaryServerResponse response)
  • public static SqlPrimaryServerRequest op_Implicit(SqlPrimaryServerResponse response)
• public class SqlPrimaryServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveFriendlyName, IHaveIsVisible, IHaveBcpPath, IHaveWorkspaceUpgradeLimit, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public string BcpPath { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public string FriendlyName { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public int WorkspaceUpgradeLimit { get; set; }
  • public SqlPrimaryServerResponse()
• public class WebApiFormsAuthServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public WebApiFormsAuthServerRequest()
  • public WebApiFormsAuthServerRequest(WebApiFormsAuthServerResponse response)
  • public static WebApiFormsAuthServerRequest op_Implicit(WebApiFormsAuthServerResponse response)
• public class WebApiFormsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public WebApiFormsAuthServerResponse()
• public class WebApiServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public WebApiServerRequest()
  • public WebApiServerRequest(WebApiServerResponse response)
  • public static WebApiServerRequest op_Implicit(WebApiServerResponse response)
• public class WebApiServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public WebApiServerResponse()
• public class WebApiWindowsAuthServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public WebApiWindowsAuthServerRequest()
  • public WebApiWindowsAuthServerRequest(WebApiWindowsAuthServerResponse response)
  • public static WebApiWindowsAuthServerRequest op_Implicit(WebApiWindowsAuthServerResponse response)
• public class WebApiWindowsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public WebApiWindowsAuthServerResponse()
• public class WebBackgroundProcessingServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public WebBackgroundProcessingServerRequest()
  • public WebBackgroundProcessingServerRequest(WebBackgroundProcessingServerResponse response)
  • public static WebBackgroundProcessingServerRequest op_Implicit(WebBackgroundProcessingServerResponse response)
• public class WebBackgroundProcessingServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public string WindowsServiceStatus { get; set; }
  • public WebBackgroundProcessingServerResponse()
• public class WebDistributedFormsAuthServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public WebDistributedFormsAuthServerRequest()
  • public WebDistributedFormsAuthServerRequest(WebDistributedFormsAuthServerResponse response)
  • public static WebDistributedFormsAuthServerRequest op_Implicit(WebDistributedFormsAuthServerResponse response)
• public class WebDistributedFormsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public WebDistributedFormsAuthServerResponse()
• public class WebDistributedServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public WebDistributedServerRequest()
  • public WebDistributedServerRequest(WebDistributedServerResponse response)
  • public static WebDistributedServerRequest op_Implicit(WebDistributedServerResponse response)
• public class WebDistributedServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public WebDistributedServerResponse()
• public class WebDistributedWindowsAuthServerRequest : IHaveStatus, IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public WebDistributedWindowsAuthServerRequest()
  • public WebDistributedWindowsAuthServerRequest(WebDistributedWindowsAuthServerResponse response)
  • public static WebDistributedWindowsAuthServerRequest op_Implicit(WebDistributedWindowsAuthServerResponse response)
• public class WebDistributedWindowsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public WebDistributedWindowsAuthServerResponse()
• public class WebFormsAuthServerRequest : IHaveStatus, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveKeywordsAndNotes
  • public bool IsUserLoadBalancingEnabled { get; set; }
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public string Url { get; set; }
  • public WebFormsAuthServerRequest()
  • public WebFormsAuthServerRequest(WebFormsAuthServerResponse response)
  • public static WebFormsAuthServerRequest op_Implicit(WebFormsAuthServerResponse response)
• public class WebFormsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveFailedRedirectionAttemptCount, IHaveLastRedirectFailedOn, IHaveCurrentUserCount, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public int CurrentUserCount { get; set; }
  • public int FailedRedirectionAttemptCount { get; set; }
  • public bool IsUserLoadBalancingEnabled { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public DateTime? LastRedirectFailedOn { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Url { get; set; }
  • public string Version { get; set; }
  • public WebFormsAuthServerResponse()
• public class WebServerRequest : IHaveStatus, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveKeywordsAndNotes
  • public bool IsUserLoadBalancingEnabled { get; set; }
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public string Url { get; set; }
  • public WebServerRequest()
  • public WebServerRequest(WebServerResponse response)
  • public static WebServerRequest op_Implicit(WebServerResponse response)
• public class WebServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveFailedRedirectionAttemptCount, IHaveLastRedirectFailedOn, IHaveCurrentUserCount, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public int CurrentUserCount { get; set; }
  • public int FailedRedirectionAttemptCount { get; set; }
  • public bool IsUserLoadBalancingEnabled { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public DateTime? LastRedirectFailedOn { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Url { get; set; }
  • public string Version { get; set; }
  • public WebServerResponse()
• public class WebWindowsAuthServerRequest : IHaveStatus, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveKeywordsAndNotes
  • public bool IsUserLoadBalancingEnabled { get; set; }
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public ObjectIdentifier Status { get; set; }
  • public string Url { get; set; }
  • public WebWindowsAuthServerRequest()
  • public WebWindowsAuthServerRequest(WebWindowsAuthServerResponse response)
  • public static WebWindowsAuthServerRequest op_Implicit(WebWindowsAuthServerResponse response)
• public class WebWindowsAuthServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveUrl, IHaveIsUserLoadBalancingEnabled, IHaveFailedRedirectionAttemptCount, IHaveLastRedirectFailedOn, IHaveCurrentUserCount, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public int CurrentUserCount { get; set; }
  • public int FailedRedirectionAttemptCount { get; set; }
  • public bool IsUserLoadBalancingEnabled { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public DateTime? LastRedirectFailedOn { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Url { get; set; }
  • public string Version { get; set; }
  • public WebWindowsAuthServerResponse()
• public class WorkerManagerServerDefaultValuesResponse
  • public int DiscoveryPriority { get; set; }
  • public int ImageOnTheFlyPriority { get; set; }
  • public int InventoryPriority { get; set; }
  • public int MassImagingPriority { get; set; }
  • public int MassSaveAsPdfPriority { get; set; }
  • public int PublishPriority { get; set; }
  • public int SingleSaveAsPdfPriority { get; set; }
  • public WorkerManagerServerDefaultValuesResponse()
• public class WorkerManagerServerRequest : IHaveName, IHaveTemporaryDirectory, IHaveKeywordsAndNotes
  • public int DiscoveryPriority { get; set; }
  • public int ImageOnTheFlyPriority { get; set; }
  • public int InventoryPriority { get; set; }
  • public bool IsDefault { get; set; }
  • public string Keywords { get; set; }
  • public int MassImagingPriority { get; set; }
  • public int MassSaveAsPdfPriority { get; set; }
  • public string Name { get; set; }
  • public string Notes { get; set; }
  • public int PublishPriority { get; set; }
  • public string ServerName { get; set; }
  • public int SingleSaveAsPdfPriority { get; set; }
  • public string TemporaryDirectory { get; set; }
  • public WorkerManagerServerRequest()
  • public WorkerManagerServerRequest(WorkerManagerServerResponse response)
  • public WorkerManagerServerRequest(WorkerManagerServerDefaultValuesResponse defaultValues)
  • public static WorkerManagerServerRequest op_Implicit(WorkerManagerServerResponse response)
  • public static WorkerManagerServerRequest op_Implicit(WorkerManagerServerDefaultValuesResponse defaultValues)
• public class WorkerManagerServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveTemporaryDirectory, IHaveWindowsServiceStatus, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public int DiscoveryPriority { get; set; }
  • public int ImageOnTheFlyPriority { get; set; }
  • public int InventoryPriority { get; set; }
  • public bool IsDefault { get; set; }
  • public string Keywords { get; set; }
  • public DisplayableObjectIdentifier LastModifiedBy { get; set; }
  • public DateTime LastModifiedOn { get; set; }
  • public int MassImagingPriority { get; set; }
  • public int MassSaveAsPdfPriority { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public int PublishPriority { get; set; }
  • public string ServerName { get; set; }
  • public int SingleSaveAsPdfPriority { get; set; }
  • public DisplayableObjectIdentifier Status { get; set; }
  • public string TemporaryDirectory { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public string WindowsServiceStatus { get; set; }
  • public WorkerManagerServerResponse()
• public class WorkerServerRequest : IHaveKeywordsAndNotes
  • public string Keywords { get; set; }
  • public string Notes { get; set; }
  • public List<ObjectIdentifier> WorkerDesignatedWork { get; set; }
  • public WorkerServerRequest()
  • public WorkerServerRequest(WorkerServerResponse response)
  • public static WorkerServerRequest op_Implicit(WorkerServerResponse response)
• public class WorkerServerResponse : DisplayableObjectIdentifier, IHaveType, IHaveDisplayableStatus, IHaveVersion, IHaveKeywordsAndNotes, IHaveMetaAndActions, IHaveCreatedAndModified
  • public List<Action> Actions { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public bool IsWorkerLicensedForProcessing { 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 DisplayableObjectIdentifier Status { get; set; }
  • public DisplayableObjectIdentifier Type { get; set; }
  • public string Version { get; set; }
  • public List<DisplayableObjectIdentifier> WorkerDesignatedWork { get; set; }
  • public Securable<DisplayableObjectIdentifier> WorkerManagerServer { get; set; }
  • public int WorkerRunningThreads { get; set; }
  • public string WorkerStatus { get; set; }
  • public int WorkerTotalThreads { get; set; }
  • public long WorkerWorkStationID { get; set; }
  • public WorkerServerResponse()

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 SecurableList<T>
  • public bool HasSecuredItems { get; set; }
  • public List<T> ViewableItems { get; set; }
  • public SecurableList()
  • public SecurableList(bool hasSecuredItems, List<T> viewableItems)

Relativity.Services.Interfaces.Shared.Constants

• public static class RouteConstants
  • public const string ARTIFACT_ID = "artifactID"
  • public const string DELETE_VERB = "DELETE"
  • public const string INCLUDE_ACTIONS_ROUTE = "{includeActions:bool}"
  • public const string INCLUDE_ACTIONS_STRING = "includeActions"
  • public const string INCLUDE_METADATA_AND_ACTIONS_ROUTE = "{includeMetadata:bool}/{includeActions:bool}"
  • public const string INCLUDE_METADATA_ROUTE = "{includeMetadata:bool}"
  • public const string INCLUDE_METADATA_STRING = "includeMetadata"
  • public const string METADATA_ROUTE = "meta"
  • public const string SERVICE_ROUTE_WORKSPACE_PREFIX = "workspace"
  • public const string UPDATE_VERB = "PUT"
  • public const string WORKSPACE_ID_ROUTE = "{workspaceID:int}"
  • public const string WORKSPACE_ID_STRING = "workspaceID"
  • public const string WORKSPACE_ROUTE = "workspace"

Relativity.Services.Interfaces.Shared.Models

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

Relativity.Services.Interfaces.SystemArtifact

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

Relativity.Services.Interfaces.Tab

• public interface ITabManager : IDisposable
  • Task<List<NavigationTabResponse>> GetAllNavigationTabs(int workspaceID)
• public class TabConstants
• public class TabRouteConstants
  • public const string TAB_MODULE = "Relativity.Tabs"
  • public const string TAB_ROUTE = "tabs"
  • public TabRouteConstants()

Relativity.Services.Interfaces.Tab.Models

• public class NavigationTabResponse : DisplayableObjectIdentifier
  • public bool? IsDefault { get; set; }
  • public bool IsShownInSidebar { get; set; }
  • public bool IsVisible { get; set; }
  • public TabLinkTypeEnum LinkType { get; set; }
  • public Securable<ObjectTypeIdentifier> ObjectTypeIdentifier { get; set; }
  • public int Order { get; set; }
  • public Securable<DisplayableObjectIdentifier> Parent { get; set; }
  • public string Url { get; set; }
  • public NavigationTabResponse()
• public class TabRequest
  • public Securable<RelativityObjectRef> ObjectArtifactTypeID { get; set; }
  • public ObjectTypeIdentifier ObjectType { get; set; }
  • public Securable<RelativityObjectRef> ParentID { get; set; }
  • public Securable<List<RelativityObjectRef>> RelativityApplicationIDs { get; set; }
  • public Securable<ObjectIdentifier> Parent { get; set; }
  • public List<ObjectIdentifier> RelativityApplications { 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<List<NameIDPair>> RelativityApplications { get; set; }
  • public Securable<DisplayableObjectIdentifier> Parent { get; set; }
  • public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }

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<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> UpdateSettingsAsync(UserSettingRequest userSettingRequest)
  • Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, IProgress<ProgressReport> progress)
  • Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, CancellationToken cancel)
  • Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn)
  • Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, IProgress<ProgressReport> progress)
  • Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, CancellationToken cancel)
  • Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, CancellationToken cancel, IProgress<ProgressReport> progress)
• public class UserConstants

Relativity.Services.Interfaces.UserInfo.Models

• public enum DocumentViewer
  • ActiveX = 2
  • Default = 0
  • HTML = 1
  • RelativityReview = 3
• 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 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 DateTime? LastLoginDate { 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<string> GetDefaultDownloadHandlerURLAsync()
  • Task<List<DisplayableObjectIdentifier>> GetEligibleAzureCredentialsAsync(int resourcePoolID)
  • Task<List<DisplayableObjectIdentifier>> GetEligibleAzureFileSystemCredentialsAsync(int resourcePoolID)
  • Task<List<DisplayableObjectIdentifier>> GetEligibleCacheLocationsAsync(int resourcePoolID)
  • Task<List<DisplayableObjectIdentifier>> GetEligibleFileRepositoriesAsync(int resourcePoolID)
  • Task<List<DisplayableObjectIdentifier>> GetEligibleResourcePoolsAsync()
  • Task<SqlFullTextLanguageOptions> GetEligibleSqlFullTextLanguagesAsync()
  • Task<List<DisplayableObjectIdentifier>> GetEligibleSqlServersAsync(int resourcePoolID)
  • Task<List<DisplayableObjectIdentifier>> GetEligibleStatusesAsync()
  • Task<Meta> GetMetaAsync()
  • Task<WorkspaceSummary> GetWorkspaceSummaryAsync(int workspaceID)
  • Task MoveToColdStorageAsync(int workspaceID)
  • Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, CancellationToken cancel)
  • Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, CancellationToken cancel)
  • Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, CancellationToken cancel)
  • Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID)
  • Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel)
  • Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length)
  • Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)
  • Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, CancellationToken cancel)
  • Task<QueryResultSlim> QueryEligibleTemplatesAsync(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 RetryFailedCreateEventHandlersAsync(int workspaceID)
  • 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 SqlFullTextLanguageOptions
  • public int DefaultLanguageLcid { get; set; }
  • public List<NameIDPair> Languages { get; set; }
  • public SqlFullTextLanguageOptions()
• public class WorkspaceRequest
  • public Securable<ObjectIdentifier> AzureCredentials { get; set; }
  • public Securable<ObjectIdentifier> AzureFileSystemCredentials { get; set; }
  • public Securable<ObjectIdentifier> DataGridFileRepository { get; set; }
  • public Securable<ObjectIdentifier> DefaultCacheLocation { get; set; }
  • public Securable<ObjectIdentifier> DefaultFileRepository { 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<ObjectIdentifier> ResourcePool { get; set; }
  • public int SqlFullTextLanguage { get; set; }
  • public Securable<ObjectIdentifier> SqlServer { 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> AzureCredentials { get; set; }
  • public Securable<DisplayableObjectIdentifier> AzureFileSystemCredentials { get; set; }
  • public Securable<DisplayableObjectIdentifier> Client { get; set; }
  • public Securable<string> ClientNumber { get; set; }
  • public DisplayableObjectIdentifier CreatedBy { get; set; }
  • public DateTime CreatedOn { get; set; }
  • public Securable<DisplayableObjectIdentifier> DataGridFileRepository { get; set; }
  • public Securable<DisplayableObjectIdentifier> DefaultCacheLocation { get; set; }
  • public Securable<DisplayableObjectIdentifier> DefaultFileRepository { 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 Securable<string> MatterNumber { get; set; }
  • public Meta Meta { get; set; }
  • public string Notes { get; set; }
  • public Securable<DisplayableObjectIdentifier> ProductionRestrictions { get; set; }
  • public Securable<DisplayableObjectIdentifier> ResourcePool { get; set; }
  • public NameIDPair SqlFullTextLanguage { get; set; }
  • public Securable<DisplayableObjectIdentifier> SqlServer { get; set; }
  • public DisplayableObjectIdentifier Status { get; set; }
  • public Securable<DisplayableObjectIdentifier> WorkspaceAdminGroup { get; set; }
  • public WorkspaceResponse()
• public class WorkspaceSummary
  • public long DocumentCount { get; set; }
  • public long FileSize { get; set; }
  • public WorkspaceSummary()

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

• public class Configuration
• public interface ILoggingConfigModule
• public interface ILoggingConfigurationManager : IDisposable
• public interface ILoggingRuleManager : IDisposable
• public interface ILoggingSinkManager : IDisposable
• public class Rule
• public class Sink

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

• public interface IObjectQueryManager : IDisposable
• public interface IObjectQueryModule

Relativity.Services.ObjectType.MassOperation.Models

• public class MassOperationEventHandlerResponse : ObjectIdentifier

Relativity.Services.Objects

• public interface IObjectManager : IDisposable
  • Task<RelativityObjectSlim[]> RetrieveResultsBlockFromExportAsync(int workspaceID, Guid runID, int resultsBlockSize, int exportIndexID)
  • Task UpdateLongTextFromStreamAsync(int workspaceID, UpdateLongTextFromStreamRequest updateLongTextFromStreamRequest, IKeplerStream keplerStream)

Relativity.Services.Objects.DataContracts

• public class FileObject
  • public int FileFieldArtifactID { get; set; }
  • public int FileID { get; set; }
  • public string FileName { get; set; }
  • public FileObject()
• public enum LongTextBehavior
  • DefaultWithErrors = 2
  • TokenizedWithErrors = 3
• public class ReadResult
  • public string ObjectVersionToken { get; set; }
• public class TextFieldError
  • public string ErrorMessage { get; set; }
  • public TextFieldError()
• public class UpdateLongTextFromStreamRequest
  • public FieldRef Field { get; set; }
  • public RelativityObjectRef Object { get; set; }
  • public UpdateLongTextFromStreamRequest()
• public class UpdateRequest
  • public string ObjectVersionToken { get; set; }
• public class WordListCondition
  • public string displayValue { get; set; }
  • public string operator { get; set; }
  • public string value { get; set; }
  • public WordListCondition()
• public class WordListFieldCondition
  • public WordListCondition condition { get; set; }
  • public string field { get; set; }
  • public bool isAdvanced { get; set; }
  • public WordListFieldCondition()
• public class WordListSort
  • public string column { get; set; }
  • public string direction { get; set; }
  • public WordListSort()

Relativity.Services.Objects.Extensions

• public static class ExpandoObjectExtensions
  • public static FileObject ToFileObject(this ExpandoObject expando)

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)

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

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

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

• public class EnableableObjectIdentifier : DisplayableObjectIdentifier
  • public bool Enabled { get; set; }
  • public EnableableObjectIdentifier()

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

• public class WordListDictionaryResponse
  • public readonly long TotalResults
  • public readonly List<WordListResult> WordListResults
  • public WordListDictionaryResponse(List<WordListResult> wordListResults, long totalResults)
• public class WordListResult
  • public readonly string Keyword
  • public readonly long TotalDocuments
  • public readonly long TotalWords
  • public WordListResult(string keyword, long totalWords, long totalDocuments)
• public interface IdtSearchManager : IDisposable
  • Task<WordListDictionaryResponse> GetDictionarySearchResultsAsync(int workspaceArtifactID, int searchProviderID, string searchRequest, string fuzzinessLevel, bool enableStemming, IEnumerable<WordListFieldCondition> conditions, WordListSort sort, int start, int length)

Relativity.Services.Security.Models

• public class OpenIDConnectProvider : ISerializable
  • public IReadOnlyCollection<string> Scopes { get; set; }
  • protected OpenIDConnectProvider(SerializationInfo info, StreamingContext context)
  • public void AddScope(string scope)
  • public void AddScopesRange(IEnumerable<string> scopes)
  • public void ClearScopes()
  • public bool ContainsScope(string scope)
  • public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
  • public IList<string> GetScopes()
  • public bool RemoveScope(string scope)
  • public void SetScopes(IEnumerable<string> scopes)

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)

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