Changes for page Part II.Common Namespace

Last modified by Elena Yasinovskaya on 2025/09/10 11:19

From version 6.5
edited by Helena K.
on 2025/07/03 12:23
Change comment: There is no comment for this version
To version 6.9
edited by Helena K.
on 2025/07/03 12:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -397,23 +397,25 @@
397 397  
398 398  Attribute Documentation:
399 399  
400 -|**Name**|**Type**|**Documentation**
401 -|id|IDType|The id is the identifier for the object.
402 -|urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
403 -|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
404 -|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
405 -|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
406 -|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
400 +(% style="width:1004.29px" %)
401 +|**Name**|**Type**|(% style="width:625px" %)**Documentation**
402 +|id|IDType|(% style="width:625px" %)The id is the identifier for the object.
403 +|urn|MaintainableUrnType|(% style="width:625px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
404 +|uri|xs:anyURI|(% style="width:625px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
405 +|version|VersionType|(% style="width:625px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
406 +|validFrom|xs:dateTime|(% style="width:625px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
407 +|validTo|xs:dateTime|(% style="width:625px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
407 407  
408 408  Element Documentation:
409 409  
410 -|**Name**|**Type**|**Documentation**
411 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
412 -|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.
413 -|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
414 -|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
411 +(% style="width:1005.29px" %)
412 +|**Name**|**Type**|(% style="width:728px" %)**Documentation**
413 +|Annotations|AnnotationsType|(% style="width:728px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
414 +|Link|LinkType|(% style="width:728px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.
415 +|Name|TextType|(% style="width:728px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
416 +|Description|TextType|(% style="width:728px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
415 415  
416 -***MaintainableType*:** MaintainableType is an abstract base type for all maintainable objects.
418 +//**MaintainableType:**// MaintainableType is an abstract base type for all maintainable objects.
417 417  
418 418  Derivation:
419 419  
... ... @@ -432,26 +432,28 @@
432 432  
433 433  Attribute Documentation:
434 434  
435 -|**Name**|**Type**|**Documentation**
436 -|id|IDType|The id is the identifier for the object.
437 -|urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
438 -|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
439 -|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
440 -|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
441 -|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
442 -|agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
443 -|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
444 -|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
445 -|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
446 -|isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.
437 +(% style="width:1005.29px" %)
438 +|**Name**|**Type**|(% style="width:623px" %)**Documentation**
439 +|id|IDType|(% style="width:623px" %)The id is the identifier for the object.
440 +|urn|MaintainableUrnType|(% style="width:623px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
441 +|uri|xs:anyURI|(% style="width:623px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
442 +|version|VersionType|(% style="width:623px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
443 +|validFrom|xs:dateTime|(% style="width:623px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
444 +|validTo|xs:dateTime|(% style="width:623px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
445 +|agencyID|NestedNCNameIDType|(% style="width:623px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
446 +|isExternalReference (default: false)|xs:boolean|(% style="width:623px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
447 +|serviceURL|xs:anyURI|(% style="width:623px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
448 +|structureURL|xs:anyURI|(% style="width:623px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
449 +|isPartialLanguage (default: false)|xs:boolean|(% style="width:623px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.
447 447  
448 448  Element Documentation:
449 449  
450 -|**Name**|**Type**|**Documentation**
451 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
452 -|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.
453 -|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
454 -|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
453 +(% style="width:1004.29px" %)
454 +|**Name**|**Type**|(% style="width:727px" %)**Documentation**
455 +|Annotations|AnnotationsType|(% style="width:727px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
456 +|Link|LinkType|(% style="width:727px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.
457 +|Name|TextType|(% style="width:727px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
458 +|Description|TextType|(% style="width:727px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
455 455  
456 456  **ReferencePeriodType:** Specifies the inclusive start and end times.
457 457  
... ... @@ -463,9 +463,10 @@
463 463  
464 464  Attribute Documentation:
465 465  
466 -|**Name**|**Type**|**Documentation**
467 -|startTime|xs:dateTime|The startTime attributes contains the inclusive start date for the reference period.
468 -|endTime|xs:dateTime|The endTime attributes contains the inclusive end date for the reference period.
470 +(% style="width:995.294px" %)
471 +|(% style="width:145px" %)**Name**|(% style="width:216px" %)**Type**|(% style="width:632px" %)**Documentation**
472 +|(% style="width:145px" %)startTime|(% style="width:216px" %)xs:dateTime|(% style="width:632px" %)The startTime attributes contains the inclusive start date for the reference period.
473 +|(% style="width:145px" %)endTime|(% style="width:216px" %)xs:dateTime|(% style="width:632px" %)The endTime attributes contains the inclusive end date for the reference period.
469 469  
470 470  **QueryableDataSourceType:** QueryableDataSourceType describes a data source which is accepts an standard SDMX Query message and responds appropriately.
471 471  
... ... @@ -477,16 +477,18 @@
477 477  
478 478  Attribute Documentation:
479 479  
480 -|**Name**|**Type**|**Documentation**
481 -|isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
482 -|isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
485 +(% style="width:999.294px" %)
486 +|(% style="width:259px" %)**Name**|(% style="width:236px" %)**Type**|(% style="width:502px" %)**Documentation**
487 +|(% style="width:259px" %)isRESTDatasource|(% style="width:236px" %)xs:boolean|(% style="width:502px" %)The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
488 +|(% style="width:259px" %)isWebServiceDatasource|(% style="width:236px" %)xs:boolean|(% style="width:502px" %)The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
483 483  
484 484  Element Documentation:
485 485  
486 -|**Name**|**Type**|**Documentation**
487 -|DataURL|xs:anyURI|DataURL contains the URL of the data source.
488 -|WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
489 -|WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
492 +(% style="width:996.294px" %)
493 +|**Name**|**Type**|(% style="width:657px" %)**Documentation**
494 +|DataURL|xs:anyURI|(% style="width:657px" %)DataURL contains the URL of the data source.
495 +|WSDLURL|xs:anyURI|(% style="width:657px" %)WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
496 +|WADLURL|xs:anyURI|(% style="width:657px" %)WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
490 490  
491 491  **XHTMLType:** XHTMLType allows for mixed content of text and XHTML tags. When using this type, one will have to provide a reference to the XHTML schema, since the processing of the tags within this type is strict, meaning that they are validated against the XHTML schema provided.
492 492  
... ... @@ -494,12 +494,13 @@
494 494  xml:lang?
495 495  
496 496  Content:
497 -{text} x {any element with namespace of http://www.w3.org/1999/xhtml}
504 +{text} x {any element with namespace of http:~/~/www.w3.org/1999/xhtml}
498 498  
499 499  Attribute Documentation:
500 500  
501 -|**Name**|**Type**|**Documentation**
502 -|xml:lang (default: en)|xs:language
508 +(% style="width:1009.29px" %)
509 +|(% style="width:228px" %)**Name**|(% style="width:221px" %)**Type**|(% style="width:699px" %)**Documentation**
510 +|(% style="width:228px" %)xml:lang (default: en)|(% style="width:221px" %)xs:language
503 503  
504 504  ***PayloadStructureType*:** PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage).
505 505  
... ... @@ -511,23 +511,25 @@
511 511  
512 512  Attribute Documentation:
513 513  
514 -|**Name**|**Type**|**Documentation**
515 -|structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
516 -|schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
517 -|namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
518 -|dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
519 -|explicitMeasures|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
520 -|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
521 -|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
522 +(% style="width:1003.29px" %)
523 +|**Name**|**Type**|(% style="width:598px" %)**Documentation**
524 +|structureID|xs:ID|(% style="width:598px" %)The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
525 +|schemaURL|xs:anyURI|(% style="width:598px" %)The schemaURL attribute provides a location from which the structure specific schema can be located.
526 +|namespace|xs:anyURI|(% style="width:598px" %)The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
527 +|dimensionAtObservation|ObservationDimensionType|(% style="width:598px" %)The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
528 +|explicitMeasures|xs:boolean|(% style="width:598px" %)The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
529 +|serviceURL|xs:anyURI|(% style="width:598px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
530 +|structureURL|xs:anyURI|(% style="width:598px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
522 522  
523 523  Element Documentation:
524 524  
525 -|**Name**|**Type**|**Documentation**
526 -|ProvisionAgreement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data or metadata is reported against.
527 -|StructureUsage|StructureUsageRefere nceType|StructureUsage references a flow which the data or metadata is reported against.
528 -|Structure|StructureReferenceTy pe|Structure references the structure which defines the structure of the data or metadata set.
534 +(% style="width:1005.29px" %)
535 +|(% style="width:188px" %)**Name**|(% style="width:287px" %)**Type**|(% style="width:527px" %)**Documentation**
536 +|(% style="width:188px" %)ProvisionAgreement|(% style="width:287px" %)ProvisionAgreementReferenceType|(% style="width:527px" %)ProvisionAgreement references a provision agreement which the data or metadata is reported against.
537 +|(% style="width:188px" %)StructureUsage|(% style="width:287px" %)StructureUsageReferenceType|(% style="width:527px" %)StructureUsage references a flow which the data or metadata is reported against.
538 +|(% style="width:188px" %)Structure|(% style="width:287px" %)StructureReferenceType|(% style="width:527px" %)Structure references the structure which defines the structure of the data or metadata set.
529 529  
530 -***DataStructureType*:** DataStructureType is an abstract base type the forms the basis for the structural information for a data set.
540 +//**DataStructureType:**// DataStructureType is an abstract base type the forms the basis for the structural information for a data set.
531 531  
532 532  Derivation:
533 533  
© Semantic R&D Group, 2026