API Version 1 - Changelog - Cloud

Security Updates

Updated vulnerable dependencies.

Entries

The following API is updated to always return entryType, even if the OData $select query options is used and it doesn't include entryType:

• GET /Repositories/{repoId}/Entries/{entryId}

Searches

The following API is updated to always return entryType, even if the OData $select query options is used and it doesn't include entryType:

• GET /Repositories/{repoId}/Searches/{searchToken}/Results

SimpleSearches

The following API is updated to always return entryType, even if the OData $select query options is used and it doesn't include entryType:

• POST /Repositories/{repoId}/SimpleSearches

Entries

[BREAKING] The following API returns the length of the document in the X-APIServer-ContentLength response header, instead of the HTTP Content-Length response header:

• HEAD /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc

Entries

OAuth scope for the following APIs has been revised to repository.Read:

• POST /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/GetEdocWithAuditReason
• POST /Repositories/{repoId}/Entries/{entryId}/fields/GetDynamicFieldLogicValue

New isSource property added to the request body of the following API. This allows assigning link metadata where the current entry is the source or target in the link relationship.

• PUT /Repositories/{repoId}/Entries/{entryId}/links

Bug Fixes

Fixed a bug where parts of the following API URLs were case sensitive:

• GET /Repositories/{repoId}/Entries/links
• PUT /Repositories/{repoId}/Entries/links
• GET /Repositories/{repoId}/Entries/tags
• PUT /Repositories/{repoId}/Entries/tags
• DELETE /Repositories/{repoId}/Entries/Laserfiche.Repository.Document/pages

Maintenance

Marked file parameter electronicDocument as required and added documentation on how to create a blank document to the following API:

• POST /Repositories/{repoId}/Entries/{parentEntryId}/{fileName}

Searches

OAuth scope for the following APIs has been revised to repository.Read:

• POST /Repositories/{repoId}/Searches
• DELETE /Repositories/{repoId}/Searches/{searchToken}

SimpleSearches

OAuth scope for the following APIs has been revised to repository.Read:

• POST /Repositories/{repoId}/SimpleSearches

Tasks

OAuth scope no longer applies to the following APIs:

• GET /Repositories/{repoId}/Tasks/{operationToken}
• DELETE /Repositories/{repoId}/Tasks/{operationToken}

Other

Maintenance

Improved service security and stability

Other

Features

Support Brotli and Gzip response compression to reduce response latency when the Accept-Encoding request header is used.

Entries

Bug Fixes

Fixed a bug where in some scenarios with the Time or Data field type, the following APIs had an error when returning field values:

• GET /Repositories/{repoId}/Entries/{entryId}/fields
• PUT /Repositories/{repoId}/Entries/{entryId}/fields

Fixed a bug where in some scenarios, the following API could return an error:

• HEAD /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc

Other

Bug Fixes

Fixed inconsistent error responses to now return ProblemDetails schema.

Entries

Bug Fixes

Fixed a bug where in some scenarios, the following API could return an incorrect nextlink:

• GET /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/children

Other

Features

OAuth 2.0 scope support has been added for security but is optional in v1 for backwards compatibility. If your access token does not contain any scopes, you will not run into any issues, but if your token explicitly contains scopes, the API Server will enforce scope security and issue a 403 Forbidden if it does not have the correct scopes.

Entries

Bug Fixes

Fixed a bug where in some scenarios, the following API could return an error instead of the entries in the folder:

• GET /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/children

Other

Maintenance

Added a maximum JSON request body size limit of 5 MB to all non-import document related APIs. As a result, the 413 Payload Too Large status code has been added to several APIs.

Added a maximum JSON response body size limit of 5 MB to all non-export document related APIs.

Entries

Features

The APIServer can now include an error message in a HTTP response header named X-APIServer-Error for the following API:

• HEAD /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc

Other

Maintenance

Updated the ProblemDetails error response schema to more accurately reflect the response. Undocumented extension properties are now documented.

Added support for localized error messages for the fr and es culture codes. The culture code can be sent in API requests through the culture query parameter or the Accept-Language header.

Entries

Bug Fixes

Removed an incorrect ProblemDetails error response schema from the following API:

• HEAD /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc

[BREAKING] Token substitution in the name of the copied entry is no longer supported in the following API to avoid errors while copying:

• POST /Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/CopyAsync

Entries

Maintenance

The Entry base type schema has been marked as abstract. If using the Laserfiche API client libraries, should use the derived types like Folder, Document, Shortcut, and RecordSeries.

ServerSession

Maintenance

The following APIs are marked as deprecated in v1:

• POST /Repositories/{repoId}/ServerSession/Create
• POST /Repositories/{repoId}/ServerSession/Refresh
• POST /Repositories/{repoId}/ServerSession/Invalidate

Entries

Features

Added the following API:

• GET /Repositories/{repoId}/Entries/ByPath

Searches

Bug Fixes

Fixed a bug that caused the search results return localized field values in a different format from other APIs.