kCura.Relativity.ImportAPI.ImportAPI

ImportAPI

public class ImportAPI : IImportAPI

Provides methods for developing custom import utilities for documents, images, production sets, and Dynamic Objects.

protected CookieContainer _cookieMonster

Holds cookies for the current session.

protected NetworkCredential _credentials

The current WebAPI credentials.

protected readonly IRunningContext _runningContext

public ExecutionSourceEnum ExecutionSource { get; set; }

For internal use only. Specifies where the document is being imported from.

public ImportAPI(string userName, string password)

Initializes a new instance of the ImportAPI class. Uses the Password Authentication provider when userName and password are specified; otherwise, Integrated Authentication provider.

public ImportAPI(string userName, string password, ILog logger)

Initializes a new instance of the ImportAPI class. Uses the Password Authentication provider when userName and password are specified; otherwise, Integrated Authentication provider.

public ImportAPI(string userName, string password, string webServiceUrl)

Initializes a new instance of the ImportAPI class. Uses the Password Authentication provider when userName and password are specified; otherwise, Integrated Authentication provider.

public ImportAPI(string userName, string password, string webServiceUrl, ILog logger)

Initializes a new instance of the ImportAPI class. Uses the Password Authentication provider when userName and password are specified; otherwise, Integrated Authentication provider.

public static ImportAPI CreateByBearerToken(string webServiceUrl, string bearerToken, ILog logger = null)

Creates a new instance of the ImportAPI class. Uses the supplied bearer token to authenticate both WebAPI and REST API endpoints.

public static ImportAPI CreateByRsaBearerToken(string webServiceUrl, ILog logger = null)

Creates a new instance of the ImportAPI class. Uses the bearer token for the current ClaimsPrincipal and should only be used by processes hosted by the Relativity Service Account (IE Agent).

protected static ImportAPI CreateByTokenProvider(string webServiceUrl, IRelativityTokenProvider relativityTokenProvider, ILog logger = null)

protected string GetCorrelationId()

public UploadTypeEnum GetFileUploadMode(int caseArtifactID)

Returns the UploadMode that will be used to upload files to the workspace specified by caseArtifactID.

public IEnumerable<ProductionSet> GetProductionSets(int workspaceArtifactID)

Returns all production sets eligible for import.

public IEnumerable<ArtifactType> GetUploadableArtifactTypes(int caseArtifactID)

Returns all uploadable artifact types associated with a given case.

public IEnumerable<Field> GetWorkspaceFields(int workspaceArtifactID, int artifactTypeID)

Returns all fields that apply to a given artifact type.

public ImageImportBulkArtifactJob NewImageImportJob()

Creates an ImageImportBulkArtifactJob with which to import a set of images.

public ImportBulkArtifactJob NewNativeDocumentImportJob()

Creates an ImportBulkArtifactJob to be used to import a set of native documents.

public ImportBulkArtifactJob NewObjectImportJob(int artifactTypeId)

Creates an ImportBulkArtifactJob with which to import a set of artifacts of the given type.

public ImageImportBulkArtifactJob NewProductionImportJob(int productionArtifactID)

Creates an ImageImportBulkArtifactJob with which to import a set of images into the given production set.

public IEnumerable<Workspace> Workspaces()

Returns a collection of all workspaces that are available for the logged in user.