Last modified by Artur on 2025/09/30 13:28
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -163,9 +163,8 @@ 163 163 164 164 The registry interfaces are invoked in one of two ways: 165 165 166 -* 167 -*1. The interface is the name of the root node of the SDMX-ML document 168 -*1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 166 +1. The interface is the name of the root node of the SDMX-ML document 167 +1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 169 169 170 170 In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3. 171 171 ... ... @@ -181,15 +181,15 @@ 181 181 182 182 === 5.2.2 Structure Submission Service === 183 183 184 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]].In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).183 +The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model). 185 185 186 186 === 5.2.3 Structure Query Service === 187 187 188 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]].The registry response to this query mechanism is the SDMX Structure message, which has as its root node:187 +The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node: 189 189 190 - •Structure189 +* Structure 191 191 192 -The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx >>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[rest/blob/master/doc/structures.md>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]__[[url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]191 +The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] 193 193 194 194 === 5.2.4 Data and Reference Metadata Registration Service === 195 195 ... ... @@ -271,7 +271,7 @@ 271 271 1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 272 272 273 273 a) Be a draft version. 274 -b) Not be explicitly ^^[[(%class="wikiinternallinkwikiinternallinkwikiinternallinkwikiinternallink"%)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^referenced from any other object in the Registry.273 +b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 275 275 276 276 4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 277 277 ))) ... ... @@ -305,47 +305,48 @@ 305 305 * //Versionable// 306 306 * //Maintainable// 307 307 308 -| |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes** 309 -| |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 310 -| |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 311 -| |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 312 -| |(% colspan="2" %)((( 307 +(% style="width:1306.83px" %) 308 +|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes** 309 +|(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 310 +|(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 311 +|(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 312 +|(% colspan="2" %)((( 313 313 AnnotationText in the form of 314 314 315 315 InternationalString 316 316 )))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants 317 -| |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)318 -| |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)319 -| |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)320 -| |(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.321 -| |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((317 +|(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 318 +|(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %) 319 +|(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 320 +|(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn. 321 +|(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)((( 322 322 All content as for 323 323 324 324 //Identifiable// plus 325 325 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 326 -| |(% colspan="2" %)(((326 +|(% colspan="2" %)((( 327 327 Name in the form of 328 328 329 329 InternationalString 330 330 )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants. 331 -| |(% colspan="2" %)(((331 +|(% colspan="2" %)((( 332 332 Description in the form of 333 333 334 334 InternationalString 335 335 )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants. 336 -| |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((336 +|(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)((( 337 337 All content as for 338 338 339 339 //Identifiable// plus 340 340 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 341 -| |(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.342 -| |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)343 -| |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)344 -|(% colspan="2" rowspan="5"%)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)|345 -|(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file. |346 -|(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource. |347 -|(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource. |348 -|(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. |341 +|(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules. 342 +|(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 343 +|(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 344 +|(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 345 +|(% colspan="2" %) |(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file. 346 +|(% colspan="2" %) |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource. 347 +|(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource. 348 +|(% colspan="2" %) |(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. 349 349 350 350 **Table 1: Common Attributes of Object Types** 351 351 ... ... @@ -604,7 +604,7 @@ 604 604 605 605 (% style="width:1272.83px" %) 606 606 |(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example** 607 -|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA 607 +|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA 608 608 |(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**) 609 609 |(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0) 610 610 |(% style="width:290px" %)Category|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:332px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category … ... ... @@ -809,7 +809,7 @@ 809 809 The artefacts included in the structural definitions are: 810 810 811 811 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme) 812 -* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 812 +* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 813 813 * All types of Structure (Data Structure Definition, Metadata Structure Definition) 814 814 * All types of Structure Usage (Dataflow, Metadataflow) 815 815 ... ... @@ -1139,7 +1139,7 @@ 1139 1139 1140 1140 The notification will contain the Registration. 1141 1141 1142 - [[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.1142 +---- 1143 1143 1144 1144 [[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this: 1145 1145 ... ... @@ -1146,3 +1146,5 @@ 1146 1146 IMF.SubAgency1 1147 1147 1148 1148 [[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList. 1149 + 1150 +{{putFootnotes/}}