Settings Class

Allows clients of Import API to identify themselves. This property is used for telemetry purpose.

Indicates the ArtifactTypeId of the destination object. This property is required.

Indicates the level of auditing for an import job.

Indicates if imported files are subjects to being billable.

Field delimiter to use when writing out the bulk load file.

Indicates the ArtifactID of the workspace used as the destination for an import job. This property is required.

Gets or sets whether to copy files to the document repository. If False, files will be linked instead.

Gets or sets the name of the column that identifies the record identifier in DataGrid for documents.

Indicates the Import Destination folder under which documents and objects, as well as folders containing documents or objects, are built.

Enables or disables the use of "Control Number" to override the SelectedIdentifierField.

Enables or disables encoding checks for each file.

Enables or disables validation of the extracted text file location.

Enables or disables the validation of the native file location for the current import job.

Enables or disables validation of the native file type for the current job.

Enables or disables user permission checks per document or object.

Sets the encoding of the extracted text files.

Indicates whether the Extracted Text field contains a path to the extracted text file or contains the actual extracted text.

Indicates the column that contains the name of the file on the SourceData property.

Indicates the column that contains the FileSize on the SourceData property.

To skip file size checking, set this property to True.

Indicates the name of a metadata field used to build the folder structure for the workspace.

Represents a key field that is set only on Overwrite mode.

Indicates whether the Extracted Text field data will be loaded directly from its file path, rather than as part of a bulk load file.

Specify a column other than ExtractedText that contains a path to a full text file

Determines the maximum number of errors displayed. This property is optional.

Indicates if existing documents in case of Append/Overlay mode should be moved to new folder based on metadata

Represents the delimiter used to separate multiple values, such as different single-choice field values.

Indicates whether native files are used as links or copied to the Relativity instance designated as the destination.

Indicates the name of the Field that contains the full path and filename for the native files.

Represents the delimiter used to separate nested values, such as choices or child choices on a multi-choice field.

Identifies a list of single or multiple object Fields that should be mapped by ArtifactID instead of by name.

Indicates the column that contains the OutsideInFileId on the SourceData property. Used in conjunction with the OIFileIdMapped and FileSizeMapped properties.

To skip file identification, set this property to True.

Indicates the column that contains the OutsideInFileType on the SourceData property. Used in conjunction with the OIFileIdMapped property.

Indicates the method for overlay imports with multiple choice and multiple object fields.

Indicates whether records should be appended or overlayed. The default mode is Append.

Indicates the name of the Field that contains a unique identifier for the record of the parent object associated with the current record.

Provides the password for logging in to the Relativity instance used as a destination.

Provides the username for logging in to the Relativity instance used as a destination.

This property is not used and will be unavailable in future releases.

Specifies the field to be used as an identifier while importing.

Gets or sets whether to send an email to notify you of load completion.

Gets or sets the record number from which to start the import.

Indicates the column that contains the SupportedByViewer on the SourceData property.

Get class containing telemetry settings

To allow a custom time logging method through out the API

Specifies the server where the Relativity WebAPI is installed. This property is optional.

Determines whether the specified object is equal to the current object.

Serves as the default hash function.

Gets the Type of the current instance.

Returns a string that represents the current object.