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

From version 3.18
edited by Helena
on 2025/07/02 17:19
Change comment: There is no comment for this version
To version 6.1
edited by Helena
on 2025/07/03 10:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Part V. Query
1 +Part V. Registry
Content
... ... @@ -60,7 +60,7 @@
60 60  **DataSourceType:** DataSourceType specifies the properties of a data or metadata source. Either a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]], a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]], or both must be specified.
61 61  
62 62  Content:
63 -(SimpleDataSource|QueryableDataSource)[1..2]
63 +(SimpleDataSource | QueryableDataSource) [1..2]
64 64  
65 65  Element Documentation:
66 66  
... ... @@ -73,9 +73,9 @@
73 73  
74 74  Derivation:
75 75  
76 -xs:anySimpleType (restriction)
77 - xs:anyURI (extension)
78 - SimpleDataSourceType
76 +> xs:anySimpleType (restriction)
77 +> xs:anyURI (extension)
78 +> SimpleDataSourceType
79 79  
80 80  Attributes:
81 81  TYPE?
... ... @@ -251,7 +251,7 @@
251 251  returnConstraints?
252 252  
253 253  Content:
254 -QueryType, (All|ProvisionAgreement|DataProvider|Dataflow|Metadataflow), ReferencePeriod?, (DataKeySet|CubeRegion|MetadataTargetRegion)
254 +QueryType, (All | ProvisionAgreement | DataProvider | Dataflow | Metadataflow), ReferencePeriod?, (DataKeySet | CubeRegion | MetadataTargetRegion)
255 255  
256 256  Attribute Documentation:
257 257  
... ... @@ -292,7 +292,7 @@
292 292  timeSeriesMatch
293 293  
294 294  Content:
295 -(DataResult|MetadataResult)
295 +(DataResult | MetadataResult)
296 296  
297 297  Attribute Documentation:
298 298  
... ... @@ -327,7 +327,7 @@
327 327  action?, externalDependencies?
328 328  
329 329  Content:
330 -(StructureLocation|Structures), SubmittedStructure
330 +(StructureLocation | Structures), SubmittedStructure
331 331  
332 332  [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
333 333  
... ... @@ -486,7 +486,7 @@
486 486  **NotifyRegistryEventType:** NotifyRegistryEventType describes the structure a registry [[notification>>doc:sdmx:Glossary.Notification.WebHome]], in response to a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] triggering the [[notification>>doc:sdmx:Glossary.Notification.WebHome]], and the action that took place on the object are sent. In addition, the full details of the object may be provided at the discretion of the registry. In the event that the details are not sent, it will be possible to query for the details of the changed object using the reference provided.
487 487  
488 488  Content:
489 -EventTime, (ObjectURN|RegistrationID), SubscriptionURN, EventAction, (StructuralEvent|RegistrationEvent)?
489 +EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?
490 490  
491 491  Element Documentation:
492 492  
... ... @@ -534,7 +534,7 @@
534 534  
535 535  Content:
536 536  
537 -(StructuralRepositoryEvents|DataRegistrationEvents|MetadataRegistrationEvents)[1..3]
537 +(Structura l RepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents) [1..3]
538 538  
539 539  Element Documentation:
540 540  
... ... @@ -550,7 +550,7 @@
550 550  TYPE?
551 551  
552 552  Content:
553 -AgencyID+, (AllEvents|(AgencyScheme|DataConsmerScheme|DataProviderScheme|OrganisationUnitScheme|Dataflow|Metadataflow|CategoryScheme|Categorisation|Codelist|HierarchicalCodelist|ConceptScheme|MetadataStructureDefinition|KeyFamily|StructureSet|ReportingTaxonomy|Process|AttachmentConstraint|ContentConstraint|ProvisionAgreement|TransformationScheme|NameAliasScheme|NamePersonalisationScheme|RulesetScheme|UserDefinedOperatorScheme)+)
553 +AgencyID+, (AllEvents|(AgencyScheme | DataConsmerScheme | DataProviderScheme | OrganisationUnitScheme | Dataflow | Metadataflow | CategoryScheme | Categorisation | Codelist | Hierarchica l Codelist | ConceptScheme | MetadataStructureDefinition | KeyFamily | StructureSet | ReportingTaxonomy | Process | AttachmentConstraint | ContentConstraint | ProvisionAgreement | TransformationScheme | NameAliasScheme | NamePersonalisationScheme | RulesetScheme | UserDefinedOperatorScheme)+)
554 554  
555 555  [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
556 556  
... ... @@ -592,7 +592,7 @@
592 592  **IdentifiableObjectEventType:** IdentifiableObjectEventType describes the structure of a reference to an identifiable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
593 593  
594 594  Content:
595 -(All|URN|ID)
595 +(All | URN | ID)
596 596  
597 597  Element Documentation:
598 598  
... ... @@ -605,7 +605,7 @@
605 605  **VersionableObjectEventType:** VersionableObjectEventType describes the structure of a reference to a versionable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
606 606  
607 607  Content:
608 -(All|URN|(ID, Version))
608 +(All|URN | (ID, Version))
609 609  
610 610  Element Documentation:
611 611  
... ... @@ -622,7 +622,7 @@
622 622  TYPE?
623 623  
624 624  Content:
625 -(AllEvents|(RegistrationID|ProvisionAgreement|DataProvider|DataflowReference|KeyFamilyReference|[[Category>>doc:sdmx:Glossary.Category.WebHome]])+)
625 +(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference |[[Category>>doc:sdmx:Glossary.Category.WebHome]])+)
626 626  
627 627  [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
628 628  
... ... @@ -648,34 +648,37 @@
648 648  TYPE?
649 649  
650 650  Content:
651 -(AllEvents|(RegistrationID|ProvisionAgreement|DataProvider|MetadataflowReference|MetadataStructureDefinitionReference|Category)+)
651 +(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | Category)+)
652 652  
653 -Attribute Documentation:
653 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
654 654  
655 -|**Name**|**Type**|**Documentation**|
656 -|TYPE (fixed: METADATA)|xs:string|TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.|
655 +(% style="width:1016.29px" %)
656 +|**Name**|**Type**|(% style="width:569px" %)**Documentation**
657 +|TYPE (fixed: METADATA)|xs:string|(% style="width:569px" %)TYPE is a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
657 657  
658 658  Element Documentation:
659 659  
660 -|**Name**|**Type**|**Documentation**|
661 -|AllEvents|EmptyType|AllEvents subscribes to all metadata registration events in the repository.|
662 -|RegistrationID|IDType|RegistrationID subscribes to all the metadata registration events for the unique registration referenced.|
663 -|ProvisionAgreement|ProvisionAgreementRe ferenceType|ProvisionAgreementReference subscribes to all metadata registration events for the explicitly referenced provision agreement.|
664 -|DataProvider|DataProviderReferenc eType|DataProvider subscribes to all metadata registration events for the explicitly referenced data provider.|
665 -|MetadataflowReferenc e|MaintainableEventTyp e|MetadataflowReference subscribes to all metadata registration events for the metadata flows referenced by this object. This may reference one or more metadata flows, as the specific references fields allow for a wild-carded value.|
666 -|MetadataStructureDef initionReference|MaintainableEventTyp e|MetadataStructureDefinitionReference subscribes to all metadata registration events for the metadata structure definitions referenced by this object. This may reference one or more metadata structure definitions, as the specific references fields allow for a wild-carded value.|
667 -|Category|CategoryReferenceTyp e|Category subscribes to all metadata registration events for any metadata flows or metadata structure definitions that are categorized by the referenced category.|
661 +(% style="width:1020.29px" %)
662 +|**Name**|**Type**|**Documentation**
663 +|AllEvents|EmptyType|AllEvents subscribes to all metadata registration events in the repository.
664 +|RegistrationID|IDType|RegistrationID subscribes to all the metadata registration events for the unique registration referenced.
665 +|ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreementReference subscribes to all metadata registration events for the explicitly referenced provision agreement.
666 +|DataProvider|DataProviderReferenceType|DataProvider subscribes to all metadata registration events for the explicitly referenced data provider.
667 +|MetadataflowReference|MaintainableEventType|MetadataflowReference subscribes to all metadata registration events for the [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] referenced by this object. This may reference one or more [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]], as the specific references fields allow for a wild-carded value.
668 +|MetadataStructureDefinitionReference|MaintainableEventType|MetadataStructureDefinitionReference subscribes to all metadata registration events for the [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] referenced by this object. This may reference one or more [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], as the specific references fields allow for a wild-carded value.
669 +|[[Category>>doc:sdmx:Glossary.Category.WebHome]]|CategoryReferenceType|[[Category>>doc:sdmx:Glossary.Category.WebHome]] subscribes to all metadata registration events for any [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] or [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] that are categorized by the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]].
668 668  
669 669  **MaintainableEventType:** MaintainableEventType provides a reference to a maintainable object's event with either the URN of the specific object, or a set of potentially wild-carded reference fields.
670 670  
671 671  Content:
672 -(URN|Ref)
674 +(URN | Ref)
673 673  
674 674  Element Documentation:
675 675  
676 -|**Name**|**Type**|**Documentation**|
677 -|URN|xs:anyURI|URN provides an explicit reference to a single object.|
678 -|Ref|MaintainableQueryTyp e|Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.|
678 +(% style="width:1049.29px" %)
679 +|**Name**|**Type**|**Documentation**
680 +|URN|xs:anyURI|URN provides an explicit reference to a single object.
681 +|Ref|MaintainableQueryType|Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.
679 679  
680 680  **StructuralEventType:** StructuralEventType provides the details of a structure event, specifically the object that changed.
681 681  
... ... @@ -684,8 +684,9 @@
684 684  
685 685  Element Documentation:
686 686  
687 -|**Name**|**Type**|**Documentation**|
688 -|Structures|StructuresType|Structures contains the details of the structural object that has triggered the event. Although this container allows for multiple structural object, it should only contain the one changed object.|
690 +(% style="width:1083.29px" %)
691 +|**Name**|**Type**|**Documentation**
692 +|Structures|StructuresType|Structures contains the details of the structural object that has triggered the event. Although this container allows for multiple structural object, it should only contain the one changed object.
689 689  
690 690  **RegistrationEventType:** This provides the details of a data or metadata registration event for the purposes of notification.
691 691  
... ... @@ -694,8 +694,9 @@
694 694  
695 695  Element Documentation:
696 696  
697 -|**Name**|**Type**|**Documentation**|
698 -|Registration|RegistrationType|Registration provides the changed details of the data or metadata registration.|
701 +(% style="width:1106.29px" %)
702 +|**Name**|**Type**|**Documentation**
703 +|Registration|RegistrationType|Registration provides the changed details of the data or metadata registration.
699 699  
700 700  === 2.1.3 Simple Types ===
701 701  
... ... @@ -709,7 +709,7 @@
709 709  Union of:
710 710  NestedIDType, WildCardValueType.
711 711  
712 -**VersionQueryType:** VersionQueryType is a simple type that allows for a version number to be substituted with a wild card character ("%") or a late bound character ("\*").
717 +**VersionQueryType:** VersionQueryType is a simple type that allows for a (% style="color:#e74c3c" %)version(%%) number to be substituted with a wild card character ("%") or a late bound character ("\*").
713 713  
714 714  Union of:
715 715  LegacyVersionNumberType, SemanticVersionNumberType, SemanticVersionReferenceType, WildcardType, WildCardValueType.
... ... @@ -720,10 +720,11 @@
720 720  
721 721  Enumerations:
722 722  
723 -|**Value**|**Documentation**|
724 -|Success|Query or request successful.|
725 -|Warning|Query or request successful, but with warnings.|
726 -|Failure|Query or request not successful.|
728 +(% style="width:1013.29px" %)
729 +|**Value**|**Documentation**
730 +|Success|Query or request successful.
731 +|Warning|Query or request successful, but with warnings.
732 +|Failure|Query or request not successful.
727 727  
728 728  **QueryTypeType:** QueryType provides an enumeration of values which specify the objects in the result-set for a registry query.
729 729  
... ... @@ -731,7 +731,10 @@
731 731  
732 732  Enumerations:
733 733  
734 -|**Value**|**Documentation**|
735 -|DataSets|Only references data sets should be returned.|
736 -|MetadataSets|Only references to metadata sets should be returned.|
737 -|AllSets|References to both data sets and metadata sets should be returned.|
740 +(% style="width:1023.29px" %)
741 +|**Value**|(% style="width:630px" %)**Documentation**
742 +|[[DataSets>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:630px" %)Only references [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] should be returned.
743 +|MetadataSets|(% style="width:630px" %)Only references to [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] should be returned.
744 +|AllSets|(% style="width:630px" %)References to both [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] should be returned.
745 +
746 +|