Update On Output Task Response Changes Coming After 2024-11-31

As of now, the response XML for multiple APIs has changed on Sandbox, but effective after November 31, 2024 we will be rolling thing changes to production. If you are interested in being notified on a specific date, please create a ticket by email support@chili-publish.com

We recognize that the original date of May 13, 2024 has passed due to working through client issues reported on Sandbox. This change may cause your integration to error out during output or fail to properly download files after successful output.

The following API endpoints are affected:

Expand to see endpoints

GET /rest-api/{version}/system/tasks/{taskID}/status
PUT /rest-api/{version}/system/tasks/{taskID}/status
GET /rest-api/{version}/system/tasks/statuses
POST /rest-api/{version}/resources/documents/{itemID}/representations/package
POST /rest-api/{version}/resources/documents/tempxml/package
POST /rest-api/{version}/resources/documents/{itemID}/representations/imagesandpdf
POST /rest-api/{version}/resources/documents/tempxml/imagesandpdf
POST /rest-api/{version}/resources/documents/{itemID}/representations/idml
POST /rest-api/{version}/resources/documents/tempxml/idml
POST /rest-api/{version}/resources/documents/{itemID}/representations/html
POST /rest-api/{version}/resources/documents/tempxml/html
POST /rest-api/{version}/resources/documents/{itemID}/representations/odf
POST /rest-api/{version}/resources/documents/tempxml/odf
POST /rest-api/{version}/resources/documents/{itemID}/representations/pdf
POST /rest-api/{version}/resources/documents/tempxml/pdf
POST /rest-api/{version}/resources/documents/{itemID}/representations/images
POST /rest-api/{version}/resources/documents/tempxml/images
PUT /rest-api/{version}/resources/documents/documentprocessor

Required Actions

Integration Review: Please review your integration code to ensure compatibility with the updated XML changes. Special attention should be given to XML parsing implementations to handle the inclusion of additional ampersands in the URL attribute.
Testing on Sandbox: We strongly recommend conducting tests on your Sandbox environment, which already incorporates these changes, to identify and resolve any potential issues.

Nature of the Change

The primary change involves the modification of the URL attribute within the XML response. This attribute now directly points to the output file in our blob storage to increase performance and stability. However, the attribute will include additional ampersands (&), potentially impacting XML parsing in your current integration if it does not fully comply with XML spec 1.0 standards.

Important Note: The filename is now obfuscated for two reasons:

To support any characters in a file name.
To provide more security, making it impossible to guess file paths.

This means that if you relied on the download endpoint for the file name, you would need to retrieve the file name from the Content-Disposition header instead.

Below you will see the change highlighted in red:

<task finished="True" started="True" succeeded="True" hasDependantTasks="False" processingTime="3973" totalTime="4453" threadNum="0" creationTime="2024-02-26T20:51:46" taskType="GeneratePdfFromDatasource_Main" generatingImageOutput="false" waitForTaskID="" id="50b519e5-3efa-4d22-889d-37404ec38a01" itemXML="" hasEditorCliLog="False" userEnvironment="" environmentName="ft-nostress" itemID="708c426d-969c-49c5-98d5-0d7c0a09a3ab" itemName="" resourceName="Documents" result="<result openInBrowser="true" url="https://cpcpodevchilisttmp.blob.core.windows.net/cpo-downloads/b3b396e96a8ecc3ec210e9e530a3874d71ca321590edd0fa7034baaa19174fad?sv=2024-05-04&amp;se=2024-10-29T08%3A35%3A12Z&amp;sr=b&amp;sp=r&amp;sig=sCZuCrPkX1lBaWfc6Fqx5tSUNKzzZV7ym35oFbLNHT4%3D" relativeURL="Admin/download_tempFile.aspx?path=%5c162811787_58e08891_pdfgen%5cDocSmoke.pdf" reportUrl="" relativeReportUrl="" totalRecords="1" failedRecords="0" />" errorMessage="" isSubTask="false" isDistributed="false" version="2024.1.0.0.4332" priority="4" settingsName="" saveDocIfNeeded="True" pdfToCliRatio="0.20" rangeStart="-1" rangeEnd="-1" totalRecords="1" failedRecords="0" renderedPages="1" />

Potential Impact

Integrations that do not adhere to XML spec 1.0 may encounter errors or fail to correctly parse the XML, especially if custom XML parsing methods have been implemented. For example, if you were using DOMParser with text/html, the unescaping of the new XML changes would lead to a URL value with incorrectly escaped ampersands (&).

Support and Assistance

Should you have any questions or require assistance in updating your integration, please do not hesitate to contact our support team (https://mysupport.chili-publish.com). It is our top priority to ensure a smooth transition and minimize any potential disruptions to your services.

We appreciate your prompt attention to this matter and your continued partnership. Ensuring the success of your integration with our APIs remains our commitment.