A new Synchronization API version is planned to be launched by 14 September 2021.
The new version will come with several major improvements:
- a faster response, especially for larger synchronizations
- a retry policy that will allow failed synchronizations to be retried up to 3 times
- the new implementation will allow multiple requests to be made without waiting for the current synchronization to be completed before starting the next synchronization
Before launching this new version we want to ask you to check the following technical changes that will appear in the new synchronization API version:
- it will use a processing queue that will allow an immediate response after all static validations are done. To get the final result Synchronize Output end-point will have to be called and you will have to check that the synchronizationStatus field is either 'Completed' or 'Failed'.
- a new synchronization status will be added: 'Processing'. It refers to synchronizations that are currently running. You can get this information by using the API endpoint Synchronize Output
- in the edge case scenario when a synchronization request is made and another synchronization processing the same files is in progress, the current response will have a status 404 while the new message will have the status 200. In order to be able to get the result of the synchronization process, Synchronize Output method should be used. The result in this particular case will contain
- <synchronizationStatus>Failed</synchronizationStatus>
- <updateResult>Another instance is already running and blocking this synchronization path, terminating execution</updateResult>
- a new optional parameter will be added to the synchronization API syncUseProcessingQueue which is a backward-compatible flag. This flag will allow synchronization API calls to use the new implementation or the previous one. By default the new synchronization API will be used.
DG COMM
