<PackageReference Include="Relativity.Processing.SDK" Version="13.29.354" />

Relativity.Processing.V1.Services.IFieldMappingManager

public interface IFieldMappingManager : IDisposable
Exposes methods used to store and retrieve data for field mapping, including fields available for mapping and fields already mapped.
Task<List<ExternalMapping>> GetAllMappedFieldsAsync(int workspaceID, int dataSourceID, List<Guid> fieldsToAppend)

Returns a list of mapped Relativity fields.

Task<List<Guid>> GetAutoMappedFieldGuidsAsync(int workspaceID)

Returns an array of Guids corresponding to the Relativity fields that are automatically mapped by Invariant.

Task<CatalogField[]> GetCatalogFieldsAsync(int workspaceID)

Returns the contents of the Catalog Field table

Task<IReadOnlyDictionary<Guid, string>> GetInvariantFieldCatalogMapping(int workspaceID)

Returns the Invariant FieldCatalog Mapping

Task<List<MappableSourceField>> GetInvariantFieldsAsync(int workspaceID, bool catalogFieldsOnly = false)

Retrieves an array of fields from Invariant that are available for field mapping.

Task<FieldMappingResponse> GetInvariantFieldsPaginatedAsync(int workspaceID, int skip, int top, FieldMappingRequest fieldMappingRequest)

Retrieves an array of fields from Invariant that are available for field mapping and then paginated for performance.

Task<MappableSourceField> GetMappableSourceFieldAsync(int workspaceID, string sourceName)

Returns field given source name.

Task<FieldMappingResponse> GetMetadataFieldsAsync(int workspaceID, int skip, int top, FieldMappingRequest fieldMappingRequest)

Retrieves an array of metadata fields from Invariant.

Task<MappableFieldsResponse> GetNewMappableFieldsNonPaginatedAsync(int workspaceID, int metadataFieldCount)

Returns the mappable fields.

Task<FieldMappingResponse> GetOtherFieldsAsync(int workspaceID, int skip, int top, FieldMappingRequest fieldMappingRequest)

Retrieves an array of non-metadata fields from Invariant.

Task<bool> IsFieldMappingAvailableAsync(int workspaceID)

Returns a boolean flag indicating whether or not Field Mapping functionality is available.

Task<ExternalMapping> ReadExternalMappingAsync(int workspaceID, int fieldID, string fieldSource)

Retrieves an External Field Mapping for the given field ID, if one exists.

Task UpdateExternalMappingAsync(int workspaceID, int fieldID, ExternalMapping model, bool validation = true)

Modifies or inserts a single field mapping record.

Task<bool> ValidateFieldLengthAsync(int workspaceID, int? fieldLength, int fieldDataTypeId, int sourceLength)

Returns a boolean flag indicating whether a field's length is compatible with the source field's length.

Task<bool> ValidateFieldObjectsAsync(int workspaceID, ExternalMapping model, MappableSourceField sourceField)

Returns a boolean flag indicating whether a field can be mapped to the given source field, based on data type and other properties.

Task<bool> ValidateFieldTypeMappingAsync(int workspaceID, int fieldDataTypeId, string sourceType)

Returns a boolean flag indicating whether a field can be mapped to the given source field, based on data type.