Relativity.Api 13.0.6 - API Reference

<PackageReference Include="Relativity.Api" Version="13.0.6" />

API Differences between 13.0.6 and 9.6.204.22

881 Additions 0 Removals

Relativity.API

public interface IDBContext
- Task BeginTransactionAsync(CancellationToken cancelToken)
- Task ExecuteBulkCopyAsync(IDataReader source, ISqlBulkCopyParameters parameters, CancellationToken cancelToken)
- Task<DataTable> ExecuteDataTableAsync(IQuery query)
- Task<IEnumerable<T>> ExecuteEnumerableAsync<T>(IQuery query, Func<IDataRecord, CancellationToken, Task<T>> converter)
- Task<int> ExecuteNonQueryAsync(IQuery query)
- Task<T> ExecuteObjectAsync<T>(IQuery query, Func<IDataReader, CancellationToken, Task<T>> converter)
- Task<IDataReader> ExecuteReaderAsync(IQuery query)
- Task<T> ExecuteScalarAsync<T>(IQuery query)
- void ExecuteSqlBulkCopy(IDataReader dataReader, ISqlBulkCopyParameters bulkCopyParameters)
- Task<IDbConnection> GetConnectionAsync(CancellationToken cancelToken)
public interface IHelper : IDisposable
- IStringSanitizer GetStringSanitizer(int workspaceID)
public interface IStringSanitizer
- bool SanitizeHtmlOutput { get; }
- SanitizeHtmlContentResult SanitizeHtmlContent(string taintedHtml)
public class SanitizeHtmlContentResult
- public string CleanHtml { get; set; }
- public ArrayList ErrorMessages { get; set; }
- public SanitizeHtmlContentResult()

Relativity.API.Context

public class ContextQuery : IQuery
- public CancellationToken CancellationToken { get; set; }
- public bool ExecuteAsStoredProcedure { get; set; }
- public int? ExecutionTimeout { get; set; }
- public IEnumerable<IDataParameter> Parameters { get; set; }
- public string SqlStatement { get; set; }
- public ContextQuery()
public interface IQuery
- CancellationToken CancellationToken { get; }
- bool ExecuteAsStoredProcedure { get; }
- int? ExecutionTimeout { get; }
- IEnumerable<IDataParameter> Parameters { get; }
- string SqlStatement { get; }
public interface ISqlBulkCopyParameters
- int? BatchSize { get; set; }
- IList<SqlBulkCopyColumnMapping> ColumnMappings { get; }
- string DestinationTableName { get; set; }
- bool? EnableStreaming { get; set; }
- SqlBulkCopyOptions? Options { get; set; }
- int? Timeout { get; set; }
public class SqlBulkCopyParameters : ISqlBulkCopyParameters
- public int? BatchSize { get; set; }
- public IList<SqlBulkCopyColumnMapping> ColumnMappings { get; }
- public string DestinationTableName { get; set; }
- public bool? EnableStreaming { get; set; }
- public SqlBulkCopyOptions? Options { get; set; }
- public int? Timeout { get; set; }
- public SqlBulkCopyParameters()

Relativity.API.Foundation

public enum AuditAction
- Begin_Secret_Roll = 55
- Case_Map_Add_Document = 7
- Case_Map_Add_Fact = 8
- ConversionComplete = 46
- Create = 2
- Delete = 9
- Document_Query = 28
- DocumentTally = 36
- End_Secret_Roll = 56
- Export = 33
- FailedLogin = 48
- File_Download = 53
- File_Upload = 52
- Generated_Report = 39
- Identity_Certificate = 57
- Images_Created = 13
- Images_Created_For_Production = 15
- Images_Deleted = 14
- Import = 32
- Invitation_Email_Sent = 51
- Login = 25
- Logout = 26
- Markup_Image_Created = 20
- Markup_Image_Deleted = 22
- Markup_Image_Modified = 21
- Markup_Native_Created = 18
- Markup_Native_Deleted = 19
- Markup_Native_Updated = 30
- Move = 11
- Native_Created = 16
- Native_Deleted = 17
- OAuth2_Client_Secret_Rolled = 54
- Password_Reset_Request_Opened = 41
- Password_Reset_Request_Submitted = 40
- Password_Reset_Request_Successful = 42
- Pivot_Query = 37
- Print = 12
- Production_Add_Document = 23
- Production_Remove_Document = 24
- Query = 29
- RelativityScriptExecution = 35
- ReportQuery = 34
- Run = 38
- Search_Cache_Table_Creation = 27
- Security = 10
- Security_Preview_Ended = 44
- Security_Preview_Started = 43
- Transcript_RTF_Created = 31
- Update = 3
- Update_Import = 47
- Update_Mass_Edit = 4
- Update_Mass_Replace = 5
- Update_Mass_Revert = 59
- Update_Propagation = 6
- Update_Revert = 58
- View = 1
- WorkspaceUpgrade = 45
public class ContextOptions : IContextOptions
- public string OnBehalfOfToken { get; set; }
- public ContextOptions()
public class ExportStatistics
- public enum ImageFileExportType
- public enum ImageLoadFileFormatType
- public enum ImagesToExportType
- public enum LoadFileFormat
- public bool AppendOriginalFilenames { get; set; }
- public int ArtifactTypeID { get; set; }
- public char Bound { get; set; }
- public bool CopyFilesFromRepository { get; set; }
- public int DataSourceArtifactID { get; set; }
- public char Delimiter { get; set; }
- public string DestinationFilesystemFolder { get; set; }
- public int DocumentExportCount { get; set; }
- public int ErrorCount { get; set; }
- public int ExportedTextFieldID { get; set; }
- public int ExportedTextFileEncodingCodePage { get; set; }
- public bool ExportImages { get; set; }
- public bool ExportMultipleChoiceFieldsAsNested { get; set; }
- public bool ExportNativeFiles { get; set; }
- public bool ExportTextFieldAsFiles { get; set; }
- public int[] Fields { get; set; }
- public int FileExportCount { get; set; }
- public string FilePathSettings { get; set; }
- public ImageFileExportType ImageFileType { get; set; }
- public ImageLoadFileFormatType ImageLoadFileFormat { get; set; }
- public ImagesToExportType ImagesToExport { get; set; }
- public int MetadataLoadFileEncodingCodePage { get; set; }
- public LoadFileFormat MetadataLoadFileFormat { get; set; }
- public char MultiValueDelimiter { get; set; }
- public char NestedValueDelimiter { get; set; }
- public char NewlineProxy { get; set; }
- public bool OverwriteFiles { get; set; }
- public int[] ProductionPrecedence { get; set; }
- public int RunTimeInMilliseconds { get; set; }
- public int SourceRootFolderID { get; set; }
- public int StartExportAtDocumentNumber { get; set; }
- public string SubdirectoryImagePrefix { get; set; }
- public long SubdirectoryMaxFileCount { get; set; }
- public string SubdirectoryNativePrefix { get; set; }
- public long SubdirectoryStartNumber { get; set; }
- public string SubdirectoryTextPrefix { get; set; }
- public int TextAndNativeFilesNamedAfterFieldID { get; set; }
- public long TotalFileBytesExported { get; set; }
- public long TotalMetadataBytesExported { get; set; }
- public string Type { get; set; }
- public long VolumeMaxSize { get; set; }
- public string VolumePrefix { get; set; }
- public int VolumeStartNumber { get; set; }
- public int WarningCount { get; set; }
- public ExportStatistics()
public enum FieldCategory
- 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 enum FieldImportBehavior
- LeaveBlankValuesUnchanged = 0
- ObjectFieldContainsArtifactId = 2
- ReplaceBlankValuesWithIdentifier = 1
public enum FieldType
- Boolean = 4
- Code = 6
- Currency = 8
- Date = 3
- Decimal = 7
- Empty = 0
- File = 10
- Integer = 2
- LayoutText = 13
- MultiCode = 9
- Object = 11
- Objects = 14
- OffTableText = 15
- Text = 5
- User = 12
- Varchar = 1
public interface IAgent : IArtifact, IArtifactRef
- int AgentTypeArtifactID { get; set; }
- string DetailMessage { get; set; }
- bool Enabled { get; set; }
- double Interval { get; set; }
- DateTime LastUpdate { get; set; }
- int LoggingLevel { get; set; }
- string Message { get; set; }
- DateTime MessageTime { get; set; }
- string MessageType { get; set; }
- string Name { get; set; }
- int ServerArtifactID { get; set; }
public interface IArtifact : IArtifactRef
- int ArtifactTypeID { get; set; }
- int CreatedBy { get; }
- DateTime CreatedOn { get; }
- bool DeleteFlag { get; set; }
- string Keywords { get; set; }
- int LastModifiedBy { get; }
- DateTime LastModifiedOn { get; }
- string Notes { get; set; }
- int? ParentArtifactID { get; set; }
- string TextIdentifier { get; set; }
public interface IArtifactRef
- int ArtifactID { get; set; }
- IList<Guid> Guids { get; set; }
public interface IAuditRecord
- AuditAction Action { get; }
- int ArtifactID { get; }
- XElement Details { get; }
- TimeSpan? ExecutionTime { get; }
public interface ICascadeDeleteAgentObjectTypeRef : IObjectTypeRef, IArtifactRef
- bool ForceDelete { get; }
public interface ICascadeDeleteDocumentObjectTypeRef : IObjectTypeRef, IArtifactRef
- DocumentDeleteOptions DocumentDeleteOptions { get; }
- bool ForceDelete { get; }
public interface IChoice : IArtifact, IArtifactRef
- int CodeTypeID { get; set; }
- bool IsActive { get; set; }
- IKeyboardShortcut KeyboardShortcut { get; set; }
- string Name { get; set; }
- int? OIHiliteStyleID { get; set; }
- int Order { get; set; }
public interface IContextOptions
- string OnBehalfOfToken { get; set; }
public interface IContextualInformation
- int WorkspaceID { get; }
- int WorkspaceUserID { get; }
public interface IField : IFieldRef, IArtifactRef, IArtifact
- bool AllowGroupBy { get; set; }
- bool AllowHtml { get; set; }
- bool AllowPivot { get; set; }
- int? AssociativeArtifactTypeID { get; set; }
- bool AutoAddChoices { get; set; }
- bool AvailableInViewer { get; set; }
- int? CodeTypeID { get; set; }
- string ColumnName { get; }
- string DisplayValueFalse { get; set; }
- string DisplayValueTrue { get; set; }
- bool EnableDataGrid { get; set; }
- int FieldArtifactTypeID { get; set; }
- FieldCategory FieldCategory { get; }
- int FieldDisplayTypeID { get; set; }
- int? FieldTreeView { get; set; }
- FieldType FieldType { get; set; }
- string FilterType { get; set; }
- string FormatString { get; set; }
- string FriendlyName { get; set; }
- FieldImportBehavior? ImportBehavior { get; set; }
- bool IsArtifactBaseField { get; set; }
- bool IsAvailableInChoiceTree { get; set; }
- bool IsAvailableToAssociativeObjects { get; set; }
- bool IsEditable { get; set; }
- bool IsGroupByEnabled { get; set; }
- bool IsIndexEnabled { get; set; }
- bool IsLinked { get; set; }
- bool IsReflected { get; }
- bool IsRemovable { get; set; }
- bool IsRequired { get; set; }
- bool IsSortable { get; set; }
- bool IsSystemField { get; }
- bool IsSystemOrRelationalField { get; }
- bool IsVisible { get; set; }
- IKeyboardShortcut KeyboardShortcut { get; set; }
- int LinkLayoutArtifactID { get; set; }
- int? MaxLength { get; set; }
- bool? OverlayBehavior { get; set; }
- int? PopupPickerView { get; set; }
- int? RelationalIndexViewArtifactID { get; set; }
- bool UseUnicodeEncoding { get; set; }
- object Value { get; set; }
- string Width { get; set; }
- bool Wrapping { get; set; }
public interface IFieldRef : IArtifactRef
- string Name { get; set; }
- int ViewFieldID { get; set; }
public interface IFile
- int FileID { get; }
- string FileName { get; set; }
- string Location { get; }
- string Message { get; }
- int ObjectArtifactID { get; }
- long? Size { get; }
- TextExtractionStatus Status { get; }
- Stream ConstructStream()
public interface IKeyboardShortcut
- bool Alt { get; set; }
- bool Ctrl { get; set; }
- int ID { get; set; }
- int Key { get; set; }
- bool Shift { get; set; }
public interface IObjectType : IArtifact, IArtifactRef, IObjectTypeRef
- bool CopyInstancesOnCaseCreation { get; set; }
- bool CopyInstancesOnParentCopy { get; set; }
- bool EnableSnapshotAuditingOnDelete { get; set; }
- bool IsDynamic { get; set; }
- bool IsSystem { get; set; }
- bool IsViewEnabled { get; set; }
- int ParentArtifactTypeID { get; set; }
- bool PersistentListsEnabled { get; set; }
- bool PivotEnabled { get; set; }
- bool SamplingEnabled { get; set; }
public interface IObjectTypeRef : IArtifactRef
- int DescriptorArtifactTypeID { get; set; }
- string Name { get; set; }
public interface IRelationalFieldPane
- string ColumnName { get; set; }
- int FieldArtifactID { get; set; }
- string HeaderText { get; set; }
- byte[] IconFileData { get; set; }
- string IconFilename { get; set; }
- int PaneID { get; set; }
- int PaneOrder { get; set; }
- int RelationalViewArtifactID { get; set; }
public interface IRelativityObject : IArtifact, IArtifactRef
- IEnumerable<IField> Fields { get; set; }
public interface ISearchProviderRef : IArtifactRef
- bool HasRank { get; set; }
public interface IView : IArtifact, IArtifactRef
- IObjectTypeRef AssociatedObjectRef { get; set; }
- bool AvailableInObjectTab { get; set; }
- IArtifactRef DashboardArtifactRef { get; set; }
- int? DisplayFieldArtifactID { get; set; }
- int? GroupDefinitionFieldArtifactID { get; set; }
- bool IsManualRerun { get; set; }
- bool IsVisible { get; set; }
- string Name { get; set; }
- int? Order { get; set; }
- int? PayloadFieldArtifactID { get; set; }
- string QueryHint { get; set; }
- int? ThreadMethod { get; set; }
- List<IViewCriteria> ViewCriteriaList { get; set; }
- List<IViewField> ViewFieldList { get; set; }
- List<IViewOrder> ViewOrderList { get; set; }
- int VisualizationType { get; set; }
public interface IViewCriteria
- int ArtifactViewFieldID { get; set; }
- string BeginParenthesis { get; set; }
- string BooleanOperator { get; set; }
- string DisplayFieldName { get; set; }
- string EndParenthesis { get; set; }
- bool NotOperator { get; set; }
- string Operator { get; set; }
- int? ParentViewCriteriaID { get; set; }
- string Value { get; set; }
- int ViewCriteriaID { get; set; }
public interface IViewerContextMenuItem
- string Action { get; set; }
- int? AssociatedPermissionID { get; set; }
- int? AssociatedSearchProviderID { get; set; }
- ViewerContextMenuItemAvailability Availability { get; set; }
- int ID { get; set; }
- bool JavascriptEncodeSelectedText { get; set; }
- string Name { get; set; }
- int Order { get; set; }
- int? ParentMenuItemID { get; set; }
- bool RequiresSelectedText { get; set; }
- bool XMLEncodeSelectedText { get; set; }
public interface IViewField
- int ArtifactViewFieldID { get; set; }
- int Order { get; set; }
- int ViewFieldID { get; set; }
public interface IViewOrder
- int ArtifactViewFieldID { get; set; }
- string Direction { get; set; }
- int Order { get; set; }
- int ViewOrderID { get; set; }
public interface IWorkspaceContext : IContextualInformation, IDBContext
- T CreateRepository<T>() where T : IRepository
- IPermissionChecker GetPermissionChecker()
public enum SystemArtifact
- ActiveResourceStatus = 77
- AdvancedSearchBrowserViewArtifactID = 19
- AgentResourceServerType = 72
- AgentTypeRelativityApplicationField = 41
- AnalyticsIndexing = 110
- AuthenticationProviderActiveDirectoryInstanceID = 142
- AuthenticationProviderClientCertInstanceID = 143
- AuthenticationProviderDescriptionFieldID = 147
- AuthenticationProviderEnabledFieldID = 148
- AuthenticationProviderObjectTypeID = 146
- AuthenticationProviderOIDCInstanceID = 152
- AuthenticationProviderPasswordInstanceID = 141
- AuthenticationProviderProviderTypeFieldID = 150
- AuthenticationProviderRSAInstanceID = 144
- AuthenticationProviderSAML2InstanceID = 145
- AuthenticationProviderSettingsFieldID = 149
- AuthenticationProviderTypeCategoryExternalChoiceID = 138
- AuthenticationProviderTypeCategoryFieldID = 136
- AuthenticationProviderTypeCategoryInternalChoiceID = 137
- AuthenticationProviderTypeDescriptionFieldID = 134
- AuthenticationProviderTypeEnabledFieldID = 135
- AuthenticationProviderTypeObjectTypeID = 133
- AuthenticationProviderTypeViewID = 139
- AuthenticationProviderViewID = 151
- AuthenticationProviderWindowsInstanceID = 140
- CaseAdmin = 2
- CaseStatusActive = 1
- ChoiceRelativityApplicationField = 43
- CredentialNameField = 154
- CredentialWorkspacesAssociation = 156
- CustomPageFileField = 61
- CustomPageFileIconField = 62
- CustomPageFileSizeField = 63
- CustomPageFileTextField = 64
- CustomPageKeywordsField = 65
- CustomPageLayout = 70
- CustomPageNameField = 60
- CustomPageNotesField = 66
- CustomPageObjectType = 59
- CustomPageRelativityApplicationField = 67
- CustomPageTab = 71
- CustomPageView = 69
- DashboardArtifactIDFieldArtifactID = 186
- DashboardAssociatedObjectFieldArtifactID = 173
- DashboardDashboardDataFieldArtifactID = 174
- DashboardDefaultViewArtifactID = 181
- DashboardGlobalButtonRuleArtifactID = 183
- DashboardMassActionRuleArtifactID = 182
- DashboardNameFieldArtifactID = 176
- DashboardObjectEditOverrideArtifactID = 184
- DashboardObjectTypeArtifactID = 172
- DashboardObjectViewOverrideArtifactID = 185
- DashboardOrderFieldArtifactID = 175
- DashboardSystemCreatedByFieldArtifactID = 178
- DashboardSystemCreatedOnFieldArtifactID = 177
- DashboardSystemModifiedByFieldArtifactID = 180
- DashboardSystemModifiedOnFieldArtifactID = 179
- DefaultMassOperationViewArtifactID = 14
- DefaultRelativityApplicationsLayoutArtifactID = 40
- DefaultRelativityClient = 117
- DefaultSearchViewArtifactID = 6
- DefaultSyncsViewArtifactID = 13
- DocumentHistoryViewArtifactID = 16
- DocumentQCStatusCodeImage = 96
- DocumentQCStatusField = 95
- DtSearchJobTypeCodeCompress = 53
- DtSearchJobTypeCodeFullBuild = 50
- DtSearchJobTypeCodeIncrementalBuild = 51
- DtSearchJobTypeCodeResolveErrors = 52
- DtSearchStatusCodeCancel = 54
- DtSearchStatusCodeCreatingPopTable = 45
- DtSearchStatusCodeError = 49
- DtSearchStatusCodeFinalizing = 48
- DtSearchStatusCodeIndexing = 47
- DtSearchStatusCodeInitializing = 46
- DtSearchStatusCodeWaiting = 44
- ErrorsTab = 100
- EveryoneGroup = 119
- FederatedInstanceInstanceURLFieldID = 170
- FederatedInstanceNameFieldID = 169
- FederatedInstanceObjectTypeID = 168
- FieldRelativityApplicationField = 42
- GlobalApplicationOnRelativityApplication = 120
- HasTaggedAnnotationsFieldArtifactID = 23
- HeaderTypeBatesNumberArtifactID = 8
- HeaderTypeDocumentIdentifierPlusPageNumberArtifactID = 12
- HeaderTypeFieldArtifactID = 9
- HeaderTypeFreetextArtifactID = 10
- HeaderTypeOriginalImageNumberArtifactID = 11
- InactiveResourceStatus = 78
- KeywordSearchSearchProviderArtifactID = 116
- LoginMethodAuthenticationProviderIDFieldID = 131
- LoginMethodEnabledFieldID = 122
- LoginMethodInvalidLoginAttemptsFieldID = 129
- LoginMethodObjectTypeID = 121
- LoginMethodPasswordHashFieldID = 126
- LoginMethodPasswordLastResetOnFieldID = 130
- LoginMethodPasswordSaltFieldID = 125
- LoginMethodProviderFieldID = 123
- LoginMethodSettingsFieldID = 127
- LoginMethodSubjectFieldID = 128
- LoginMethodUserFieldID = 124
- LoginMethodViewArtifactID = 132
- MarkupHistoryDetailsViewID = 17
- MassOperationLayoutPickerView = 97
- MassOperationOnObjectTypeView = 98
- OAuth2ClientAccessTokenLifetimeFieldID = 158
- OAuth2ClientContextUserFieldID = 171
- OAuth2ClientFlowFieldID = 159
- OAuth2ClientIdFieldID = 160
- OAuth2ClientIsEnabledFieldID = 161
- OAuth2ClientIsSystemFieldID = 162
- OAuth2ClientNonSystemViewID = 164
- OAuth2ClientObjectTypeAritfactID = 157
- OAuth2ClientScopesFieldID = 163
- OAuth2ClientSystemViewID = 165
- PivotProfileObjectTypeArtifactID = 36
- ProcessingJobTypeDiscover = 84
- ProcessingJobTypeFinalizeInventory = 94
- ProcessingJobTypeInventory = 93
- ProcessingJobTypePublish = 88
- ProcessingJobTypeRepublish = 90
- ProcessingJobTypeRetryDiscover = 85
- ProcessingJobTypeRetryPublish = 91
- ProcessingStatusCodeCanceled = 83
- ProcessingStatusCodeCanceling = 81
- ProcessingStatusCodeFinalizing = 86
- ProcessingStatusCodeProcessing = 82
- ProcessingStatusCodeRetrievingErrors = 87
- ProcessingStatusCodeSubmittingJob = 80
- ProcessingStatusCodeWaiting = 79
- ProductionDocumentsViewArtifactID = 7
- ProductionPickerViewArtifactID = 5
- ProductionSetQueueStatusProducing_CreatingAndApplyingBatesNumbers = 38
- ProductionSetQueueStatusProducing_CreatingBrandingQueueRecords = 39
- ProductionSetQueueStatusProducing_CreatingPlaceholderImages = 37
- RelativityApplicationAgentTypeField = 34
- RelativityApplicationChoiceField = 33
- RelativityApplicationCustomPageField = 68
- RelativityApplicationDashboardField = 187
- RelativityApplicationEventHandlerField = 32
- RelativityApplicationFieldField = 25
- RelativityApplicationIsDirtyField = 58
- RelativityApplicationLastExportedField = 56
- RelativityApplicationLayoutField = 26
- RelativityApplicationLockedField = 30
- RelativityApplicationMassOperationField = 99
- RelativityApplicationObjectRuleField = 31
- RelativityApplicationObjectTypeField = 24
- RelativityApplicationOriginSignatureField = 57
- RelativityApplicationRelativityScriptField = 29
- RelativityApplicationSavedSearchField = 114
- RelativityApplicationsObjectType = 21
- RelativityApplicationsTab = 20
- RelativityApplicationTabDisplayField = 89
- RelativityApplicationTabField = 28
- RelativityApplicationVersionField = 55
- RelativityApplicationViewField = 27
- RelativityNativeTypeFieldArtifactID = 22
- ResourceServerTypeAnalytics = 76
- ResourceServerTypeCacheLocation = 101
- ResourceServerTypeProcessing = 75
- RightClickTaggingLayoutArtifactID = 18
- RootFolder = 3
- RootSearchContainer = 4
- SavedSearchRelativityApplicationField = 115
- ScopeDescriptionFieldID = 167
- ScopeObjectTypeArtifactID = 166
- SearchResultsPaneViewArtifactID = 15
- ServiceAccountArtifactID = 118
- SQLDistributedResourceServerType = 113
- SQLPrimaryResourceServerType = 112
- StructuredDataAnalytics = 111
- System = 0
- UnlockedRelativityApplicationsPickerViewID = 35
- UserFriendlyUrlOnRelativityApplication = 92
- WebBackgroundProcessingServerType = 74
- WorkerResourceServerType = 73
- WorkerServerAllowedOptionBasicImaging = 107
- WorkerServerAllowedOptionNativeImaging = 106
- WorkerServerAllowedOptionProcessing = 108
- WorkerServerAllowedOptionSaveAsPDF = 109
- WorkerServerOptionBasicImaging = 102
- WorkerServerOptionNativeImaging = 103
- WorkerServerOptionProcessing = 104
- WorkerServerOptionSaveAsPDF = 105
- WorkspaceCredentialsAssociation = 155
- WorkspaceNameField = 153
public enum TextExtractionStatus
- Error = 2
- Pending = 0
- Success = 1
public enum ViewerContextMenuItemAvailability
- All = 0
- ImageAndProduction = 2
- NativeAndText = 1

Relativity.API.Foundation.Extension

public static class FieldExtensions
- public static void PopulateBooleanValue(this IField field, bool value)
- public static void PopulateCurrencyValue(this IField field, decimal value)
- public static void PopulateDateValue(this IField field, DateTime value)
- public static void PopulateDecimalValue(this IField field, decimal value)
- public static void PopulateFileValue(this IField field, IFile value)
- public static void PopulateIntegerValue(this IField field, int value)
- public static void PopulateMultipleChoiceValue(this IField field, int[] value)
- public static void PopulateMultipleObjectsValue(this IField field, int[] value)
- public static void PopulateSingleChoiceValue(this IField field, int value)
- public static void PopulateSingleObjectValue(this IField field, int value)
- public static void PopulateTextField(this IField field, string value)
- public static void PopulateUserValue(this IField field, int value)
- public static void PopulateVarcharValue(this IField field, string value)

Relativity.API.Foundation.MassOperations

public enum AuditLevel
- FullAudit = 0
- NoAudit = 2
- NoSnapshot = 1
public enum DocumentDeleteOptions
- DeleteDocumentAndAllAssociatedFiles = 0
- DeleteOnlyImages = 1
- DeleteOnlyNatives = 2
- DeleteOnlyNativesAndImages = 3
public enum ExportToFileOptions
- Csv = 0
- Dat = 1
- Xls = 2
public interface ICancelImagingJobBuilder : IMassOperationBuilderWithoutParameters<IMassOperation, string>, IMassOperationBuilder, IContextualInformation
public interface ICascadeDeleteBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICascadeDeleteParameters>, IMassOperationBuilder, IContextualInformation
public interface ICascadeDeleteParameters
- int? BatchSize { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface ICopyBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICopyParameters>, IMassOperationBuilder, IContextualInformation
public interface ICopyParameters
- int? BatchSize { get; set; }
- IObjectTypeRef ObjectType { get; }
- IArtifactRef ParentArtifact { get; }
- Guid? ProcessIdentifier { get; }
public interface ICreateBuilder : IMassOperationBuilderWithObjectList<IMassOperation, IRelativityObject, ICreateParameters>, IMassOperationBuilder, IContextualInformation
public interface ICreateParameters
- AuditLevel AuditLevel { get; }
- IEnumerable<IFieldRef> Fields { get; }
- IObjectTypeRef ObjectType { get; }
- IArtifactRef ParentArtifact { get; }
public interface ICustomBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICustomParameters>, IMassOperationBuilder, IContextualInformation
public interface ICustomParameters
- int? BatchSize { get; }
- IArtifactRef CustomMassOperationArtifactID { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface IDeleteBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IDeleteParameters>, IMassOperationBuilder, IContextualInformation
public interface IDeleteParameters
- int? BatchSize { get; set; }
- IObjectTypeRef ObjectType { get; }
public interface IEditBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IEditParameters>, IMassOperationBuilder, IContextualInformation
public interface IEditParameters
- int? BatchSize { get; set; }
- IEnumerable<IField> Fields { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface IEditWorkerManagerItemPriorityBuilder : IMassOperationBuilderWithParameters<IMassOperation, string, IEditWorkerManagerPriorityParameters>, IMassOperationBuilder, IContextualInformation
public interface IEditWorkerManagerPriorityParameters
- int Priority { get; }
public interface IExportToFileBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IExportToFileParameters>, IMassOperationBuilder, IContextualInformation
public interface IExportToFileParameters
- Encoding Encoding { get; }
- Stream ExportResults { get; }
- IEnumerable<IFieldRef> Fields { get; }
- ExportToFileOptions FileOptions { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
- ISearchProviderRef SearchProvider { get; }
- IArtifactRef View { get; }
public interface IMassOperation
- Exception Exception { get; }
- bool IsCanceled { get; set; }
- DateTime LastTouched { get; }
- bool ManageOperationCount { get; set; }
- string Name { get; }
- int OperationsCompleted { get; }
- double OperationsCompletePercentage { get; }
- Guid ProcessID { get; }
- OperationState State { get; }
- string Status { get; }
- int TotalOperations { get; }
- event Action<int> RecordsProcessed
- void Execute()
public interface IMassOperationBuilder : IContextualInformation
public interface IMassOperationBuilderWithObjectList<TMassOperation, TOperands, TMassOperationParameters> : IMassOperationBuilder, IContextualInformation where TMassOperation : IMassOperation
- TMassOperation CreateMassOperation(IEnumerable<TOperands> operands, TMassOperationParameters parameters)
public interface IMassOperationBuilderWithoutParameters<TMassOperation, TIDs> : IMassOperationBuilder, IContextualInformation where TMassOperation : IMassOperation
- TMassOperation CreateMassOperation(long processTableId)
- TMassOperation CreateMassOperation(IEnumerable<TIDs> ids)
public interface IMassOperationBuilderWithParameters<TMassOperation, TIDs, TMassOperationParameters> : IMassOperationBuilder, IContextualInformation where TMassOperation : IMassOperation
- TMassOperation CreateMassOperation(long processTableId, TMassOperationParameters parameters)
- TMassOperation CreateMassOperation(IEnumerable<TIDs> ids, TMassOperationParameters parameters)
public interface IMassOperationCompletedEvent
- int OperationsCompleted { get; }
- int TotalOperations { get; }
public interface IMoveBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IMoveParameters>, IMassOperationBuilder, IContextualInformation
public interface IMoveParameters
- int? BatchSize { get; }
- IArtifactRef DestinationFolder { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
public interface IReplaceAction
- IFieldRef FieldToReplaceWith { get; }
- ReplaceWithOptions ReplaceWithOptions { get; }
- string TextToReplaceWith { get; }
public interface IReplaceBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IReplaceParameters>, IMassOperationBuilder, IContextualInformation
public interface IReplaceFieldRef
- IFieldRef FieldToReplace { get; }
- IReplaceAction ReplaceAction { get; }
- IReplaceOptions ReplaceOptions { get; }
public interface IReplaceOptions
- ReplaceActionOptions ReplaceActionOptions { get; }
- string ReplaceActionValue { get; }
public interface IReplaceParameters
- int? BatchSize { get; }
- IObjectTypeRef ObjectType { get; }
- Guid? ProcessIdentifier { get; }
- IEnumerable<IReplaceFieldRef> ReplaceFields { get; }
public interface IResumeProcessingJobBuilder : IMassOperationBuilderWithoutParameters<IMassOperation, string>, IMassOperationBuilder, IContextualInformation
public interface ITallySumAverageBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ITallySumAverageParameters>, IMassOperationBuilder, IContextualInformation
public interface ITallySumAverageParameters
- IFieldRef Field { get; }
- IObjectTypeRef ObjectType { get; }
- TallySumAverageOptions Operation { get; }
- Guid? ProcessIdentifier { get; }
- DataTable ReportTable { get; }
public enum OperationState
- Canceled = 6
- Cancelling = 7
- Completed = 2
- CompletedWithError = 8
- HandledException = 3
- Idle = 0
- Running = 1
- RunningWarning = 5
- UnhandledException = 4
public enum ReplaceActionOptions
- Append = 1
- FindReplace = 3
- Insert = 2
- ReplaceWhole = 0
public enum ReplaceWithOptions
- Field = 1
- Text = 0
public enum TallySumAverageOptions
- Average = 2
- Sum = 1
- Tally = 0

Relativity.API.Foundation.ObjectRule

public interface IChoiceAddLinkVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IChoiceAddLinkVisibilityRule>
public interface IChoiceAddLinkVisibilityRule : IObjectRule, IArtifact, IArtifactRef
- bool AllowAdd { get; set; }
- bool AllowDelete { get; set; }
- bool AllowRename { get; set; }
- int SelectedFieldID { get; set; }
public interface IConditionalButtonVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IConditionalButtonVisibilityRule>
public interface IConditionalButtonVisibilityRule : IGlobalButtonVisibilityRule, IObjectRule, IArtifact, IArtifactRef
- int AssociativeOrChildObject { get; set; }
- int SelectedChoiceID { get; set; }
- int SelectedFieldID { get; set; }
public interface ICustomSingleObjectAddLinkVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<ICustomSingleObjectAddLinkVisibilityRule>
public interface ICustomSingleObjectAddLinkVisibilityRule : IObjectRule, IArtifact, IArtifactRef
- bool ShowAddLink { get; set; }
public interface IDefaultLayoutObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IDefaultLayoutRule>
public interface IDefaultLayoutOnNewObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IDefaultLayoutOnNewRule>
public interface IDefaultLayoutOnNewRule : IObjectRule, IArtifact, IArtifactRef
- int LayoutArtifactID { get; set; }
public interface IDefaultLayoutRule : IObjectRule, IArtifact, IArtifactRef
- bool AllowLayoutChange { get; set; }
- int SelectedChoiceArtifactID { get; set; }
- int SelectedFieldArtifactID { get; set; }
- int SelectedLayoutArtifactID { get; set; }
public interface IGlobalButtonVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IGlobalButtonVisibilityRule>
public interface IGlobalButtonVisibilityRule : IObjectRule, IArtifact, IArtifactRef
- bool ShowDelete { get; set; }
- bool ShowLink { get; set; }
- bool ShowNew { get; set; }
- bool ShowUnlink { get; set; }
public interface IMassActionVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IMassActionVisibilityRule>
public interface IMassActionVisibilityRule : IObjectRule, IArtifact, IArtifactRef
- bool ShowMassCopy { get; set; }
- bool ShowMassEdit { get; set; }
- bool ShowMassReplace { get; set; }
- bool ShowMassTally { get; set; }
public interface INewButtonOverrideObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<INewButtonOverrideRule>
public interface INewButtonOverrideRule : IObjectRule, IArtifact, IArtifactRef
- string Href { get; set; }
public interface IObjectRule : IArtifact, IArtifactRef
- string Name { get; set; }
- int ParentObjectArtifactTypeID { get; set; }
public interface IObjectRuleRepositoryBase<T> where T : IObjectRule
- int Create(T objectRule)
- T Read(IArtifactRef artifactRef)
- void Update(T objectRule)
public interface IOverrideEditLinkUrlObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IOverrideEditLinkUrlRule>
public interface IOverrideEditLinkUrlRule : IObjectRule, IArtifact, IArtifactRef
- string Href { get; set; }
public interface IOverrideViewLinkUrlObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IOverrideViewLinkUrlRule>
public interface IOverrideViewLinkUrlRule : IObjectRule, IArtifact, IArtifactRef
- string Href { get; set; }

Relativity.API.Foundation.Permissions

public enum AdminPermission
- AgentOperations = 0
- AllowdtSearchIndexSwap = 1
- AllowExport = 2
- AllowImport = 3
- AssignBatches = 4
- ChangeQueuePriority = 5
- DeleteObjectDependencies = 6
- DownloadRelativityDesktopClient = 7
- EmailThreadVisualization = 9
- ExportDashboard = 8
- ForceLogoutOnUserStatus = 10
- ManageObjectTypes = 11
- ManageRelativityApplications = 12
- ModifySystemKeyboardShortcuts = 13
- OverrideProductionRestrictions = 14
- SendMessage = 15
- UsePivotAndChart = 16
- UseQuickNav = 17
- UseSampling = 18
- ViewAdminRepository = 19
- ViewAllAudits = 20
- ViewAudits = 21
- ViewBatchPane = 22
- ViewImagesHiddenForQCReview = 24
- ViewImageThumbnails = 23
- ViewUserPersonalItems = 26
- ViewUserStatus = 25
- ViewWorkspaceDetails = 27
public interface IArtifactPermission
- IArtifactRef Artifact { get; }
- IEnumerable<IPermissionCheckResult> Permissions { get; }
public interface IPermissionChecker : IContextualInformation
- bool HasAdminOperationPermission(AdminPermission permission)
- bool HasPermission(IArtifactRef artifactRef, PermissionType permission)
- IArtifactPermission HasPermission(IArtifactRef artifactRef, IEnumerable<PermissionType> permissionsTypes)
- IEnumerable<IArtifactPermission> HasPermission(IEnumerable<IArtifactRef> artifactRefs, IEnumerable<PermissionType> permissionTypes)
public interface IPermissionCheckResult
- bool HasPermission { get; }
- PermissionType Type { get; }
public enum PermissionType
- Add = 6
- Delete = 3
- Edit = 2
- Secure = 4
- View = 1

Relativity.API.Foundation.Repositories

public interface IAgentRepository : IRepository, IContextualInformation
- int Create(IAgent agent)
- IAgent Read(int artifactID)
- void Update(IAgent agent)
public interface IApplicationArtifactCacheRepository : IRepository, IContextualInformation
- int? GetArtifactIDByGuids(IList<Guid> guids)
- int? GetArtifactIDFromGuid(Guid guid)
- List<Guid> GetGuidsFromArtifactID(int artifactID)
public interface IAuditRepository : IRepository, IContextualInformation
- object CreateAuditRecord(IAuditRecord auditRecord)
- Task CreateAuditRecords(IEnumerable<IAuditRecord> auditRecords)
public interface IChoiceRepository : IRepository, IContextualInformation
- int Create(IChoice choice)
- IChoice Read(int artifactID)
- IChoice Read(IArtifactRef choiceRef)
- void Update(IChoice choice)
public interface IErrorRepository : IRepository, IContextualInformation
- int Create(Exception ex, string source, bool sendNotification)
- int Create(string fullError, string message, string source, bool sendNotification)
public interface IExportAuditRepository : IRepository, IContextualInformation
- bool CreateAuditForExport(ExportStatistics exportStatistics, int contextUserId)
public interface IFieldRepository : IRepository, IContextualInformation
- int Create(IField field)
- IEnumerable<IField> GetAllFields(IObjectTypeRef objectTypeRef)
- IField Read(IArtifactRef fieldRef)
- void Update(IField field, string newDisplayName)
public interface IObjectRepository : IRepository, IContextualInformation
- int Create(IRelativityObject relativityObject)
- IRelativityObject Read(IArtifactRef artifactRef, IEnumerable<IFieldRef> fields)
- void Update(IRelativityObject relativityObject)
public interface IObjectTypeCacheRepository : IRepository, IContextualInformation
- IObjectType RetrieveObjectTypeByIdentifier(IArtifactRef artifactRef)
public interface IRepository : IContextualInformation
public interface ISystemArtifactCacheRepository : IRepository, IContextualInformation
- bool ExistsInSystemArtifact(int artifactID)
- int RetrieveArtifactIDByIdentifier(string identifier)
- int RetrieveArtifactIDByIdentifier(SystemArtifact identifier)
public interface ISystemArtifactTypeCacheRepository : IRepository, IContextualInformation
- int RetrieveArtifactIDByIdentifier(SystemArtifact systemArtifact)
- int RetrieveArtifactIDByIdentifier(string systemArtifact)
public interface IViewerContextMenuItemRepository : IRepository, IContextualInformation
- int Create(IViewerContextMenuItem viewerContextMenuItem)
public interface IViewRepository : IRepository, IContextualInformation
- int Create(IView view)
- IView Read(IArtifactRef viewRef)
- void Update(IView view)

Relativity.API.Managers

public interface ISanitizerManagerHelper
- bool SanitizeHtmlOutput { get; }
- SanitizeHtmlContentResult SanitizeHtmlContent(string taintedHtml)