Skip to content

Latest commit

 

History

History
127 lines (113 loc) · 34.8 KB

MIGRATION_GUIDE.md

File metadata and controls

127 lines (113 loc) · 34.8 KB

Migration Guide

The following guide compares the .NET Laserfiche.Repository.Api.Client NuGet package with the Laserfiche.Repository.Api.Client.V2 NuGet package at time of initial release.

The Laserfiche.Repository.Api.Client accesses the v1 Laserfiche Repository APIs and the Laserfiche.Repository.Api.Client.V2 accesses the v2 Laserfiche Repository APIs. Many API function signatures have been updated in the v2 client. See the tables below for the functions in the v1 client that correspond to the functions in the v2 client.

See here for more details on the changes between the v1 and v2 Laserfiche Repository APIs.

Attributes

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
GetTrusteeAttributeKeyValuePairsAsync ListAttributesAsync
GetTrusteeAttributeKeyValuePairsForEachAsync ListAttributesForEachAsync
GetTrusteeAttributeKeyValuePairsNextLinkAsync ListAttributesNextLinkAsync
GetTrusteeAttributeValueByKeyAsync GetAttributeAsync

Audit Reason

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
GetAuditReasonsAsync ListAuditReasonsAsync

Entries

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
AssignEntryLinksAsync SetLinksAsync
AssignFieldValuesAsync SetFieldsAsync
AssignTagsAsync SetTagsAsync
CopyEntryAsync StartCopyEntryAsync
CreateOrCopyEntryAsync Functionality split into CreateEntryAsync and CopyEntryAsync
DeleteAssignedTemplateAsync RemoveTemplateAsync
DeleteDocumentAsync DeleteElectronicDocumentAsync
DeleteEntryInfoAsync StartDeleteEntryAsync
DeletePagesAsync DeletePagesAsync
ExportDocumentAsync ExportEntryAsync
ExportDocumentWithAuditReasonAsync ExportEntryAsync
GetDocumentContentTypeAsync Removed
GetDynamicFieldValuesAsync ListDynamicFieldValuesAsync
GetEntryAsync GetEntryAsync
GetEntryByPathAsync GetEntryByPathAsync
GetEntryListingAsync ListEntriesAsync
GetEntryListingForEachAsync ListEntriesForEachAsync
GetEntryListingNextLinkAsync ListEntriesNextLinkAsync
GetFieldValuesAsync ListFieldsAsync
GetFieldValuesForEachAsync ListFieldsForEachAsync
GetFieldValuesNextLinkAsync ListFieldsNextLinkAsync
GetLinkValuesFromEntryAsync ListLinksAsync
GetLinkValuesFromEntryForEachAsync ListLinksForEachAsync
GetLinkValuesFromEntryNextLinkAsync ListLinksNextLinkAsync
GetTagsAssignedToEntryAsync ListTagsAsync
GetTagsAssignedToEntryForEachAsync ListTagsForEachAsync
GetTagsAssignedToEntryNextLinkAsync ListTagsNextLinkAsync
ImportDocumentAsync ImportEntryAsync
MoveOrRenameEntryAsync UpdateEntryAsync
WriteTemplateValueToEntryAsync SetTemplateAsync
-- CreateMultipartUploadUrlsAsync
-- StartImportUploadedPartsAsync
-- StartExportEntryAsync

FieldDefinitions

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
GetFieldDefinitionByIdAsync GetFieldDefinitionAsync
GetFieldDefinitionsAsync ListFieldDefinitionsAsync
GetFieldDefinitionsForEachAsync ListFieldDefinitionsForEachAsync
GetFieldDefinitionsNextLinkAsync ListFieldDefinitionsNextLinkAsync

LinkDefinitions

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
GetLinkDefinitionByIdAsync GetLinkDefinitionAsync
GetLinkDefinitionsAsync ListLinkDefinitionsAsync
GetLinkDefinitionsForEachAsync ListLinkDefinitionsForEachAsync
GetLinkDefinitionsNextLinkAsync ListLinkDefinitionsNextLinkAsync

Repositories

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
GetRepositoryListAsync ListRepositoriesAsync
GetSelfHostedRepositoryListAsync ListSelfHostedRepositoriesAsync

Searches

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
CancelOrCloseSearchAsync CancelTasksAsync
CreateSearchOperationAsync StartSearchEntryAsync
GetSearchContextHitsAsync ListSearchContextHitsAsync
GetSearchContextHitsForEachAsync ListSearchContextHitsForEachAsync
GetSearchContextHitsNextLinkAsync ListSearchContextHitsNextLinkAsync
GetSearchResultsAsync ListSearchResultsAsync
GetSearchResultsForEachAsync ListSearchResultsForEachAsync
GetSearchResultsNextLinkAsync ListSearchResultsNextLinkAsync
GetSearchStatusAsync ListTasksAsync

ServerSession

The IServerSessionClient has been removed in Laserfiche.Repository.Api.Client.V2.

SimpleSearches

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
CreateSimpleSearchOperationAsync SearchEntryAsync

TagDefinitions

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
GetTagDefinitionByIdAsync GetTagDefinitionAsync
GetTagDefinitionsAsync ListTagDefinitionsAsync
GetTagDefinitionsForEachAsync ListTagDefinitionsForEachAsync
GetTagDefinitionsNextLinkAsync ListTagDefinitionsNextLinkAsync

Tasks

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
CancelOperationAsync CancelTasksAsync
GetOperationStatusAndProgressAsync ListTasksAsync

TemplateDefinitions

Laserfiche.Repository.Api.Client Laserfiche.Repository.Api.Client.V2
GetTemplateDefinitionByIdAsync GetTemplateDefinitionAsync
GetTemplateDefinitionsAsync ListTemplateDefinitionsAsync
GetTemplateDefinitionsForEachAsync ListTemplateDefinitionsForEachAsync
GetTemplateDefinitionsNextLinkAsync ListTemplateDefinitionsNextLinkAsync
GetTemplateFieldDefinitionsAsync ListTemplateFieldDefinitionsByTemplateIdAsync
GetTemplateFieldDefinitionsForEachAsync ListTemplateFieldDefinitionsByTemplateIdForEachAsync
GetTemplateFieldDefinitionsNextLinkAsync ListTemplateFieldDefinitionsByTemplateIdNextLinkAsync
GetTemplateFieldDefinitionsByTemplateNameAsync ListTemplateFieldDefinitionsByTemplateNameAsync
GetTemplateFieldDefinitionsByTemplateNameForEachAsync ListTemplateFieldDefinitionsByTemplateNameForEachAsync
GetTemplateFieldDefinitionsByTemplateNameNextLinkAsync ListTemplateFieldDefinitionsByTemplateNameNextLinkAsync