Skip to content

Registration

A Registration records that a data provider has made data available under a Provision Agreement, and says where to get it. The document starts with ref: "Registration=AGENCY:ID(1.0)".

The writer is RegistrationCanonicalWriter.

Simple form

format: "fusion-yaml(1.0.0)"
ref: "Registration=ECB:EXR(1.0)"
name: "Test Registration"
provisionagreement: "ECB:EXR(1.0)"
dataurl: "https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest/data/ECB,EXR,1.0/A.RON..."
updated: "2026-09-29T13:20:52"
Source: registration/testSimpleUrl.yaml

The document starts with the common header. Then come these body fields:

  • provisionagreement: the short URN of the Provision Agreement being registered against (references).
  • dataurl: the URL of a simple data source, which is a file or a query URL that returns the data.
  • updated: when the registration was last updated, in SDMX date format.

Complete example

When the data source is an SDMX REST API, its URL is written under sdmxapi instead of dataurl:

format: "fusion-yaml(1.0.0)"
ref: "Registration=ECB:EXR(1.0)"
name: "Test Registration"
provisionagreement: "ECB:EXR(1.0)"
sdmxapi: "https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest"
updated: "2026-09-29T13:20:52"
Source: registration/testRESTUrl.yaml

validFrom and validTo are written after updated, in SDMX date format, when the registration has a validity window.

Field reference

Field Value Written when
provisionagreement short URN of the provision agreement the registration references a provision agreement
sdmxapi URL of the SDMX REST API the data source is a REST data source
dataurl URL of the data the data source is not a REST data source
updated SDMX date (e.g. "2026-09-29T13:20:52") the registration has a last updated date
validFrom SDMX date the registration has a valid from date
validTo SDMX date the registration has a valid to date

The registration's index flags (index time series, index data set, and so on) are not written. They are due to be removed from the information model.

Note

A registration is never written as a stub. Asking a registration for its stub returns the full registration, so the body above is always written.

Reading notes

  • The field name sets the data source type. sdmxapi is read as a REST data source and dataurl as a simple data source.

The checksum includes the last updated date

updated is part of the canonical document, so it is part of the checksum. A registration's last updated date defaults to the time the registration is built. If you build a registration without setting it, the same registration has a different checksum each time it is built. Set the last updated date explicitly when the checksum must be stable.