MIGRATION_GUIDE.md

Migration Guide

The following guide compares the lf-repository-api-client package with the lf-repository-api-client-v2 package at time of initial release.

The lf-repository-api-client accesses the v1 Laserfiche Repository APIs and the lf-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

lf-repository-api-client	lf-repository-api-client-v2
getTrusteeAttributeKeyValuePairs	listAttributes
getTrusteeAttributeKeyValuePairsForEach	listAttributesForEach
getTrusteeAttributeKeyValuePairsNextLink	listAttributesNextLink
getTrusteeAttributeValueByKey	getAttribute

AuditReasons

lf-repository-api-client	lf-repository-api-client-v2
getAuditReasons	listAuditReasons
--	listAuditReasonsForEach
--	listAuditReasonsNextLink

Entries

lf-repository-api-client	lf-repository-api-client-v2
assignEntryLinks	setLinks
assignFieldValues	setFields
assignTags	setTags
copyEntryAsync	startCopyEntry
createOrCopyEntry	Functionality split into createEntry and copyEntry
deleteAssignedTemplate	removeTemplate
deleteDocument	deleteElectronicDocument
deleteEntryInfo	startDeleteEntry
deletePages	deletePages
exportDocument	exportEntry
exportDocumentAsStream	exportEntry
exportDocumentWithAuditReason	exportEntry
exportDocumentWithAuditReasonAsStream	exportEntry
getDocumentContentType	Removed
getDynamicFieldValues	listDynamicFieldValues
getEntry	getEntry
getEntryByPath	getEntryByPath
getEntryListing	listEntries
getEntryListingForEach	listEntriesForEach
getEntryListingNextLink	listEntriesNextLink
getFieldValues	listFields
getFieldValuesForEach	listFieldsForEach
getFieldValuesNextLink	listFieldsNextLink
getLinkValuesFromEntry	listLinks
getLinkValuesFromEntryForEach	listLinksForEach
getLinkValuesFromEntryNextLink	listLinksNextLink
getTagsAssignedToEntry	listTags
getTagsAssignedToEntryForEach	listTagsForEach
getTagsAssignedToEntryNextLink	listTagsNextLink
importDocument	importEntry
moveOrRenameEntry	updateEntry
writeTemplateValueToEntry	setTemplate
--	createMultipartUploadUrls
--	startImportUploadedParts
--	startExportEntry

FieldDefinitions

lf-repository-api-client	lf-repository-api-client-v2
getFieldDefinitionById	getFieldDefinition
getFieldDefinitions	listFieldDefinitions
getFieldDefinitionsForEach	listFieldDefinitionsForEach
getFieldDefinitionsNextLink	listFieldDefinitionsNextLink

LinkDefinitions

lf-repository-api-client	lf-repository-api-client-v2
getLinkDefinitionById	getLinkDefinition
getLinkDefinitions	listLinkDefinitions
getLinkDefinitionsForEach	listLinkDefinitionsForEach
getLinkDefinitionsNextLink	listLinkDefinitionsNextLink

Repositories

lf-repository-api-client	lf-repository-api-client-v2
getRepositoryList	listRepositories
getSelfHostedRepositoryList	listRepositoriesForSelfHosted

Searches

lf-repository-api-client	lf-repository-api-client-v2
cancelOrCloseSearch	cancelTasks
createSearchOperation	startSearchEntry
getSearchContextHits	listSearchContextHits
getSearchContextHitsForEach	listSearchContextHitsForEach
getSearchContextHitsNextLink	listSearchContextHitsNextLink
getSearchResults	listSearchResults
getSearchResultsForEach	listSearchResultsForEach
getSearchResultsNextLink	listSearchResultsNextLink
getSearchStatus	listTasks

ServerSession

The ServerSessionClient has been removed in lf-repository-api-client-v2.

SimpleSearches

lf-repository-api-client	lf-repository-api-client-v2
createSimpleSearchOperation	searchEntry

TagDefinitions

lf-repository-api-client	lf-repository-api-client-v2
getTagDefinitionById	getTagDefinition
getTagDefinitions	listTagDefinitions
getTagDefinitionsForEach	listTagDefinitionsForEach
getTagDefinitionsNextLink	listTagDefinitionsNextLink

Tasks

lf-repository-api-client	lf-repository-api-client-v2
cancelOperation	cancelTasks
getOperationStatusAndProgress	listTasks

TemplateDefinitions

lf-repository-api-client	lf-repository-api-client-v2
getTemplateDefinitionById	getTemplateDefinition
getTemplateDefinitions	listTemplateDefinitions
getTemplateDefinitionsForEach	listTemplateDefinitionsForEach
getTemplateDefinitionsNextLink	listTemplateDefinitionsNextLink
getTemplateFieldDefinitions	listTemplateFieldDefinitionsByTemplateId
getTemplateFieldDefinitionsForEach	listTemplateFieldDefinitionsByTemplateIdForEach
getTemplateFieldDefinitionsNextLink	listTemplateFieldDefinitionsByTemplateIdNextLink
getTemplateFieldDefinitionsByTemplateName	listTemplateFieldDefinitionsByTemplateName
getTemplateFieldDefinitionsByTemplateNameForEach	listTemplateFieldDefinitionsByTemplateNameForEach
getTemplateFieldDefinitionsByTemplateNameNextLink	listTemplateFieldDefinitionsByTemplateNameNextLink