Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
Extend the REST API to support query of Categorisation by TargetCategory #14
Currently SOAP supports Categorisation query parameters on the Categorisation TargetCategory via the CategorisationWhere type but REST does not. This feature would allow a REST API consumer to benefit from the power of the Categorisation in SDMX. Many times the CategoryScheme is used as a base discovery structure and from a chosen member category the navigation will branch to a search. In REST this is not possible. This is a major limitation, as it impacts the clients willing to browse data, using a category scheme.
A path parameter could be added to the metadata queries of the RESTful API. This parameter would accept the id of the item, in an item scheme, to be returned.
For example, currently, the following syntax can be used to retrieve a category scheme:
In order to retrieve only a particular category (e.g.: ID = XYZ), the following syntax could be used:
Nested ids should be supported:
When the references parameter is not used, the returned item scheme should only contain the matching item (including the parents in case a nested id is used). The isPartial attribute should be used and its value should be true.
When the references parameter is used, artefacts using/used by the matching item should be returned.
For example, the following would retrieve, along with the matching categoryscheme/category, all the categorisations categorising the matching category:
As another example, the following would allow to retrieve all the DSDs referencing the supplied concept: