How to filter web content by structure field with headless APIs
written-by
Daniel Carrillo Broeder
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
learn-legacy-article-disclaimer-text
Issue
- Create a custom structure and use a headless API to filter web content based on specific fields within that structure
Environment
- Quarterly Releases
- DXP 7.4
- DXP 7.3
Resolution
- The following endpoint should be used getContentStructureStructuredContentsPage :
- The following format could be used
contentFields/<Field-Reference> for custom structure fields.
- The field reference could be obtained when editing the web content structure.
- For example, the following expression could be used to filter web content by a field "Example" having value 'value'
(contentFields/Example eq 'value')
- The filter format for structure fields
contentFields/<Field-Reference> is not available for other Headless APIs such as getStructuredContentFolderStructuredContentsPage, getSiteStructuredContentsPage, ...
- You could build your own custom search blueprints and use the Search API as an alternative.
- Only fields indexed as a keyword support filtering.
did-this-article-resolve-your-issue