Difference between revisions of "Fusion-CSV"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Overview)
(Example)
Line 39: Line 39:
 
GHA,      Ghana,          GCI,      Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2013,        114
 
GHA,      Ghana,          GCI,      Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2013,        114
 
GHA,      Ghana,          GCI,      Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2014,        111
 
GHA,      Ghana,          GCI,      Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2014,        111
 +
</pre>
 +
 +
<i>https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest/data/WB,GCI,1.0/GHA.GCI..?format=csv&detail=serieskeysonly</i>
 +
An example dataset with the returned detail set to series keys only - fewer columns are written to the response.
 +
<pre>
 +
REF_AREA, INDICATOR, SUB_INDICATOR, FREQ
 +
GHA,      GCI,      RANK,          A
 +
GHA,      GCI,      VALUE,        A   
 
</pre>
 
</pre>

Revision as of 08:40, 23 March 2020


Overview

The Fusion-CSV Data format predated SDMX-CSV and is not an official SDMX format. It is very similar in that the format is comma separated format where each row describes a single Observation value. The differences are:

  1. Whilst there can be a header row it is not mandatory
  2. There is no column for the Dataflow, in SDMX-CSV the first column must be for the Dataflow
  3. The order of the columns is important, unlike SDMX-CSV where labels are in the same column as the Id concatenated with a colon
  4. Fusion-CSV outputs lables in their own columns as oppose to SDMX-CSV which outputs a id:label pair in a single column concatenated with a semicolon (e.g. A:Annual)
  5. Fusion-CSV does not output columns for data queries if they are not part of the response based on the detail parameter, for example detail=seriesKeysOnly for a data query will only write columns for the Dimensions of the Data Structure in the output CSV, as oppose to SDMX-CSV which outputs a column for all the DSD components, regardless of whether they are used.

Fusion-CSV can be used as both an import and export format for the Fusion Registry, and an export format for the Fusion Edge Server and Fusion Data Browser.

Example

An example query using the format request parameters, HTTP Accept Headers can also be used to define the same format.
https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest/data/WB,GCI,1.0/GHA.GCI..?format=csv&labels=both


An example dataset with IDs only, spaces have been added to this example to assist readability.

REF_AREA, INDICATOR, SUB_INDICATOR, FREQ, TIME_PERIOD, OBS_VALUE
GHA,      GCI,       RANK,          A,    2008,        102
GHA,      GCI,       RANK,          A,    2009,        114
GHA,      GCI,       RANK,          A,    2010,        114
GHA,      GCI,       RANK,          A,    2011,        114
GHA,      GCI,       RANK,          A,    2012,        103
GHA,      GCI,       RANK,          A,    2013,        114
GHA,      GCI,       RANK,          A,    2014,        111

The same dataset in Fusion-CSV with lables included. Note, labels columns are only included if the Dimension, Attribute, or Measure is Coded, if it is not, then only one column is output - this can be seen in the table below where both TIME_PERIOD and OBS_VALUE are only single columns.

REF_AREA, Reference Area, INDICATOR, Indicator,                    SUB_INDICATOR, Sub Indicator, FREQ, Frequency, TIME_PERIOD, OBS_VALUE
GHA,      Ghana,          GCI,       Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2008,        102
GHA,      Ghana,          GCI,       Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2009,        114
GHA,      Ghana,          GCI,       Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2010,        114
GHA,      Ghana,          GCI,       Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2011,        114
GHA,      Ghana,          GCI,       Global Competitiveness Index, RANK:          Rank,          A,    Annual,    2012,        103
GHA,      Ghana,          GCI,       Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2013,        114
GHA,      Ghana,          GCI,       Global Competitiveness Index, RANK,          Rank,          A,    Annual,    2014,        111

https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest/data/WB,GCI,1.0/GHA.GCI..?format=csv&detail=serieskeysonly An example dataset with the returned detail set to series keys only - fewer columns are written to the response.

REF_AREA, INDICATOR, SUB_INDICATOR, FREQ
GHA,      GCI,       RANK,          A
GHA,      GCI,       VALUE,         A