Skip to content

Latest commit

 

History

History
109 lines (67 loc) · 5.92 KB

registration.md

File metadata and controls

109 lines (67 loc) · 5.92 KB

Data registration queries

Overview

A Data Registration defines the Data Source for a Provision Agreement along with a last updated timestamp and a unique identifier.

The Data Registration query API enables a client application to discover registered data sources by querying by either the unique ID of the Data Registration, or by filtering Data Registration by its Provision Agreement or the corresponding Dataflow, Data Structure Definition, or Data Provider.

By Registration ID

Overview

These queries enable clients to find a single Registration by its unique ID.

Syntax

    protocol://ws-entry-point/registration/id/{registrationId}
Parameter Type Description Default Multiple values
registrationId A string compliant with the SDMX common:IDType The ID of the registration to be returned. No

Example

Retrieve all Registrations with unique ID 'abcd-efgh-ijkl'

    https://ws-entry-point/registration/id/abcd-efgh-ijkl

By Data Provider

Overview

These queries enable clients to find all Registrations by Data Provider, this is resolved through the Provision Agreement that the Registration references.

Each path parameter can contain a wildcard filter '*' to mean 'all'. It is therefore possible to use this query to retrieve all Registrations.

Syntax

    protocol://ws-entry-point/registration/provider/{providerAgencyID}/{providerID}?{updatedAfter}&{updatedBefore}
Parameter Type Description Default Multiple values
providerAgencyID A string compliant with the SDMX common:NCNameIDType Registrations should only be returned if the referenced Provision Agreement is for a Data Provider which is maintained in a Data Provider Scheme belonging to this Agency * Yes
providerID A string compliant with the SDMX common:IDType Registrations should only be returned if the referenced Provision Agreement is for a Data Provider with this ID * Yes
updatedBefore xs:dateTime Optional parameter: if this parameter is used, the returned message should only include Registrations updated before this time (exclusive) No
updatedAfter xs:dateTime Optional parameter: if this parameter is used, the returned message should only include Registrations updated after this time (exclusive) No

Examples of queries

Retrieve all Registrations for the UK1 Data Provider maintained in the IMF Data Provider Scheme

    https://ws-entry-point/registration/provider/IMF/UK1

Retrieve all Registrations for both the UK1 and UK2 Data Providers maintained in the IMF Data Provider Scheme

    https://ws-entry-point/registration/provider/IMF/UK1,UK2

Retrieve all Registrations for any Data Provider maintained in the IMF Data Provider Scheme

    https://ws-entry-point/registration/provider/IMF/*

By Provision Agreement, Dataflow, or Data Structure Definition

Overview

These queries enable clients to find all Registrations related to one or more Provision Agreements, Dataflows or Data Structure Definitions. The context controls which level the filter is applied to (datastructure, dataflow, provisionagreement) with the subsequent path parameters defining more precisely which context structures to filter for. For example if the context is dataflow, with agencyID of ECB the response will contain all Registrations related to ECB Dataflows.

It should be noted that the Registration only references a Provision Agreement, the Provision Agreement is used to determin the corresponding Dataflow and Data Structure Definition.

Each path parameter can contain a wildcard filter '*' to mean 'all'. It is therefore possible to use this query to retrieve all Registrations.

Syntax

    protocol://ws-entry-point/registration/{context}/{agencyID}/{resourceID}/{version}?{updatedAfter}&{updatedBefore}
Parameter Type Description Default Multiple values
context One of the following: datastructure, dataflow, provisionagreement Registrations relate to provision agreement, which in turn can be used to identify the related dataflow and data structure definition. This parameter allows selecting the desired context for registration retrieval. * No
agencyID A string compliant with the SDMX common:NCNameIDType The agency maintaining the context artefact. * Yes
resourceID A string compliant with the SDMX common:IDType The id of the context artefact. * Yes
version A string compliant with the SDMX semantic versioning rules The version of the context artefact. * Yes
updatedBefore xs:dateTime Optional parameter, if this parameter is used, the returned message should only include Registrations updated before this time (exclusive) No
updatedAfter xs:dateTime Optional parameter, if this parameter is used, the returned message should only include Registrations updated after this time (exclusive) No

Examples of queries

Retrieve all Registrations for the Balance Sheet Item (BSI) Dataflow maintained by the ECB

    https://ws-entry-point/registration/dataflow/ECB/BSI/1.0.0

Retrieve all Registrations for the BSI and EXR Dataflows maintained by the ECB

    https://ws-entry-point/registration/dataflow/ECB/BSI,EXR/1.0.0

Retrieve all Registrations for the ECOFIN DataStructure maintained by the IMF

    https://ws-entry-point/registration/datastructure/IMF/ECOFIN/1.0

Retrieve all Registrations updated after a specific point in time (percent encoded)

    https://ws-entry-point/registration/datastructure/*/*/*?updatedAfter=2009-05-15T14%3A15%3A00%2B01%3A00

Response types

The following media types can be used with registration queries:

  • application/vnd.sdmx.registry+xml;version=3.0.0

The default format is highlighted in bold. For media types of previous SDMX versions, please consult the documentation of the SDMX version you are interested in.