Output Task Response Changes Coming After 2024-05-13

On or after 2024-05-13, the response XML for multiple APIs is changing. 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:

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 before the effective date.

Nature of the Change

Sometime after 2024-05-13, the primary change is the modification of the url attribute within the XML response. This attribute will now directly point 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.

Below you will see the change highlighed 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/162811787_58e08891_pdfgen%5CDocSmoke.pdf?sv=2023-08-03&amp;se=2024-02-12T22:28:14Z&amp;sr=b&amp;sp=r&amp;rscd=attachment%3B+filename+%3D+DocSmoke.pdf+&amp;sig=z1fFJqTjZQBLSXJO6TEvXe2awdqUiM%2F6Bv73xOPvEKY%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.