Provides methods for developing custom import utilities for documents, images, production sets, and Dynamic Objects.
Inheritance Hierarchy
kCura.Relativity.ImportAPI.ImportAPI
Namespace: kCura.Relativity.ImportAPI
Assembly: Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0
Syntax
The ImportAPI type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | ImportAPI(String) |
Initializes a new instance of the ImportAPI class using the Integrated Authentication provider.
|
| ImportAPI(String, String) |
Initializes a new instance of the ImportAPI class.
Uses the Password Authentication provider when userName and password are specified; otherwise, Integrated Authentication provider.
|
| ImportAPI(String, String, String) |
Initializes a new instance of the ImportAPI class.
Uses the Password Authentication provider when userName and password are specified; otherwise, Integrated Authentication provider.
|
Properties
| Name | Description | |
|---|---|---|
 | ExecutionSource |
For internal use only. Specifies where the document is being imported from.
|
Methods
| Name | Description | |
|---|---|---|
 | CreateByBearerToken |
Creates a new instance of the ImportAPI class.
Uses the supplied bearer token to authenticate both WebAPI and REST API endpoints.
|
| CreateByRsaBearerToken |
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).
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetFileUploadMode |
Returns the UploadMode that will be used to upload files to
the workspace specified by caseArtifactID.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetProductionSets |
Returns all production sets eligible for import.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUploadableArtifactTypes |
Returns all uploadable artifact types associated with a given case.
|
| GetWorkspaceFields |
Returns all fields that apply to a given artifact type.
|
| NewImageImportJob |
Creates an ImageImportBulkArtifactJob with which to import a set of images.
|
| NewNativeDocumentImportJob |
Creates an ImportBulkArtifactJob to be used to import a set of native documents.
|
| NewObjectImportJob |
Creates an ImportBulkArtifactJob with which to import a set of artifacts of the given type.
|
| NewProductionImportJob |
Creates an ImageImportBulkArtifactJob with which to import a set of images into the given production set.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Workspaces |
Returns a collection of all workspaces that are available for the logged in user.
|
Remarks
See Also