Changes for page Part VI. Registry Namespace

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

From 2.1 to 2.2 From 2.3 to 3.1

From version 2.2

edited by Helena
on 2025/06/26 14:10

Change comment: There is no comment for this version

To version 2.3

edited by Helena
on 2025/06/26 14:13

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -134,21 +134,17 @@
  **MaintainableQueryType: **MaintainableQueryType describes the structure of a query for a maintainable object.
  Derivation:
++* IdentifiableQueryType (extension)
++** VersionableQueryType (extension)
++*** MaintainableQueryType
--IdentifiableQueryType (extension)
--   [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] VersionableQueryType (extension)
--         [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MaintainableQueryType
--
  Attributes:
--
  id?, version?, agencyID?
  Content:
--
  {Empty}
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |id (default: %)|IDQueryType|The id attribute is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.
  |version (default: *)|VersionQueryType|The version attribute is used to query for an object based on its version. This can be and explicit value, wild-carded ("%"), or late-bound ("*"). A wild carded version will match any version of the object where as a late-bound version will only match the latest version.
@@ -157,20 +157,16 @@
  **StatusMessageType: **StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.
  Attributes:
--
  status
  Content:
--
  MessageText*
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |status|StatusType|The status attribute carries the status of the query or request.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |MessageText|com: StatusMessageType|MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors.
@@ -177,11 +177,9 @@
  **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/metadata set registrations.
  Content:
--
  RegistrationRequest+
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |RegistrationRequest|RegistrationRequestT ype|RegistrationRequest provides the details of a requested registration and the action to take on it. A reference to a provision agreement that exists in the registry must be provide along with a simple and/or queryable data source. The id should only be provided when updating or deleting a registration.
@@ -188,20 +188,16 @@
  **RegistrationRequestType: **RegistrationRequestType describes the structure of a single registration request. It contains the details of a registation and an action field to indicate the action to be taken on the contained registration.
  Attributes:
--
  action
  Content:
--
  Registration
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |action|com:ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a registration.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |Registration|RegistrationType|Registration contains the details of the data/metadata set registration to be added, updated, or deleted.
@@ -208,11 +208,9 @@
  **SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType describes the structure of a registration response. For each submitted registration in the request, a registration status is provided. The status elements should be provided in the same order as the submitted registrations, although each status will echo the request to ensure accurate processing of the responses.
  Content:
--
  RegistrationStatus+
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.
@@ -219,11 +219,9 @@
  **RegistrationStatusType: **RegistrationStatusType describes the structure of a registration status.
  Content:
--
  Registration, StatusMessage
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |Registration|RegistrationType|Registration, at the very least echoes the submitted registration. It the request was to create a new registration and it was successful, an id must be supplied.
  |StatusMessage|StatusMessageType|StatusMessage provides that status for the registration request, and if necessary, any error or warning information.
@@ -231,20 +231,16 @@
  **QueryRegistrationRequestType: **QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, reference metadata, or both) must be specified. It is possible to query for registrations for a particular provision agreement, data provider, or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing constraints in the form of explicit time periods, constraint regions, and key sets. When constraint regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.
  Attributes:
--
  returnConstraints?
  Content:
--
  QueryType, (All | ProvisionAgreement | DataProvider | Dataflow | Metadataflow), ReferencePeriod?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |returnConstraints (default: false)|xs:boolean|The returnConstraints attribute determines whether information about the constraints on the data or metadata sets returned should also be sent the results.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for.
  |All|com:EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned.
@@ -261,11 +261,9 @@
  **QueryRegistrationResponseType: **QueryRegistrationResponseType describes the structure of a registration query response. It provides a status for the request, and if successful, the resulting data and/or metadata results.
  Content:
--
  StatusMessage, QueryResult*
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.
  |QueryResult|QueryResultType|QueryResult contains a result for a successful registration query. It can occur multiple times, for each registration the meets the conditions specified in the query.
@@ -273,20 +273,16 @@
  **QueryResultType: **QueryResultType describes the structure of a query result for a single data source. Either a data result or metadata result is detailed, depending on the data source.
  Attributes:
--
  timeSeriesMatch
  Content:
--
  (DataResult | MetadataResult)
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |timeSeriesMatch|xs:boolean|The timeSeriesMatch attribute is true when the result is an exact match with the key found in the registry - that is, when the registered data source provides a matching key. It is set to false when the data source is registered with cube-region constraints, or in any other circumstance when it cannot be established that the sought-for keys have been exactly matched. This is always true when the resulting data source is the source of a metadata set.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |DataResult|ResultType|
  |MetadataResult|ResultType|
@@ -294,11 +294,9 @@
  **ResultType: **ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content constraints for the data source may be provided, if the query requested this information.
  Content:
--
  Registration, ContentConstraint*
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |Registration|RegistrationType|Registration provides the details of a matching registration. In addition to the data source and provision agreement information, the id of the registration must also be provided.
  |ContentConstraint|com: ContentConstraintRef erenceType|ContentConstraint provides a reference to a content constraint in the registry for the resulting data source (or possibly constraints base on the registration provision agreement, data provider, structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields.
@@ -306,21 +306,17 @@
  **SubmitStructureRequestType: **SubmitStructureRequestType describes the structure of a structure submission. Structural components are provided either in-line or referenced via a SDMX-ML Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained components, but can be overridden on a per component basis.
  Attributes:
--
  action?, externalDependencies?
  Content:
--
  (StructureLocation | str:Structures), SubmittedStructure*
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |action (default: Append)|com:ActionType|The action attribute indicates the default action (append-add, replace-update, delete, or no action-informational) to be taken on all structural components in either the external SDMX-ML Structure message or the in-line components. The default action is Append. The Replace action is not applicable to final structures in the repository, and will produce an error condition, as these can be versioned but not modified. To submit a later version of a structural object, the object should include the incremented version number.
  |externalDependencies (default: false)|xs:boolean|The externalDependencies attribute indicates the default resolution of external dependencies. This should be set to true if the repository is expected to use external reference URLs in the structural components to retrieve any externally referenced objects that is used by a non-external object.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |StructureLocation|xs:anyURI|StructureLocation provides the location of a SDMX-ML Structure message, external to the repository that can be retrieved by the repository submission service.
  |str:Structures|str:StructuresType|Structures allows for the inline definition of structural components for submission.
@@ -329,21 +329,17 @@
  **SubmittedStructureType: **SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action attribute should be populated in order to echo the requested action.
  Attributes:
--
  action?, externalDependencies?
  Content:
--
  MaintainableObject
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |action|com:ActionType|The action attribute will indicate the action to be taken on the referenced structural object. This should be provided when this structure is used in a submit structure response.
  |externalDependencies|xs:boolean|The externalDependencies attribute should be set to true if the repository is expected to use external reference URLs in the structural components to retrieve objects on which the referenced object has dependencies. (Thus, if a key family referenced here is being submitted to the repository, and the structure message has URLs which point to the locations of the codelists it uses, then this attribute should be set to true). This should not be provided when this structure is used in a submit structure response.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |MaintainableObject|com: MaintainableReferenc eType|
@@ -350,11 +350,9 @@
  **SubmitStructureResponseType: **SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
  Content:
--
  SubmissionResult+
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |SubmissionResult|SubmissionResultType|SubmissionResult provides a status for each submitted structural object.
@@ -361,11 +361,9 @@
  **SubmissionResultType: **SubmissionResultType provides the status of the structural object submission request. It will identify the object submitted, report back the action requested, and convey the status and any error messages which are relevant to the submission.
  Content:
--
  SubmittedStructure, StatusMessage
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
  |StatusMessage|StatusMessageType|StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.
@@ -373,11 +373,9 @@
  **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of subscriptions. Subscriptions are submitted to the registry to subscribe to registration and change events for specific registry resources.
  Content:
--
  SubscriptionRequest+
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |SubscriptionRequest|SubscriptionRequestT ype|
@@ -384,7 +384,6 @@
  **SubscriptionType: **SubscriptionType describes the details of a subscription to a registration or change event for registry resources. When it occurs as the content of a response message, the registry URN must be provide, unless the response is a failure notification for the creation of a new subscription.
  Content:
--
  Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
  Element Documentation:
@@ -401,20 +401,16 @@
  **SubscriptionRequestType: **SubscriptionRequestType describes the structure of a single subscription request. It contains subscription details and an action field to indicate the action to be taken on the contained subscription. Note that if the action is update or delete, then the registry supplied URN for the subscription must be included.
  Attributes:
--
  action
  Content:
--
  Subscription
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |action|com:ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.
@@ -421,11 +421,9 @@
  **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.
  Content:
--
  SubscriptionStatus+
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |SubscriptionStatus|SubscriptionStatusTy pe|SubscriptionStatus contains information which describes the success or failure of a subscription request, providing any error messages in the event of failure. The statuses should occur in the same order as the requests when responding to a message with multiple subscription requests. If a subscriber-assigned identification for the subscription is provided, it will be returned to allow for accurate matching of the responses to the requests. A registry assigned URN will be returned for any successfully created, updated, or deleted subscription.
@@ -432,11 +432,9 @@
  **SubscriptionStatusType: **SubscriptionStatusType describes the structure a status for a single subscription request.
  Content:
--
  SubscriptionURN?, SubscriberAssignedID?, StatusMessage
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.
  |SubscriberAssignedID|com:IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.
@@ -445,11 +445,9 @@
  **QuerySubscriptionRequestType: **QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
  Content:
--
  Organisation
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |Organisation|com: OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.
@@ -456,11 +456,9 @@
  **QuerySubscriptionResponseType: **QuerySubscriptionResponseType describes the structure of a subscription query response. A status will describe the success or failure of the request (and provide error or warning messages if necessary). If the query was successful, details of all of the organisation's subscriptions will be provided.
  Content:
--
  StatusMessage, Subscription*
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.
  |Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.
@@ -468,11 +468,9 @@
  **NotifyRegistryEventType: **NotifyRegistryEventType describes the structure a registry notification, in response to a subscription to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying subscription triggering the notification, 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.
  Content:
--
  EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |EventTime|xs:dateTime|EventTime specifies the time of the triggering event.
  |ObjectURN|xs:anyURI|ObjectURN provides the URN of the object on which the event occurred, unless the event is related to a registration, in which case the RegistrationID element should be used.
@@ -485,19 +485,16 @@
  **NotificationURLType: **NotificationURLType describes the structure of an http or email address. The content holds the addresses while an attribute indicates whether or not is expects the contents in a SOAP message.
  Derivation:
++* xs:anySimpleType (restriction)
++** xs:anyURI (extension)
++*** NotificationURLType
--xs:anySimpleType (restriction)
--   [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] xs:anyURI (extension)
--         [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] NotificationURLType
--
  Attributes:
--
  isSOAP?
  Content:
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.
@@ -504,11 +504,9 @@
  **ValidityPeriodType: **ValidityPeriodType specifies inclusive start and end-dates for the subscription period.
  Content:
--
  StartDate, EndDate
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |StartDate|xs:date|StartDate is an inclusive start date for the subscription.
  |EndDate|xs:date|EndDate is an inclusive end date for the subscription.
@@ -516,11 +516,9 @@
  **EventSelectorType: **EventSelectorType describes the details of the events for a subscription. It allows subscribers to specify registry and repository events for which they wish to receive notifications.
  Content:
--
  (StructuralRepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents)[1..3]
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.
  |DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.
@@ -529,20 +529,16 @@
  **StructuralRepositoryEventsType: **StructuralRepositoryEventsType details the structural events for the subscription. At least one maintenance agency must be specified, although it may be given a wildcard value (meaning the subscription is for the structural events of all agencies). This can also be a list of agencies to allow the subscription to subscribe the events of more than one agency. It should be noted that when doing so, all of the subsequent objects are assumed to apply to every agency in the list. The subscription is then refined by detailing the structural objects maintained by the agency for which the subscription should apply. It is possible to explicitly select all object events, all objects of given types, or to individually list out specific objects. Note that for any object, it is also possible to provide an explicit URN to reference a distinct object. In this case, the reference to maintenance agency described above is ignored. Although it is not required, if specific objects are being referenced by explicit URNs, it is good practice to list the agencies.
  Attributes:
--
  TYPE?
  Content:
--
  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)+)
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |TYPE (fixed: STRUCTURE)|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.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |AgencyID|NestedIDQueryType|AgencyID specifies a maintenance agency for the object or objects indicated in the other fields. This can be either a specific ID, or a single wildcard character ("%"). A wild card character can be used to select all agencies, allowing a subscription to all events for particular object types. This can occur multiple times to list a of group of maintenance agencies, creating event subscriptions for all of the subsequent objects for each agency in the group. Note that if multiple agencies are supplied, then the wildcard character should not be used for any of them.
  |AllEvents|com:EmptyType|AllEvents creates a subscription to structural events for all structural objects maintained by the agencies referenced.
@@ -574,11 +574,9 @@
  **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.
  Content:
--
  (All | URN | ID)
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |All|com:EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.
  |URN|xs:anyURI|URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
@@ -587,11 +587,9 @@
  **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.
  Content:
--
  (All | URN | (ID, Version))
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |All|com:EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.
  |URN|xs:anyURI|URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
@@ -601,20 +601,16 @@
  **DataRegistrationEventsType: **DataRegistrationEventsType details the data registration events for the subscription. It is possible to subscribe to all data registration events in the repository, or specific events for; single registrations, provision agreements, data providers, data flows, key families, and categories that categorize data flows or key families.
  Attributes:
--
  TYPE?
  Content:
--
  (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference | Category)+)
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |TYPE (fixed: DATA)|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.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |AllEvents|com:EmptyType|AllEvents subscribes to all data registration events in the repository.
  |RegistrationID|com:IDType|RegistrationID subscribes to all the data registration events for the unique registration referenced.
@@ -627,20 +627,16 @@
  **MetadataRegistrationEventsType: **MetadataRegistrationEventsType details the metadata registration events for the subscription. It is possible to subscribe to all metadata registration events in the repository, or specific events for; single registrations, provision agreements, data providers, metadata flows, metadata structure definitions, and categories that categorize metadata flows or metadata structure definitions.
  Attributes:
--
  TYPE?
  Content:
--
  (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | Category)+)
  Attribute Documentation:
--
  |**Name**|**Type**|**Documentation**
  |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.
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |AllEvents|com:EmptyType|AllEvents subscribes to all metadata registration events in the repository.
  |RegistrationID|com:IDType|RegistrationID subscribes to all the metadata registration events for the unique registration referenced.
@@ -653,11 +653,9 @@
  **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.
  Content:
--
  (URN | Ref)
  Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |URN|xs:anyURI|URN provides an explicit reference to a single object.
  |Ref|MaintainableQueryTyp e|Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.