Schema queries

Get XML schemas

get/schema/{context}/{agencyID}/{resourceID}/{version}

Request

Path parameters

context'datastructure' | 'metadatastructure' | 'dataflow' | 'metadataflow' | 'provisionagreement' required

The value of this parameter determines the constraints taken into account when generating the schema.

Possible options are:

  • datastructure: Constraints attached to the DSD are applied.
  • metadatastructure: Constraints attached to the MSD are applied.
  • dataflow: Constraints attached to the dataflow and to the DSD used in the dataflow are applied.
  • metadataflow: Constraints attached to the metadataflow and to the MSD used in the metadataflow are applied.
  • provisionagreement: Constraints attached to the provision agreement, as well as to the dataflow or metadafalow used in the agreement and the DSD or MSD used in the dataflow or metadataflow are applied.
agencyIDstring required

The agency maintaining the artefact used to generate the schema to be returned.

resourceIDstring required

The id of the artefact used to generate the schema to be returned.

versionstring required

The version of the artefact used to generate the schema to be returned.

The keyword latest can be used to return the latest production version of the matching resource.

Query parameters

dimensionAtObservationstring

Indicates how the data should be packaged.

The options are:

  • TIME_PERIOD: A timeseries view
  • The ID of any other dimension: A cross-sectional view of the data
  • AllDimensions: A flat view of the data.
explicitMeasureboolean

For cross-sectional data validation, indicates whether observations are strongly typed

Headers

Accept-Encoding'br' | 'compress' | 'deflate' | 'exi' | 'gzip' | 'identity' | 'pack200-gzip' | 'zstd'

Specifies whether the response should be compressed and how.

identity (the default) indicates that no compression will be performed.

If-Modified-Sincestring date-time

Instructs to return the content matching the query only if it has changed since the supplied timestamp.

Response

OK

string required

Changes

No recorded changes to this operation across all 1 revision of this API.