IProductionManager Interface

Relativity.Productions.API
The interface enables interaction with Relativity Productions.

Namespace:  Relativity.Productions.Services
Assembly:  Relativity.Productions.Services.Interfaces (in Relativity.Productions.Services.Interfaces.dll) Version: 11.1.0.1 9c084404c128f715df772c7792aa49f21535523c
Syntax

public interface IProductionManager : IDisposable

The IProductionManager type exposes the following members.

Methods

  NameDescription
Public methodCode exampleCancelJobAsync
Sets the cancel job for a production job given its job ref.
Public methodCode exampleCreateSingleAsync
Creates a production in the workspace.
Public methodCode exampleDeleteSingleAsync
Deletes a production in the workspace.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodCode exampleGetAllAsync
Retrieves all productions a user has access to in a workspace
Public methodGetJobStatus
Retrieves the status of the production job.
Public methodCode exampleGetProducedProductionsFromDocumentsAsync(Int32, IEnumerableInt32)
Retrieves a list of ProductionSlim of all produced productions that contain at least one document in documentIDs. /// The key-value set is: [{ "DateProduced": DateTime} , { "BeginBates": String } , { "EndBates": String }]
Public methodCode exampleGetProducedProductionsFromDocumentsAsync(Int32, String)
Retrieves a list of ProductionSlim of all produced productions based on the database token corresponding to a mass action. The key-value set is: [{ "DateProduced": DateTime} , { "BeginBates": String } , { "EndBates": String }]
Public methodCode exampleGetProducedProductionsFromDocumentsAsync(Int32, IEnumerableInt32, Boolean)
Retrieves a list of ProductionSlim of all produced productions that contain at least one document in documentIDs. /// The key-value set is: [{ "DateProduced": DateTime} , { "BeginBates": String } , { "EndBates": String }]
Public methodCode exampleGetProducedProductionsFromDocumentsAsync(Int32, String, Boolean)
Retrieves a list of ProductionSlim of all produced productions based on the database token corresponding to a mass action. The key-value set is: [{ "DateProduced": DateTime} , { "BeginBates": String } , { "EndBates": String }]
Public methodCode exampleGetProductionImagesAsync(String)
Retrieves a list of FileResults on the specified pageUri.
Public methodCode exampleGetProductionImagesAsync(Int32, Int32, ListInt32)
Retrieves a list of ImageFile for all documents specified that belong to the given workspace and production.
Public methodCode exampleGetProductionImagesAsync(Int32, Int32, Int32, Int32, Int32)
Retrieves a list of FileResults of every produced file currently associated with the workspace and production in no particular order.
Public methodGetProductionsEligibleForReproductionAsync
Retrieves a list of ProductionSlim of all produced productions based on the database token corresponding to a mass action that are eligible for Reproduction based on the given reproductionType. Only productions containing all documents selected in the mass action will be returned. The key-value set is: [{ "DateProduced": DateTime} , { "BeginBates": String } , { "EndBates": String }, { "DocumentsReproducible": Int32 }]
Public methodGetProductionStatusDetails
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.
Public methodCode exampleMassCancelAsync(ListProductionJobRef)
Makes a request to cancel multiple production jobs.
Public methodMassCancelAsync(Int32, Int32)
Makes a request to cancel all productions associated with the reproductionJobID in the given workspace.
Public methodMassRetryAsync
Makes a request to retry multiple production jobs currently in an Error state or to retry a delete job.
Public methodMassStageAndRunProductionsAsync(Int32, ListInt32)
Runs, stages and runs, or retries all new, staged, or errored Productions. If any of the productions fail, none of the productions will run, stage and run, or retry.
Public methodMassStageAndRunProductionsAsync(Int32, Int32)
Runs, stages and runs, or retries all new, staged, or errored Productions in the Reproduction Job. If any of the productions fail, none of the productions will run, stage and run, or retry.
Public methodCode exampleReadSingleAsync
Returns an instance of Production object.
Public methodCode exampleRerunProductionAsync
Queues up a job to retry a production in Error state.
Public methodCode exampleRunProductionAsync
Queues up the job that will kick off the run production step.
Public methodCode exampleStageProductionAsync(Int32, Int32)
Queues up the job that will kick off the stage production step.
Public methodCode exampleStageProductionAsync(Int32, Int32, Boolean)
Queues up the job that will kick off the stage production step.
Top
See Also

Reference