Author: Peter_Jodeleit
Publication Date: 1/13/2025 11:06
Starting on the 5th of February on DEV and QA environments we will roll out a change in our CaaS backend service.
Responses for collection requests currently include collection meta data if no format parameter is specified or the format=HAL is requested. This part of the response payload is usually not needed.
With the new version rolled out on 5th of February on CaaS DEV and QA environments requests containing a filter parameter the response will no longer include this meta data.
This change will be rolled out to the PROD environments five weeks later, on the 12th of March.
Additional hints:
- for requesting explicitly collection meta data request the document /_meta
- for an even more streamlined response format the request parameters rep=s could be utilized
- the new format is the same as if the parameter np (for “no properties”) has been included
Comments
1 comment
To provide an answer to a request which I have been asked via e-mail to all community readers:
The change will not affect requests which specify format=SHAL. This is because with the combination of "np" and "format=SHAL" the structure of the response JSON is changing significantly. This would lead to severe incompatibilities on the usage side.
We strongly encourage all clients to use "format=s" (or "format=standard") - independently of the change announced here.
Please sign in to leave a comment.