Relativity.Import.V1.Services.IImportJobController

public interface IImportJobController : IDisposable

Controller for import job management.

Documentation

Task<Response> BeginAsync(int workspaceID, Guid importJobID)

Begins existing and configured import job. The import process of all added data sources will be started. It is possible to add additional data sources to stared job.

Task<Response> CancelAsync(int workspaceID, Guid importJobID)

Cancels existing import job. All data sources waiting in queue for import will be canceled. Already processing data sources for the job will be finished.

Task<Response> CreateAsync(int workspaceID, Guid importJobID, string applicationName, string correlationID)

Creates new import job with an assigned GUID identifier. Use separate endpoints to set configuration and add data sources to it.

Task<Response> EndAsync(int workspaceID, Guid importJobID)

Ends started import job. It stops import execution for all data sources (except already processing). It is not possible to add new data source for stopped import job.

Task<ValueResponse<ImportDetails>> GetDetailsAsync(int workspaceID, Guid importJobID)

Returns details about the import job including its status and imported records.

Task<ValueResponse<ImportJobs>> GetJobsAsync(int workspaceID, int start, int length)

Returns GUIDs identifiers (importJobID) of all import jobs for particular workspace. Response is paginated.

Task<ValueResponse<ImportProgress>> GetProgressAsync(int workspaceID, Guid importJobID)

Returns progress of imported records for specific ImportJobID.

Task<ValueResponse<DataSources>> GetSourcesAsync(int workspaceID, Guid importJobID)

Returns GUIDs identifiers (sourceID) of all data sources belonging to particular import job.

Task<Response> PauseAsync(int workspaceID, Guid importJobID)

Pauses import job.

Task<Response> ResumeAsync(int workspaceID, Guid importJobID)

Resumes paused import job.