Versions Compared

Old Version 7

changes.mady.by.user Sean Crowe

Saved on

compared with

New Version 8

changes.mady.by.user Sean Crowe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On or after 2024-05-13As of now, the response XML for multiple APIs is changinghas changed on Sandbox, but effective after November 31, 2024 we will be rolling thing changes to production. 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
titleExpand 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

  1. 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

...

  1. URL attribute.

  2. Testing on Sandbox: We strongly recommend conducting tests on your Sandbox environment, which already incorporates these changes, to identify and resolve any potential issues

...

  1. .

Nature of the Change

Sometime after 2024-05-13, the The primary change is involves the modification of the url URL attribute within the XML response. This attribute will now directly point 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 will need to retrieve the file name from the Content-Disposition header instead.

Below you will see the change highlighed 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="&lt;result openInBrowser=&quot;true&quot; url=&quot;https://cpcpodevchilisttmp.blob.core.windows.net/cpo-downloads/162811787_58e08891_pdfgen%5CDocSmoke.pdfb3b396e96a8ecc3ec210e9e530a3874d71ca321590edd0fa7034baaa19174fad?sv=20232024-0805-0304&amp;amp;se=2024-02-12T22:28:14Z10-29T08%3A35%3A12Z&amp;amp;sr=b&amp;amp;sp=r&amp;amp;rscd=attachment%3B+filename+%3D+DocSmoke.pdf+&amp;amp;sig=z1fFJqTjZQBLSXJO6TEvXe2awdqUiM%2F6Bv73xOPvEKY%3DsCZuCrPkX1lBaWfc6Fqx5tSUNKzzZV7ym35oFbLNHT4%3D&quot;relativeURL=&quot;Admin/download_tempFile.aspx?path=%5c162811787_58e08891_pdfgen%5cDocSmoke.pdf&quot; reportUrl=&quot;&quot; relativeReportUrl=&quot;&quot; totalRecords=&quot;1&quot; failedRecords=&quot;0&quot; /&gt;" 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 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.

...