23.1.0 API Changelog

Breaking changes

Updated attachment management

Without the right view_attachments, the following endpoints will no longer return items in the attachments/file property (except for files used to create merged PDF main file):

CODE

POST /documents
PUT /documents/{id}/merge
GET /documents/{id}
  
POST /search
POST /search/locate
  
GET /revisions/document/{id}/{revision}

Without the right add_file_attachments, the following endpoints will no longer allow to create/edit/remove the attachments (except for files used to create merged PDF main file):

CODE

POST /documents 
POST /documents/bulk/create
PUT /documents/{version}
PUT /documents/edit/{version}

Attachments

Removed the following endpoints:

NONE

DELETE /attachments/draft/{id}/{hash}/{version}
GET /attachments/{id}/count
GET /attachments/draft/{id}/count
GET /attachments/main/{id}
PUT /attachments/draft/{id}/{hash}

You can achieve the same functionality by viewing/editing the document/draft directly.

Changed the required right download_attachment to view_attachments in the following endpoints:

NONE

GET /attachments/{id}/zip
GET /attachments/{id}/{hash}
GET /attachments/draft/{id}/{hash}

Configuration

The endpoint PUT /configuration can no longer be used to change the following properties: authenticationFactors, filters, password and configuration.photo. Please use the dedicated endpoints to change these properties.

Files

The endpoints POST /files/initials and POST /files/signature now return an application/json response.
You can no longer download an attachment file without the right download_attachment using the endpoint GET /files/loadFile/hash/{hash} (except for files used to create merged PDF main file).