.Stat RESTful Web Service Cheat Sheet
Table of Content
- Introduction
- Structural metadata queries
- Examples of structural metadata queries
- Data queries
- Examples of data queries
- Supported formats
- Referential metadata queries
Introduction
This cheat sheet is a quick reference description of the syntax and parameters for the .Stat RESTful API. It is adapted from the cheat sheet for the full SDMX RESTful API with examples added for the .Stat context and the unsupported elements removed.
You can also download this document as a .docx file.
Legend:
Structural metadata queries
Each .Stat space has a different web service entry point which should- replace http[s]://.Stat space WS/resource
in the above syntax.
More options are available in the full SDMX REST API standard but are not present or have not been fully tested in the .Stat web service, and do not appear here.
Examples of structural metadata queries
These examples use an entry point of https://nsi-demo-oecd-staging.siscc.org This may be swapped out for your target space.
Note that with the detail=referencepartial
query parameter, the server automatically applies the allowed content constraint on the codelists (and other ItemSchemes) and returns only partial (and thus shorter) codelists.
Using the query with the references=all
, references=constraint
, or references=actualconstraint
parameter (with or without the detail=referencepartial
parameter) returns a content constraint of type actual within the response if data was already uploaded. If such a content constraint is not returned by a .Stat Suite SDMX web service, then data was not yet uploaded or the underlying dataflow has not yetr been initialised.
Data queries
Each .Stat space has a different web service entry point which should replace https://ws-entry-point in the above syntax.
Note that in the .Stat Suite, the SDMX NSI web service is configured to apply Allowed ContentConstraints for both dimension values as well as attribute values to all data extractions:
config/Properties.json file:
{
"applyContentConstraintsOnDataQueries": "true"
}
Examples of data queries
These examples use an entry point of https://nsi-demo-oecd-staging.siscc.org. This may be swapped out for your target space.
Supported formats
“Parameter” in the tables below is used with the Accept HTTP header (see the Useful HTTP headers above)**
Referential metadata queries
Please see here.