Relativity.Productions.Services.V1.IProductionManager

IProductionManager

public interface IProductionManager : IDisposable

The interface enables interaction with Relativity Productions.

Documentation

Task<MassCancelResult> CancelReproductionJobAsync(int workspaceID, int reproductionJobID)

Makes a request to cancel all productions associated with the reproductionJobID in the given workspace.

Task<int> CreateSingleAsync(int workspaceID, Production production)

Create a production.

Task DeleteDocumentConflictsAsync(int workspaceID, int productionID)

Removes documents from the production that conflict with the workspace's Production Restrictions search.

Task DeleteSingleAsync(int workspaceID, int productionID)

Delete a production.

Task<ProductionDocumentConflicts> DocumentConflictsAsync(int workspaceID, int productionID)

Retrieves documents that conflict with the workspace's Production Restrictions search.

Task<List<Production>> GetAllAsync(int workspaceID, int dataSourceReadMode = 1)

Retrieves all productions a user has access to in a workspace

Task<List<BrandingError>> GetBrandingErrorsAsync(int workspaceID, int productionID)

Retrieves any branding errors for a given production.

Task<ProductionJobStatusResult> GetJobStatus(int workspaceID, int productionID, bool includePercentages = false, int numberOfBrandingErrors = 10)

Retrieves the status of the production job.

Task<List<ProductionSlim>> GetProducedProductionsFromDocumentsAsync(int workspaceID, IEnumerable<int> documentIDs, bool excludeNonReproducible = false)

Retrieves a list of all produced productions that contain at least one document in documentIDs.

Task<List<ProductionSlim>> GetProducedProductionsFromDocumentsAsync(int workspaceID, string token, bool excludeNonReproducible = false)

Retrieves a list of all produced productions that contain at least one document in documentIDs.

Task<ProductionDefaultFieldValues> GetProductionDefaultFieldValues(int workspaceID)

Retrieves default field values for a Production object

Task<PagedImageFilesResult> GetProductionImagesAsync(int workspaceID, int productionID, string token, int top = 100, int skip = 0)

Retrieves a list of FileResults of every produced file currently associated with the workspace and production in no particular order.

Task<ImageFilesResult> GetProductionImagesAsync(int workspaceID, int productionID, List<int> documentIDs)

Retrieves a list of ImageFile for all documents specified that belong to the given workspace and production in no particular order.

Task<string> GetProductionImagesTokenAsync(int workspaceID, int productionID)

Return an unique token associated with this call to page through the images.

Task<IKeplerStream> GetProductionPreviewAsync(int workspaceID, int productionID)

Retrieves a IKeplerStream containing the production preview image.

Task<int> GetProductionRestrictionAsync(int workspaceID)

Retrieve the artifact ID of the saved search currently using as production restriction in the workspace specified. If no value has been set, return 0

Task<IEnumerable<ReproductionCandidate>> GetProductionsEligibleForReproductionAsync(int workspaceID, string databaseToken, int reproductionType)

Retrieves the set of productions that are eligible for reproduction for selected productions in a given workspace.

Task<ProductionStatusDetailsResult> GetProductionStatusDetails(int workspaceID, int productionID)

Retrieves the status of the production at each step. This includes details on document count, image count, and several other metrics to indicate the progress.

Task<IEnumerable<ReproductionRef>> GetReproductionsAsync(int workspaceID, int productionID)

Retrieves the collection of re-productions that have been run to alter this production.

Task<List<ProductionJobResult>> MassStageAndRunAsync(int workspaceID, List<int> productionIDs)

Stages and runs the given productions and retrieves the results for staging and running the given productions.

Task<IEnumerable<ProductionJobResult>> MassStageAndRunProductionsAsync(int workspaceID, int reproductionJobID)

Stages and runs given re-production job and retrieves the results for staging and running the productions in the job.

Task<ProductionRunCheckResult> ProductionRunCheckAsync(int workspaceID, int productionID)

Retrieves document conflicts, errors indicating potential issues with running a production and information on whether current production is able to proceed to run.

Task<ProductionProgress> ProgressAsync(int workspaceID, int productionID)

Retrieves the progress details for a given production.

Task<Production> ReadSingleAsync(int workspaceID, int productionID, int dataSourceReadMode = 1)

Read a production.

Task RerunProductionAsync(int workspaceID, int productionID)

Queues up a job to retry a production in Error state.

Task<ProductionJobResult> RunProductionAsync(int workspaceID, int productionID, bool suppressWarnings = false, bool overrideConflicts = false)

Queues up the job that will kick off the run production step.

Task SetProductionRestrictionsAsync(int workspaceID, int productionRestrictionSearchID)

Add production restriction on the workspace if it's not set. If already set, replace the current production restriction with the new one

Task<ProductionJobResult> StageProductionAsync(int workspaceID, int productionID, bool automaticallyRun = false)

Queues up the job that will kick off the stage production step.

Task<StagingErrors> StagingErrorsAsync(int workspaceID, int productionID)

Retrieves any staging errors and duplicate documents for a given production.