api-guidelines
api-guidelines copied to clipboard
Handling canonical dictionaries in resources
If an object contains inherent dictionaries (that usually contain custom keys) in its properties, like:
{ id: '1234' customInfo: { customProperty1: value1, customProperty2: value2} }
How is it expected to perform filtering and sorting on collections of such objects?
For example: <pathToServiceUrl>/collectionName?orderBy=customInfo.customProperty1
Or <pathToServiceUrl>/collectionName?filter=customInfo.customProperty1 eq value1
Is this acceptable?
Thank you!