Data Query Web Service - Revision history

Vmurrell at 16:04, 13 November 2025

2025-11-13T16:04:31Z

Vmurrell at 14:16, 12 September 2023

2023-09-12T14:16:50Z

Mnelson: /* Extended HTTP Query Parameters */

2022-10-04T07:52:38Z

‎Extended HTTP Query Parameters

Mnelson: /* Extended HTTP Query Parameters */

2022-10-04T07:27:58Z

‎Extended HTTP Query Parameters

Mnelson: /* Extended HTTP Query Parameters */

2022-10-04T07:27:10Z

‎Extended HTTP Query Parameters

Mnelson: /* Extended HTTP Query Parameters */

2022-10-04T07:26:52Z

‎Extended HTTP Query Parameters

Glenn: /* Extended HTTP Query Parameters */

2022-06-14T11:09:40Z

‎Extended HTTP Query Parameters

Glenn: /* Extended HTTP Query Parameters */

2022-06-14T11:08:45Z

‎Extended HTTP Query Parameters

Plazarou: /* Extended HTTP Query Parameters */

2022-05-25T20:24:48Z

‎Extended HTTP Query Parameters

Mnelson: /* Joining Dataflows */

2022-05-25T15:07:03Z

‎Joining Dataflows

@@ Line 134: / Line 134: @@
 |-
 |style="background-color:#eaecf0"|<b>detail</b>|| Specifies the amount of information to be returned ||
-'''full''' (default) – return the complete dataset<br/>
+'''full''' (default) – return the complete dataset<br>
-'''dataonly''' – exclude attributes and groups <br/>
+'''dataonly''' – exclude attributes and groups <br>
-'''serieskeysonly''' – only include series, no observations<br/>
+'''serieskeysonly''' – only include series, no observations<br>
 '''nodata''' – returns the groups and series, including attributes and annotations, without observations
 |-
@@ Line 144: / Line 144: @@
 |-
 |style="background-color:#eaecf0"|<b>dimensionAtObservation</b>|| Groups the data by one of the Dimensions of the DSD ||
-'''AllDimensions''' - used to request the observations are not grouped by any dimension <br/>
+'''AllDimensions''' - used to request the observations are not grouped by any dimension <br>
-''''dimension id'''' - used to group the observations by the specified dimenison id must be a valid Dimension Id for the DSD being queried<br/>
+''''dimension id'''' - used to group the observations by the specified dimenison id must be a valid Dimension Id for the DSD being queried<br>
 Note: This parameter is not supported by all output formats
@@ Line 183: / Line 183: @@
 | colspan="3" style="background-color:#d2f0ff" |  Parameters to order content
 |-
-|style="background-color:#eaecf0"| <b>orderMeasure</b> <br/> <small>since v11.5.1</small> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc/desc
+|style="background-color:#eaecf0"| <b>orderMeasure</b> <br> <small>since v11.5.1</small> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc/desc
 |-
 | colspan="3" style="background-color:#d2f0ff" |  Parameters for saving content
@@ Line 197: / Line 197: @@
 |style="background-color:#eaecf0"| <b>locale</b> || Alternative to using the HTTP Accept-Language header. Locale is used to define which language to export labels in.
 If the metadata does not include a label in the requested language, and alternative language is selected by the server.
-<p/>
+<p>
 For CSV formats the locale is also used to format numerical observation values
 || string
@@ Line 214: / Line 214: @@
 ||
 '''Syntax''': [Measure ID];[calculation 1];[calculation 2];[...]
-<br/>
+<br>
 '''Example''': calculatemeasure=NEW_MEASURE;mvavg;pch
 |-
-| style="background-color:#eaecf0" | <b>aggregate</b> || Removes one or more Dimensions from the output, collapsing multiple series and aggregating the values.  The default behaviour of removing the specified Dimensions can be reversed (to keep only the specified Dimensions) by using the '''keep''' argument. The default aggregation function is '''sum''' if no argument is provided || '''Syntax''':  [DIM_ID ARRAY;AGGREAGATION FUNCTION;KEEP DIMENSIONS] <br/>
+| style="background-color:#eaecf0" | <b>aggregate</b> || Removes one or more Dimensions from the output, collapsing multiple series and aggregating the values.  The default behaviour of removing the specified Dimensions can be reversed (to keep only the specified Dimensions) by using the '''keep''' argument. The default aggregation function is '''sum''' if no argument is provided || '''Syntax''':  [DIM_ID ARRAY;AGGREAGATION FUNCTION;KEEP DIMENSIONS] <br>
-'''Example''': FREQ,REF_AREA;SUM;keep<br/>
+'''Example''': FREQ,REF_AREA;SUM;keep<br>
-'''Aggregation Functions:''' sum, mean, median, min, max, stddev, stddevsample, var, varsample, count<br/>
+'''Aggregation Functions:''' sum, mean, median, min, max, stddev, stddevsample, var, varsample, count<br>
 |-
-| style="background-color:#eaecf0" | <b>completecube</b> || Fills in missing values for each series based on the start and end period of the data query for example if the data query states startPeriod=2008 but the data for one series starts at 2010, this manager will create a writer which completes the cube by either filling in with blank values, or one which is passed in on the parameter || the value to complete the cube with:<br/>'completecube=0' fills missing values with zeros<br/>'completecube=' fills missing values with blanks<br/>'completecube=nan' fills missing values with the string 'nan'
+| style="background-color:#eaecf0" | <b>completecube</b> || Fills in missing values for each series based on the start and end period of the data query for example if the data query states startPeriod=2008 but the data for one series starts at 2010, this manager will create a writer which completes the cube by either filling in with blank values, or one which is passed in on the parameter || the value to complete the cube with:<br>'completecube=0' fills missing values with zeros<br>'completecube=' fills missing values with blanks<br>'completecube=nan' fills missing values with the string 'nan'
 |-
 |style="background-color:#eaecf0"| <b>interpolate</b> || Derive values for periods with no data (uses linear interpolation) || linear
 |-
 |style="background-color:#eaecf0"| <b>normalisefreq</b> || Output all series in the given Frequency, even if the data is held in a different frequency, the aggregation function is used to convert frequencies.<br>Note that only conversion to lower frequencies is supported. For example, Monthly to Annual. ||
-'''Syntax''': [FREQUENCY;AGGREGATION FUNCTION]<br/>
+'''Syntax''': [FREQUENCY;AGGREGATION FUNCTION]<br>
-'''Example''': normalisefreq=A;SUM<br/>
+'''Example''': normalisefreq=A;SUM<br>
-'''Aggregation Functions:''' sum, mean, median, min, max, stddev, stddevsample, var, varsample, count, firstperiod, lastperiod, midperiod <br/>
+'''Aggregation Functions:''' sum, mean, median, min, max, stddev, stddevsample, var, varsample, count, firstperiod, lastperiod, midperiod <br>
@@ Line 234: / Line 234: @@
 |style="background-color:#eaecf0"| <b>round</b> || Round observations to x decimal places.  The default behaviour is to ensure all observations meet the given number of decimal places by either rounding the excess, or filling missing with zero values.  For example rounding 1.232 to 2 would return 1.23, however rounding to 4 would return 1.2320. The default rounding behaviour can be changed by using the '''maxdp''' argument, which will not pad the decimals with zero values if they are shorter then the given number of decimal places  ||
-'''Syntax''': round=[decimal places;ROUND_FUNCTION;maxdp]<br/>
+'''Syntax''': round=[decimal places;ROUND_FUNCTION;maxdp]<br>
 '''Example''': round=2;halfup;maxdp
-<br/>
+<br>
 '''Rounding Functions''': ceil, floor, halfeven, halfup, halfdown, up, down
 |}

@@ Line 4: / Line 4: @@
 The Data Query web service offers both a RESTful GET API which conforms the [https://github.com/sdmx-twg/sdmx-rest/blob/master/v2_1/ws/rest/docs/4_4_data_queries.md SDMX Specification], and a RESTful POST API which supports advanced features such as joining mulitple datasets and selecting lists of series.  Both the GET and POST web service support the SDMX standard parameters such as startPeriod and endPeriod, in addition to this, both APIs support advanced parameters to support features such as paging and calculations.
-Both REST and POST APIs offer the same [[Category:SdmxDataFormat|data formats]] as valid reponse formats, this can be controlled via the '''format''' data query parameter, or by using the HTTP Accept Header.
+Both REST and POST APIs offer the same data formats]as valid response formats, this can be controlled via the '''format''' data query parameter, or by using the HTTP Accept Header.
 This document describes the Syntax of both the GET and POST API.  Both APIs share the same Header Parameters and Query Parameters, as such these sections are applicable to both APIs.

@@ Line 183: / Line 183: @@
 | colspan="3" style="background-color:#d2f0ff" |  Parameters to order content
 |-
-|style="background-color:#eaecf0"| <b>orderMeasure</b> <br/> <small>since v11.15.1</small> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc/desc
+|style="background-color:#eaecf0"| <b>orderMeasure</b> <br/> <small>since v11.5.1</small> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc/desc
 |-
 | colspan="3" style="background-color:#d2f0ff" |  Parameters for saving content

@@ Line 183: / Line 183: @@
 | colspan="3" style="background-color:#d2f0ff" |  Parameters to order content
 |-
-|style="background-color:#eaecf0"| <b>orderMeasure</b> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc/desc
+|style="background-color:#eaecf0"| <b>orderMeasure</b> <br/> <small>since v11.15.1</small> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc/desc
 |-
 | colspan="3" style="background-color:#d2f0ff" |  Parameters for saving content

@@ Line 183: / Line 183: @@
 | colspan="3" style="background-color:#d2f0ff" |  Parameters to order content
 |-
-|style="background-color:#eaecf0"| <b>orderMeasure</b> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc|desc
+|style="background-color:#eaecf0"| <b>orderMeasure</b> ||order observation values in ascending or descending order, in the case of time series data this is time ascending/descending || asc/desc
 |-
 | colspan="3" style="background-color:#d2f0ff" |  Parameters for saving content

@@ Line 181: / Line 181: @@
 |style="background-color:#eaecf0"| <b>offset</b> || Use with max to support pagination, the offset defines which series match to start writing || number
 |-
 | colspan="3" style="background-color:#d2f0ff" |  Parameters for saving content
 |-

@@ Line 169: / Line 169: @@
 |style="background-color:#eaecf0"| <b>refId</b> || ID of the file || string
 |-
-|style="background-color:#eaecf0"| <b>recieverId</b> || ID of the reciever || string
+|style="background-color:#eaecf0"| <b>receiverId</b> || ID of the receiver || string
 |-
 | colspan="3" style="background-color:#d2f0ff" |  Parameters to restrict observations per series

← Older revision		Revision as of 15:07, 25 May 2022
Line 237:		Line 237:

	= Joining Dataflows =		= Joining Dataflows =
		+	'''Requires Fusion Registry v11.0.0 or higher.'''
		+
	A special use case, and extension of the SDMX API, is the ability to perform a join across 2 or more Dataflows. The result is a single dataset with each series containing the combination of Dimensions for all Dataflows in the Join. If any Dimensions did not exist in the original series, it will have the value of _Z (not applicable).		A special use case, and extension of the SDMX API, is the ability to perform a join across 2 or more Dataflows. The result is a single dataset with each series containing the combination of Dimensions for all Dataflows in the Join. If any Dimensions did not exist in the original series, it will have the value of _Z (not applicable).