We’re updating how related paths are handled by the ../api/entities
and ../api/search
APIs. These changes will make the responses returned by these APIs more concise and easier to interpret.
These improvements will be applied automatically on the dates listed below. Most customers won’t need to take any action. However, if your integrations with entities or search APIs depend on related paths outside the Content Hub platform, there may be a breaking change.
We recommend that you review these changes to ensure they don’t affect your processes.
What should I do?
For the
../api/entities
API:If you use the
members
parameter, your requests must now explicitly list the related paths you need. Related path relations will no longer be included by default.No changes are needed if you don't use the
members
parameter.
For the
../api/search
API:Use the
fields
orrelationsToLoad
parameters to define the related paths you want in the response. For example:"fields": [ "Title", "Filename", "AssetTypeToAsset" ],
When do I need to do this?
These improvements will be applied on the following dates:
For non-production environments, January 13, 2025.
For production environments, February 10, 2025.
Please ensure you’ve made the necessary changes before these dates. For more details, refer to Content Hub Related paths optimization.