Submit Feedback
Legacy Knowledge Base
Published Sep. 10, 2025

Headless Delivery API fails after patching to dxp-7

Written By

Madeleine Clay

How To articles are not official guidelines or officially supported documentation. They are community-contributed content and may not always reflect the latest updates to Liferay DXP. We welcome your feedback to improve How To articles!

While we make every effort to ensure this Knowledge Base is accurate, it may not always reflect the most recent updates or official guidelines.We appreciate your understanding and encourage you to reach out with any feedback or concerns.

Legacy Article

You are viewing an article from our legacy "FastTrack" publication program, made available for informational purposes. Articles in this program were published without a requirement for independent editing or verification and are provided"as is" without guarantee.

Before using any information from this article, independently verify its suitability for your situation and project.

Issue

  • After patching to dxp-7, the headless delivery API cURL command 
    '/o/headless-delivery/v1.0/structured-contents/{journalArticleResourcePrimKey}/rendered-content/{templateKey}'
    is returning 500 status code responses and failing.

Environment

  • DXP 7.2

Resolution

  • Because of a change introduced to the headless delivery API in dxp-7, specifically in RenderedContentValueUtil.java, the following cURL command returns a renderedContentURL value which includes the templateKey instead of the templateId: 
    '/o/headless-delivery/v1.0/sites/{siteId}/structured-contents/by-key/{key}'
  • A fix for this issue is described in LPS-128308, which was released in liferay-fixpack-dxp-11-7210 
  • Alternately, to resolve the issue without implementing a fix pack change, the templateKey can be replaced with the templateId in the query as follows: 
    '/o/headless-delivery/v1.0/structured-contents/{journalArticleResourcePrimKey}/rendered-content/{templateId}'

Additional Information

  • See the dxp-7 Changelog for more detailed information on the changes introduced by Liferay DXP 7.2 Fix Pack 7
  • Read this article for more detailed information on Headless Rest APIs

 

Did this article resolve your issue ?
Legacy Knowledge Base
Did this article resolve your issue ?