Relativity.Imaging.SDK 12.3.4

API Differences between 12.3.4 and 11.3.157.22

409 Additions 7 Removals

Relativity.Imaging.Services.Interfaces

public class ConsoleButtonStatus
public class ConsoleLinkButtonStatus
public interface IImagingHealthCheckManager : IDisposable
public interface IImagingHealthCheckManagerLegacy : IDisposable
- Task<ImagingAgentsHealthResponse> GetAgentsHealthAsync(ImagingAgentsHealthRequest agentsHealthRequest)
- Task<EnvironmentStatusResponse> GetEnvironmentStatusAsync(EnvironmentStatusRequest environmentStatusRequest)
public interface IImagingSetManager : IDisposable
- Task<ImagingSetConsoleStatusResponse> GetConsoleStatusAsync(int imagingSetId, int workspaceId)
public interface IImagingStatusManager : IDisposable
public interface IImagingWarningManager : IDisposable
public class ImagingSetConsoleStatusResponse
public interface IVersionedImagingModule

Relativity.Imaging.Services.Interfaces.V1

public interface IApplicationFieldCodeManager : IDisposable
- Task<int> CreateAsync(int workspaceID, ApplicationFieldCodeRequest applicationFieldCode)
- Task<bool> DeleteAsync(int workspaceID, int applicationFieldCodeID)
- Task<ApplicationFieldCode> ReadAsync(int workspaceID, int applicationFieldCodeID)
- Task<int> UpdateAsync(int workspaceID, int applicationFieldCodeID, ApplicationFieldCodeRequest applicationFieldCode)
public interface IDocumentStatusManager : IDisposable
- Task<DocumentStatusResponse> GetStatusAsync(int workspaceID, int documentID)
public interface IImagingAutomatedWorkflowsManager : IDisposable
- Task<ImagingSetWorkflowStatus> GetImagingSetWorkflowStatusAsync(int workspaceID, int imagingSetID)
- Task RunImagingSetForAutomatedWorkflowAsync(int workspaceID, int imagingSetID, ImagingSetRequest imagingSetRequest)
public interface IImagingEnvironmentManager : IDisposable
- Task CleanupInactiveJobsAsync()
- Task<int> GetMaxMassImagingJobSizeAsync()
public interface IImagingJobManager : IDisposable
- Task<ImageOnTheFlyResponse> ImageDocumentAsync(int workspaceID, int documentArtifactID, ImageOnTheFlyRequest imageOnTheFlyRequest)
- Task<MassImagingResponse> MassImageDocumentsByMassProcessIdAsync(int workspaceID, MassImageRequest massImageRequest)
- Task<ImagingSetResponse> RetryImagingSetErrorsAsync(int workspaceID, int imagingSetID, ImagingSetRequest imagingSetRequest)
- Task<ImagingSetResponse> RunImagingSetAsync(int workspaceID, int imagingSetID, ImagingSetRequest imagingSetRequest)
- Task<StopImagingJobResponse> StopImagingJobAsync(int workspaceID, long imagingJobID, StopImagingJobRequest stopImagingJobRequest)
- Task<UpdateJobPriorityResponse> UpdateJobPriorityAsync(int workspaceID, long imagingJobID, UpdateJobPriorityRequest updateJobPriorityRequest)
public interface IImagingProfileManager : IDisposable
- Task<int> CreateBasicImagingProfileAsync(int workspaceID, BasicImagingProfileCreateRequest request)
- Task<int> CreateNativeImagingProfileAsync(int workspaceID, NativeImagingProfileCreateRequest request)
- Task DeleteAsync(int workspaceID, int imagingProfileID)
- Task<ImagingProfile> ReadAsync(int workspaceID, int imagingProfileID)
- Task<int> UpdateAsync(int workspaceID, int imagingProfileID, ImagingProfileUpdateRequest request)
public interface IImagingSetManager : IDisposable
- Task<int> CreateAsync(int workspaceID, ImagingSetCreateRequest request)
- Task DeleteAsync(int workspaceID, int imagingSetID)
- Task<ImagingSetStatusResponse> GetStatusAsync(int workspaceID, int imagingSetID)
- Task HideImagingSetAsync(int workspaceID, int imagingSetID)
- Task<ImagingSet> ReadAsync(int workspaceID, int imagingSetID)
- Task ReleaseImagingSetAsync(int workspaceID, int imagingSetID)
- Task<int> UpdateAsync(int workspaceID, int imagingSetID, ImagingSetUpdateRequest request)
public interface INativeTypeManager : IDisposable
- Task<NativeType> ReadAsync(int workspaceID, int nativeTypeID)

Relativity.Imaging.Services.Interfaces.V1.DTOs

public class ApplicationFieldCodeRequest
- public ApplicationType Application { get; set; }
- public string FieldCode { get; set; }
- public List<ImagingProfileRef> ImagingProfiles { get; set; }
- public ApplicationFieldCodeOption Option { get; set; }
- public FieldRef RelativityField { get; set; }
- public ApplicationFieldCodeRequest()
public class BasicImagingProfileCreateRequest : ImagingProfileCreateRequest
- public BasicImagingProfileCreateRequest()
public class DocumentError
- public string Message { get; set; }
- public string Status { get; set; }
- public DocumentError()
public class DocumentStatusResponse
- public DocumentError Error { get; set; }
- public string HasImages { get; set; }
- public int ImageCount { get; set; }
- public List<DocumentWarning> Warnings { get; set; }
- public DocumentStatusResponse()
public class DocumentWarning
- public string Message { get; set; }
- public string Type { get; set; }
- public DocumentWarning()
public class ImageOnTheFlyRequest : ImagingJobBase
- public string AlternateNativeLocation { get; set; }
- public int ProfileID { get; set; }
- public bool RemoveAlternateNativeAfterImaging { get; set; }
- public ImageOnTheFlyRequest()
public class ImageOnTheFlyResponse
- public long ImagingJobID { get; set; }
- public ImageOnTheFlyResponse()
public class ImagingJobBase
- public Guid? OriginationID { get; set; }
- public ImagingJobBase()
public class ImagingJobStatusRequest
- public Guid JobGuid { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public ImagingJobStatusRequest()
public class ImagingJobStatusResponse
- public long JobArtifactID { get; set; }
- public bool JobExists { get; set; }
- public int JobPriority { get; set; }
- public ImagingJobStatus JobStatus { get; set; }
- public int NumberOfDocumentsCompleted { get; set; }
- public int NumberOfDocumentsErrored { get; set; }
- public int NumberOfDocumentsSkipped { get; set; }
- public int NumberOfDocumentsSubmitted { get; set; }
- public int NumberOfDocumentsWaiting { get; set; }
- public ImagingJobStatusResponse()
public abstract class ImagingProfileCreateRequest
- public BasicImagingEngineOptions BasicOptions { get; set; }
- public string Keywords { get; set; }
- public string Name { get; set; }
- public List<NativeTypeRef> NativeTypes { get; set; }
- public string Notes { get; set; }
- protected ImagingProfileCreateRequest()
public class ImagingProfileUpdateRequest : ImagingProfileCreateRequest
- public List<ApplicationFieldCodeRef> ApplicationFieldCodes { get; set; }
- public EmailOptions EmailOptions { get; set; }
- public HtmlOptions HtmlOptions { get; set; }
- public ImagingMethod ImagingMethod { get; set; }
- public NativeImagingEngineOptions NativeOptions { get; set; }
- public PresentationOptions PresentationOptions { get; set; }
- public SpreadsheetOptions SpreadsheetOptions { get; set; }
- public WordProcessingOptions WordProcessingOptions { get; set; }
- public ImagingProfileUpdateRequest()
public class ImagingSetCreateRequest
- public int DataSourceID { get; set; }
- public string EmailNotificationRecipients { get; set; }
- public int ImagingProfileID { get; set; }
- public string Name { get; set; }
- public ImagingSetCreateRequest()
public class ImagingSetRequest : ImagingJobBase
- public bool? QcEnabled { get; set; }
- public ImagingSetRequest()
public class ImagingSetResponse
- public long ImagingJobID { get; set; }
- public ImagingSetResponse()
public class ImagingSetStatusResponse
- public long? JobArtifactId { get; set; }
- public bool JobExists { get; set; }
- public Guid? JobGuid { get; set; }
- public int? JobPriority { get; set; }
- public DateTime? JobStartTime { get; set; }
- public ImagingJobStatus JobStatus { get; set; }
- public int JobType { get; set; }
- public string LastRunError { get; set; }
- public int? NumberOfDocuments { get; set; }
- public int? NumberOfDocumentsCompleted { get; set; }
- public int? NumberOfDocumentsErrored { get; set; }
- public int? NumberOfDocumentsHidden { get; set; }
- public int? NumberOfDocumentsSkipped { get; set; }
- public int? NumberOfDocumentsSubmitted { get; set; }
- public int? NumberOfDocumentsViewable { get; set; }
- public int? NumberOfDocumentsWaiting { get; set; }
- public int? NumberOfDocumentsWithWarnings { get; set; }
- public bool QcReviewEnabledOnLastRun { get; set; }
- public string Status { get; set; }
- public int? SubmittedByUserId { get; set; }
- public ImagingSetStatusResponse()
public class ImagingSetUpdateRequest : ImagingSetCreateRequest
- public ImagingSetUpdateRequest()
public class ImagingSetWorkflowStatus
- public string Message { get; set; }
- public string Status { get; set; }
- public ImagingSetWorkflowStatus()
public class MassImageRequest : ImagingJobBase
- public string MassProcessID { get; set; }
- public int ProfileID { get; set; }
- public SourceType SourceType { get; set; }
- public MassImageRequest()
public class MassImagingResponse
- public long ImagingJobID { get; set; }
- public MassImagingResponse()
public class NativeImagingProfileCreateRequest : ImagingProfileCreateRequest
- public List<ApplicationFieldCodeRef> ApplicationFieldCodes { get; set; }
- public EmailOptions EmailOptions { get; set; }
- public HtmlOptions HtmlOptions { get; set; }
- public NativeImagingEngineOptions NativeOptions { get; set; }
- public PresentationOptions PresentationOptions { get; set; }
- public SpreadsheetOptions SpreadsheetOptions { get; set; }
- public WordProcessingOptions WordProcessingOptions { get; set; }
- public NativeImagingProfileCreateRequest()
public class StopImagingJobRequest : ImagingJobBase
- public StopImagingJobRequest()
public class StopImagingJobResponse
- public string ErrorMessage { get; set; }
- public bool Success { get; set; }
- public StopImagingJobResponse()
public class UpdateJobPriorityRequest : ImagingJobBase
- public int Priority { get; set; }
- public UpdateJobPriorityRequest()
public class UpdateJobPriorityResponse
- public string ErrorMessage { get; set; }
- public bool Success { get; set; }
- public UpdateJobPriorityResponse()

Relativity.Imaging.Services.Interfaces.V1.Enums

public enum ApplicationFieldCodeOption
- DocumentDefault = 1
- NotSet = 0
- ReplaceWithRelativityField = 4
- ShowFieldCode = 2
- ShowNothing = 3
public enum ApplicationType
- MicrosoftExcel = 2
- MicrosoftPowerpoint = 3
- MicrosoftVisio = 4
- MicrosoftWord = 1
- NotSet = 0
public enum BasicCategory
- Database = 1
- Graphic = 2
- Multimedia = 3
- Other = 0
- Spreadsheet = 4
- WordProcessor = 5
public enum DitheringAlgorithm
- Clustered16X16 = 2
- Clustered6X6 = 0
- Clustered8X8 = 1
- Dispersed16X16 = 5
- Dispersed4X4 = 3
- Dispersed8X8 = 4
- FloydAndSteinberg = 6
- Threshold = 7
public enum Formatting
- AutoFitColumns = 1
- AutoFitRows = 0
- ClearFormattingInEmptyColumns = 3
- ClearFormattingInEmptyRows = 2
public enum ImageFormat
- Jpeg = 1
- Tiff = 0
public enum ImageSize
- A4 = 2
- Custom = 4
- Legal = 3
- Letter = 1
- OriginalSetting = 0
public enum ImagingJobStatus
- CancelRequested = 2
- Created = 1
- Default = 0
- Invalid = -1
- PickedUpByAgent = 3
- SubmittedToInvariant = 4
public enum ImagingMethod
- Basic = 0
- Native = 1
public enum Include
- Comments = 0
- FieldCodes = 1
- HiddenText = 2
public enum IncludeGridlines
- No = 2
- OriginalSetting = 0
- Yes = 1
public enum IncludeHeadersAndFooters
- No = 2
- OriginalSetting = 0
- Yes = 1
public enum IncludeRowAndColumnHeadings
- No = 2
- OriginalSetting = 0
- Yes = 1
public enum NativeCategory
- Email = 2
- Html = 5
- Other = 0
- Presentation = 4
- Spreadsheet = 1
- WordProcessor = 3
public enum Orientation
- Landscape = 1
- Portrait = 0
public enum PageOrder
- DownThenOver = 1
- OriginalSetting = 0
- OverThenDown = 2
public enum PageOrientation
- Landscape = 2
- OriginalSetting = 0
- Portrait = 1
public enum PaperSizeOrientation
- Ledger = 4
- Letter11X8Point5 = 2
- Letter8Point5X11 = 1
- OriginalSetting = 0
- Tabloid = 3
public enum PrintArea
- IgnorePrintArea = 1
- OriginalSetting = 0
public enum SlideOrientation
- Landscape = 2
- OriginalSetting = 0
- Portrait = 1
public enum SourceType
- Native = 0
- RenderedPdf = 1
public enum TextVisibility
- RemoveBackgroundFillColors = 0
- SetTextColorToBlack = 1

Relativity.Imaging.Services.Interfaces.V1.Models

public class ApplicationFieldCode : ApplicationFieldCodeRef
- public ApplicationType Application { get; set; }
- public string FieldCode { get; set; }
- public List<ImagingProfileRef> ImagingProfiles { get; set; }
- public ApplicationFieldCodeOption Option { get; set; }
- public FieldRef RelativityField { get; set; }
- public ApplicationFieldCode()
public class ApplicationFieldCodeRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public ApplicationFieldCodeRef()
public class BasicImagingEngineOptions
- public const int MAX_OUTPUT_DPI = 2400
- public ImageFormat BasicImageFormat { get; set; }
- public int ImageOutputDpi { get; set; }
- public ImageSize ImageSize { get; set; }
- public decimal? MaximumImageHeight { get; set; }
- public decimal? MaximumImageWidth { get; set; }
- public BasicImagingEngineOptions()
public class EmailOptions
- public bool ClearIndentations { get; set; }
- public bool DetectCharacterEncoding { get; set; }
- public bool DisplaySmtpAddresses { get; set; }
- public bool DownloadImagesFromInternet { get; set; }
- public Orientation Orientation { get; set; }
- public bool ResizeImagesToFitPage { get; set; }
- public bool ResizeTablesToFitPage { get; set; }
- public bool ShowMessageTypeInHeader { get; set; }
- public bool SplitTablesToFitPageWidth { get; set; }
- public EmailOptions()
public class HtmlOptions
- public bool RemoveNonBreakingSpaceCodes { get; set; }
- public HtmlOptions()
public class ImagingProfile : ImagingProfileRef
- public const string DEFAULT_BASIC_PROFILE_NAME = "Basic Default"
- public static readonly Guid DEFAULT_INSTANCE_GUID
- public const string DEFAULT_NATIVE_PROFILE_NAME = "Native Default"
- public const string DEFAULT_PROFILE_NAME = "Default"
- public List<ApplicationFieldCodeRef> ApplicationFieldCodes { get; set; }
- public BasicImagingEngineOptions BasicOptions { get; set; }
- public EmailOptions EmailOptions { get; set; }
- public HtmlOptions HtmlOptions { get; set; }
- public ImagingMethod ImagingMethod { get; set; }
- public string Keywords { get; set; }
- public NativeImagingEngineOptions NativeOptions { get; set; }
- public List<NativeTypeRef> NativeTypes { get; set; }
- public string Notes { get; set; }
- public PresentationOptions PresentationOptions { get; set; }
- public SpreadsheetOptions SpreadsheetOptions { get; set; }
- public WordProcessingOptions WordProcessingOptions { get; set; }
- public ImagingProfile()
public class ImagingProfileRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public ImagingProfileRef()
public class ImagingSet : ImagingSetRef
- public int DataSourceID { get; set; }
- public string EmailNotificationRecipients { get; set; }
- public ImagingProfileRef ImagingProfile { get; set; }
- public ImagingSetStatus Status { get; set; }
- public ImagingSet()
public class ImagingSetRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public ImagingSetRef()
public class ImagingSetStatus
- public string CompletionRate { get; set; }
- public string ImageCompletion { get; set; }
- public string ImageQCReviewStatus { get; set; }
- public string LastRunError { get; set; }
- public bool? QCEnabledOnLastRun { get; set; }
- public DateTime? StartTime { get; set; }
- public string Status { get; set; }
- public ImagingSetStatus()
public class NativeImagingEngineOptions
- public const int MAX_DITHERING_THRESHOLD = 255
- public const int MAX_OUTPUT_DPI = 2400
- public DitheringAlgorithm? DitheringAlgorithm { get; set; }
- public int? DitheringThreshold { get; set; }
- public int ImageOutputDpi { get; set; }
- public FieldRef LastModifiedDateOnDocument { get; set; }
- public int? MaxPagesPerDoc { get; set; }
- public ImageFormat NativeImageFormat { get; set; }
- public bool? RenderColorPagesToJpeg { get; set; }
- public FieldRef TimeZoneFieldOnDocument { get; set; }
- public NativeImagingEngineOptions()
public class NativeType : NativeTypeRef
- public BasicCategory BasicCategory { get; set; }
- public int FileTypeID { get; set; }
- public NativeCategory? NativeCategory { get; set; }
- public bool PreventNativeDownload { get; set; }
- public bool RestrictedFromImagingByDefault { get; set; }
- public bool UseNativeImaging { get; set; }
- public NativeType()
public class NativeTypeRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public NativeTypeRef()
public class PresentationOptions
- public bool ShowSpeakerNotes { get; set; }
- public SlideOrientation SlideOrientation { get; set; }
- public PresentationOptions()
public class SpreadsheetOptions
- public const int MAX_ZOOM_PERCENTAGE = 400
- public const int MIN_ZOOM_PERCENTAGE = 10
- public int? FitToPagesTall { get; set; }
- public int? FitToPagesWide { get; set; }
- public HashSet<Formatting> Formatting { get; set; }
- public int HideAndPageBreakAfterConsecutiveBlankRowCol { get; set; }
- public bool IncludeBorders { get; set; }
- public bool IncludeComments { get; set; }
- public IncludeGridlines IncludeGridlines { get; set; }
- public IncludeHeadersAndFooters IncludeHeadersAndFooters { get; set; }
- public IncludeRowAndColumnHeadings IncludeRowAndColumnHeadings { get; set; }
- public int? LimitToPages { get; set; }
- public PageOrder PageOrder { get; set; }
- public PaperSizeOrientation PaperSizeOrientation { get; set; }
- public PrintArea PrintArea { get; set; }
- public bool ShowTrackChanges { get; set; }
- public HashSet<TextVisibility> TextVisibility { get; set; }
- public bool UnhideHiddenWorksheets { get; set; }
- public int? ZoomLevelPercentage { get; set; }
- public SpreadsheetOptions()
public class WordProcessingOptions
- public HashSet<Include> Include { get; set; }
- public PageOrientation PageOrientation { get; set; }
- public bool ShowTrackChanges { get; set; }
- public WordProcessingOptions()