Headless API: Read-Only and Write-Only fields
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
- Schemas used by Headless API have fields with properties
readOnly:
true or writeOnly: true. What does it mean?
- Which field must be used when making a POST/PUT/PATCH request?
Environment
- Any Liferay environment using Headless API
Resolution
-
readOnly properties are included in responses but not in requests.
-
writeOnly properties may be sent in requests but not in responses.
- Thus, for POST/PUT/PATCH request, avoid
readOnly fields. Instead, you must use writeOnly fields (or those without readOnly/writeOnly properties since both properties are false by default).
Did this article resolve your issue ?