ImportAPI Class

Relativity Import APIs
Provides methods for developing custom import utilities for documents, images, production sets, and Dynamic Objects.
Inheritance Hierarchy

Object
  kCura.Relativity.ImportAPI.ImportAPI

Namespace:  kCura.Relativity.ImportAPI
Assembly:  Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0
Syntax

public class ImportAPI : IImportAPI

The ImportAPI type exposes the following members.

Constructors

  NameDescription
Public methodImportAPI(String)
Initializes a new instance of the ImportAPI class using the Integrated Authentication provider.
Public methodImportAPI(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.
Public methodImportAPI(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.
Top
Properties

  NameDescription
Public propertyExecutionSource
For internal use only. Specifies where the document is being imported from.
Top
Methods

  NameDescription
Public methodStatic memberCreateByBearerToken
Creates a new instance of the ImportAPI class. Uses the supplied bearer token to authenticate both WebAPI and REST API endpoints.
Public methodStatic memberCreateByRsaBearerToken
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).
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetFileUploadMode
Returns the UploadMode that will be used to upload files to the workspace specified by caseArtifactID.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetProductionSets
Returns all production sets eligible for import.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUploadableArtifactTypes
Returns all uploadable artifact types associated with a given case.
Public methodGetWorkspaceFields
Returns all fields that apply to a given artifact type.
Public methodNewImageImportJob
Creates an ImageImportBulkArtifactJob with which to import a set of images.
Public methodNewNativeDocumentImportJob
Creates an ImportBulkArtifactJob to be used to import a set of native documents.
Public methodNewObjectImportJob
Creates an ImportBulkArtifactJob with which to import a set of artifacts of the given type.
Public methodNewProductionImportJob
Creates an ImageImportBulkArtifactJob with which to import a set of images into the given production set.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWorkspaces
Returns a collection of all workspaces that are available for the logged in user.
Top
Remarks

Also provides methods for retrieving workspaces, fields, and other objects.
See Also

Reference