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

From version 3.16
edited by Helena
on 2025/07/02 17:15
Change comment: There is no comment for this version
To version 3.9
edited by Helena
on 2025/07/02 17:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -321,8 +321,10 @@
321 321  |Registration|RegistrationType|(% style="width:731px" %)Registration provides the details of a matching registration. In addition to the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] and [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] information, the id of the registration must also be provided.
322 322  |(%%)(% style="color:#e74c3c" %)Constraint|ConstraintReferenceType|(% style="width:731px" %)(% style="color:#e74c3c" %)Constraint(%%) provides a reference to a data or metadata (% style="color:#e74c3c" %)constraint(%%) in the registry for the resulting [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (or possibly (% style="color:#e74c3c" %)constraints(%%) base on the registration [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields.
323 323  
324 -**SubmitStructureRequestType:** SubmitStructureRequestType describes the structure of a structure submission. Structural [[components>>doc:sdmx:Glossary.Component.WebHome]] are provided either in-line or referenced via a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained [[components>>doc:sdmx:Glossary.Component.WebHome]], but can be overridden on a per [[component>>doc:sdmx:Glossary.Component.WebHome]] basis.
324 +|
325 325  
326 +**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.
327 +
326 326  Attributes:
327 327  action?, externalDependencies?
328 328  
... ... @@ -329,22 +329,21 @@
329 329  Content:
330 330  (StructureLocation|Structures), SubmittedStructure
331 331  
332 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
334 +Attribute Documentation:
333 333  
334 -(% style="width:1060.29px" %)
335 -|**Name**|**Type**|(% style="width:737px" %)**Documentation**
336 -|action (default: Append)|ActionType|(% style="width:737px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the default action (append-add, replace-update, delete, or no action-informational) to be taken on all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] in either the external [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message or the in-line [[components>>doc:sdmx:Glossary.Component.WebHome]]. 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 (% style="color:#e74c3c" %)version(%%) of a structural object, the object should include the incremented (% style="color:#e74c3c" %)version(%%) number.
337 -|externalDependencies (default: false)|xs:boolean|(% style="width:737px" %)The externalDependencies [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]] to retrieve any externally referenced objects that is used by a non-external object.
336 +|**Name**|**Type**|**Documentation**|
337 +|action (default: Append)|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.|
338 +|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.|
338 338  
339 339  Element Documentation:
340 340  
341 -(% style="width:1080.29px" %)
342 -|**Name**|**Type**|(% style="width:734px" %)**Documentation**
343 -|StructureLocation|xs:anyURI|(% style="width:734px" %)StructureLocation provides the location of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message, external to the repository that can be retrieved by the repository submission service.
344 -|Structures|StructuresType|(% style="width:734px" %)Structures allows for the inline definition of structural [[components>>doc:sdmx:Glossary.Component.WebHome]] for submission.
345 -|SubmittedStructure|SubmittedStructureType|(% style="width:734px" %)SubmittedStructure contains a reference to one of the structural [[maintainable artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] detailed in the external [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message or in-line and provides an override for the default action. This should only be used if the action to be performed on the referenced structural object is different than the default action. For example, one may want to append all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] of a structure message, save one [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. This [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] could be referenced in a submitted structure element and given an action of Informational.
342 +|**Name**|**Type**|**Documentation**|
343 +
344 +|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.|
345 +|Structures|StructuresType|Structures allows for the inline definition of structural components for submission.|
346 +|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure contains a reference to one of the structural maintainable artefacts detailed in the external SDMX-ML Structure message or in-line and provides an override for the default action. This should only be used if the action to be performed on the referenced structural object is different than the default action. For example, one may want to append all structural components of a structure message, save one codelist. This codelist could be referenced in a submitted structure element and given an action of Informational.|
346 346  
347 -**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>>doc:sdmx:Glossary.Attribute.WebHome]] should be populated in order to echo the requested action.
348 +**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.
348 348  
349 349  Attributes:
350 350  action?, externalDependencies?
... ... @@ -352,18 +352,16 @@
352 352  Content:
353 353  MaintainableObject
354 354  
355 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
356 +Attribute Documentation:
356 356  
357 -(% style="width:1017.29px" %)
358 -|**Name**|**Type**|**Documentation**
359 -|action|ActionType|The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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.
360 -|externalDependencies|xs:boolean|The externalDependencies [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be set to true if the repository is expected to use external reference URLs in the structural [[components>>doc:sdmx:Glossary.Component.WebHome]] to retrieve objects on which the referenced object has dependencies. (Thus, if a data structure referenced here is being submitted to the repository, and the structure message has URLs which point to the locations of the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] it uses, then this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be set to true). This should not be provided when this structure is used in a submit structure response.
358 +|**Name**|**Type**|**Documentation**|
359 +|action|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.|
360 +|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 data structure 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.|
361 361  
362 362  Element Documentation:
363 363  
364 -(% style="width:754.294px" %)
365 -|(% style="width:184px" %)**Name**|(% style="width:270px" %)**Type**|(% style="width:297px" %)**Documentation**
366 -|(% style="width:184px" %)MaintainableObject|(% style="width:270px" %)MaintainableUrnReferenceType|(% style="width:297px" %)
364 +|**Name**|**Type**|**Documentation**|
365 +|MaintainableObject|MaintainableUrnRefer enceType| |
367 367  
368 368  **SubmitStructureResponseType:** SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
369 369  
... ... @@ -372,9 +372,8 @@
372 372  
373 373  Element Documentation:
374 374  
375 -(% style="width:920.294px" %)
376 -|(% style="width:156px" %)**Name**|(% style="width:222px" %)**Type**|(% style="width:539px" %)**Documentation**
377 -|(% style="width:156px" %)SubmissionResult|(% style="width:222px" %)SubmissionResultType|(% style="width:539px" %)SubmissionResult provides a status for each submitted structural object.
374 +|**Name**|**Type**|**Documentation**|
375 +|SubmissionResult|SubmissionResultType|SubmissionResult provides a status for each submitted structural object.|
378 378  
379 379  **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.
380 380  
... ... @@ -383,12 +383,11 @@
383 383  
384 384  Element Documentation:
385 385  
386 -(% style="width:1022.29px" %)
387 -|**Name**|(% style="width:201px" %)**Type**|(% style="width:542px" %)**Documentation**
388 -|SubmittedStructure|(% style="width:201px" %)SubmittedStructureType|(% style="width:542px" %)SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
389 -|StatusMessage|(% style="width:201px" %)StatusMessageType|(% style="width:542px" %)StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.
384 +|**Name**|**Type**|**Documentation**|
385 +|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.|
386 +|StatusMessage|StatusMessageType|StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.|
390 390  
391 -**SubmitSubscriptionsRequestType:** SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] are submitted to the registry to subscribe to registration and change events for specific registry resources.
388 +**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.
392 392  
393 393  Content:
394 394  SubscriptionRequest+
... ... @@ -395,11 +395,10 @@
395 395  
396 396  Element Documentation:
397 397  
398 -(% style="width:714.294px" %)
399 -|(% style="width:242px" %)**Name**|(% style="width:223px" %)**Type**|(% style="width:246px" %)**Documentation**
400 -|(% style="width:242px" %)SubscriptionRequest|(% style="width:223px" %)SubscriptionRequestType|(% style="width:246px" %)
395 +|**Name**|**Type**|**Documentation**|
396 +|SubscriptionRequest|SubscriptionRequestT ype| |
401 401  
402 -**SubscriptionType:** SubscriptionType describes the details of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Notification.WebHome]] for the creation of a new [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
398 +**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.
403 403  
404 404  Content:
405 405  Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
... ... @@ -406,37 +406,34 @@
406 406  
407 407  Element Documentation:
408 408  
409 -(% style="width:1056.29px" %)
410 -|**Name**|**Type**|**Documentation**
411 -|Organisation|OrganisationReferenceType|Organisation provides a reference to the organisation that owns this [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. The reference is provided via a URN and/or a complete set of reference fields.
412 -|RegistryURN|xs:anyURI|RegistryURN is used to identify the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the case of deletion or modification. This should be provided in all response messages, unless the response it a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] of the failure to create a newly submitted [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] - in which case there will be no registry assigned URN.
413 -|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
414 -|NotificationHTTP|NotificationURLType|NotificationHTTP holds an http address to which [[notifications>>doc:sdmx:Glossary.Notification.WebHome]] can be addressed as POSTs. Multiple http address may be notified for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] event.
415 -|SubscriberAssignedID|IDType|SubscriberAssignedID allows the subscriber to specify an identification which will be returned as part of the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] for the subscribed events. This should be used if multiple new requests are made, so that the responses can be accurately correlated to the requests.
416 -|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
417 -|EventSelector|EventSelectorType|EventSelector indicates an event or events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
405 +|**Name**|**Type**|**Documentation**|
406 +|Organisation|OrganisationReferenc eType|Organisation provides a reference to the organisation that owns this subscription. The reference is provided via a URN and/or a complete set of reference fields.|
407 +|RegistryURN|xs:anyURI|RegistryURN is used to identify the subscription in the case of deletion or modification. This should be provided in all response messages, unless the response it a notification of the failure to create a newly submitted subscription - in which case there will be no registry assigned URN.|
408 +|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.|
409 +|NotificationHTTP|NotificationURLType|NotificationHTTP holds an http address to which notifications can be addressed as POSTs. Multiple http address may be notified for a single subscription event.|
410 +|SubscriberAssignedID|IDType|SubscriberAssignedID allows the subscriber to specify an identification which will be returned as part of the notification for the subscribed events. This should be used if multiple new requests are made, so that the responses can be accurately correlated to the requests.|
411 +|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.|
412 +|EventSelector|EventSelectorType|EventSelector indicates an event or events for the subscription.|
418 418  
419 -**SubscriptionRequestType:** SubscriptionRequestType describes the structure of a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. It contains [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] details and an action field to indicate the action to be taken on the contained [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. Note that if the action is update or delete, then the registry supplied URN for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] must be included.
414 +**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.
420 420  
421 421  Attributes:
422 422  action
423 423  
424 424  Content:
425 -[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
420 +Subscription
426 426  
427 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
422 +Attribute Documentation:
428 428  
429 -(% style="width:1118.29px" %)
430 -|**Name**|**Type**|(% style="width:753px" %)**Documentation**
431 -|action|ActionType|(% style="width:753px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this is an addition, a modification, or a deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
424 +|**Name**|**Type**|**Documentation**|
425 +|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.|
432 432  
433 433  Element Documentation:
434 434  
435 -(% style="width:1123.29px" %)
436 -|**Name**|**Type**|**Documentation**
437 -|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|SubscriptionType|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] contains the details of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to be added, updated, or deleted.
429 +|**Name**|**Type**|**Documentation**|
430 +|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.|
438 438  
439 -**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] submission. A status is provided for each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the request.
432 +**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.
440 440  
441 441  Content:
442 442  SubscriptionStatus+
... ... @@ -443,11 +443,10 @@
443 443  
444 444  Element Documentation:
445 445  
446 -(% style="width:1129.29px" %)
447 -|**Name**|**Type**|**Documentation**
448 -|SubscriptionStatus|SubscriptionStatusType|SubscriptionStatus contains information which describes the success or failure of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] requests. If a subscriber-assigned identification for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]].
439 +|**Name**|**Type**|**Documentation**|
440 +|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.|
449 449  
450 -**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request.
442 +**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request.
451 451  
452 452  Content:
453 453  SubscriptionURN?, SubscriberAssignedID?, StatusMessage
... ... @@ -454,13 +454,12 @@
454 454  
455 455  Element Documentation:
456 456  
457 -(% style="width:1154.29px" %)
458 -|**Name**|**Type**|(% style="width:676px" %)**Documentation**
459 -|SubscriptionURN|xs:anyURI|(% style="width:676px" %)SubscriptionURN contains the registry generated URN for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and will be returned for any successfully created, updated, or deleted [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
460 -|SubscriberAssignedID|IDType|(% style="width:676px" %)SubscriberAssignedID is the id assigned by the subscriber to the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. If it existed in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, it will be returned.
461 -|StatusMessage|StatusMessageType|(% style="width:676px" %)StatusMessage provides that status for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information.
449 +|**Name**|**Type**|**Documentation**|
450 +|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.|
451 +|SubscriberAssignedID|IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.|
452 +|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.|
462 462  
463 -**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] for a given organisation may be retrieved.
454 +**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
464 464  
465 465  Content:
466 466  Organisation
... ... @@ -467,11 +467,10 @@
467 467  
468 468  Element Documentation:
469 469  
470 -(% style="width:1164.29px" %)
471 -|**Name**|**Type**|**Documentation**
472 -|Organisation|OrganisationReferenceType|Organisation provides a reference to the [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] for which the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] details should be returned.
461 +|**Name**|**Type**|**Documentation**|
462 +|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.|
473 473  
474 -**QuerySubscriptionResponseType:** QuerySubscriptionResponseType describes the structure of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] will be provided.
464 +**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.
475 475  
476 476  Content:
477 477  StatusMessage, Subscription
... ... @@ -478,12 +478,11 @@
478 478  
479 479  Element Documentation:
480 480  
481 -(% style="width:1199.29px" %)
482 -|**Name**|**Type**|(% style="width:683px" %)**Documentation**
483 -|StatusMessage|StatusMessageType|(% style="width:683px" %)StatusMessage provides that status for the query [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information.
484 -|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|SubscriptionType|(% style="width:683px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] contains the details of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] for the organisation. This may occur multiple times for each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
471 +|**Name**|**Type**|**Documentation**|
472 +|StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.|
473 +|Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.|
485 485  
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.
475 +**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.
487 487  
488 488  Content:
489 489  EventTime, (ObjectURN|RegistrationID), SubscriptionURN, EventAction, (StructuralEvent|RegistrationEvent)?
... ... @@ -490,17 +490,16 @@
490 490  
491 491  Element Documentation:
492 492  
493 -(% style="width:1213.29px" %)
494 -|**Name**|**Type**|**Documentation**
495 -|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.
496 -|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.
497 -|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event.
498 -|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that is the cause of this [[notification>>doc:sdmx:Glossary.Notification.WebHome]] being sent.
499 -|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.
500 -|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.
501 -|RegistrationEvent|RegistrationEventType|RegistrationEvent is used to provide the details or the registration object that has changed.
482 +|**Name**|**Type**|**Documentation**|
483 +|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.|
484 +|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 +|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event.|
486 +|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.|
487 +|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.|
488 +|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.|
489 +|RegistrationEvent|RegistrationEventTyp e|RegistrationEvent is used to provide the details or the registration object that has changed.|
502 502  
503 -**NotificationURLType:** NotificationURLType describes the structure of an http or email address. The content holds the addresses while an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether or not is expects the contents in a SOAP message.
491 +**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.
504 504  
505 505  Derivation:
506 506  
... ... @@ -512,13 +512,12 @@
512 512  isSOAP?
513 513  
514 514  Content:
515 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
503 +Attribute Documentation:
516 516  
517 -(% style="width:1068.29px" %)
518 -|**Name**|**Type**|**Documentation**
519 -|isSOAP (default:false)|xs:boolean|The isSOAP [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates the provided URL expects the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] to be sent in a SOAP message.
505 +|**Name**|**Type**|**Documentation**|
506 +|isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.|
520 520  
521 -**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] period.
508 +**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the subscription period.
522 522  
523 523  Content:
524 524  StartDate, EndDate
... ... @@ -525,26 +525,23 @@
525 525  
526 526  Element Documentation:
527 527  
528 -(% style="width:1052.29px" %)
529 -|**Name**|**Type**|**Documentation**
530 -|StartDate|xs:date|StartDate is an inclusive start date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
531 -|EndDate|xs:date|EndDate is an inclusive end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
515 +|**Name**|**Type**|**Documentation**|
516 +|StartDate|xs:date|StartDate is an inclusive start date for the subscription.|
517 +|EndDate|xs:date|EndDate is an inclusive end date for the subscription.|
532 532  
533 -**EventSelectorType:** EventSelectorType describes the details of the events for a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. It allows subscribers to specify registry and repository events for which they wish to receive notifications.
519 +**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.
534 534  
535 535  Content:
536 -
537 537  (StructuralRepositoryEvents|DataRegistrationEvents|MetadataRegistrationEvents)[1..3]
538 538  
539 539  Element Documentation:
540 540  
541 -(% style="width:1053.29px" %)
542 -|(% style="width:275px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:495px" %)**Documentation**
543 -|(% style="width:275px" %)StructuralRepositoryEvents|(% style="width:281px" %)StructuralRepositoryEventsType|(% style="width:495px" %)StructuralRepositoryEvents details structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
544 -|(% style="width:275px" %)DataRegistrationEvents|(% style="width:281px" %)DataRegistrationEventsType|(% style="width:495px" %)DataRegistrationEvents details the data registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
545 -|(% style="width:275px" %)MetadataRegistration Events|(% style="width:281px" %)MetadataRegistrationEventsType|(% style="width:495px" %)MetadataRegistrationEvents details the metadata registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
526 +|**Name**|**Type**|**Documentation**|
527 +|StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.|
528 +|DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.|
529 +|MetadataRegistration Events|MetadataRegistration EventsType|MetadataRegistrationEvents details the metadata registration events for the subscription.|
546 546  
547 -**StructuralRepositoryEventsType:** StructuralRepositoryEventsType details the structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. At least one [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] must be specified, although it may be given a wildcard value (meaning the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is for the structural events of all agencies). This can also be a list of agencies to allow the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] is then refined by detailing the structural objects maintained by the agency for which the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Maintenance agency.WebHome]] 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.
531 +**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.
548 548  
549 549  Attributes:
550 550  TYPE?
... ... @@ -552,42 +552,40 @@
552 552  Content:
553 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)+)
554 554  
555 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
539 +Attribute Documentation:
556 556  
557 -(% style="width:1037.29px" %)
558 -|**Name**|**Type**|**Documentation**
559 -|TYPE (fixed: STRUCTURE)|xs:string|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.
541 +|**Name**|**Type**|**Documentation**|
542 +|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.|
560 560  
561 561  Element Documentation:
562 562  
563 -(% style="width:1038.29px" %)
564 -|**Name**|**Type**|(% style="width:638px" %)**Documentation**
565 -|AgencyID|NestedIDQueryType|(% style="width:638px" %)AgencyID specifies a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] to all events for particular object types. This can occur multiple times to list a of group of [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]], creating event [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] 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.
566 -|AllEvents|EmptyType|(% style="width:638px" %)AllEvents creates a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to structural events for all structural objects maintained by the agencies referenced.
567 -|AgencyScheme|VersionableObjectEventType|(% style="width:638px" %)AgencyScheme is used to subscribe to changes of [[agency schemes>>doc:sdmx:Glossary.Agency scheme.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
568 -|DataConsmerScheme|VersionableObjectEventType|(% style="width:638px" %)DataConsmerScheme is used to subscribe to changes of [[data consumer schemes>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
569 -|DataProviderScheme|VersionableObjectEventType|(% style="width:638px" %)DataProviderScheme is used to subscribe to changes of [[data provider schemes>>doc:sdmx:Glossary.Data provider scheme.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
570 -|OrganisationUnitScheme|VersionableObjectEventType|(% style="width:638px" %)OrganisationUnitScheme is used to subscribe to changes of [[organisation unit schemes>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
571 -|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|VersionableObjectEventType|(% style="width:638px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is used to subscribe to changes of [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
572 -|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|VersionableObjectEventType|(% style="width:638px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] is used to subscribe to changes of [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
573 -|CategoryScheme|VersionableObjectEventType|(% style="width:638px" %)CategoryScheme is used to subscribe to changes of [[category schemes>>doc:sdmx:Glossary.Category scheme.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
574 -|Categorisation|IdentifiableObjectEventType|(% style="width:638px" %)Categorisation is used to subscribe to changes of categorizations. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id field can be selected.
575 -|[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|VersionableObjectEventType|(% style="width:638px" %)[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] is used to subscribe to changes of [[code lists>>doc:sdmx:Glossary.Code list.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
576 -|HierarchicalCodelist|VersionableObjectEventType|(% style="width:638px" %)HierarchicalCodelist is used to subscribe to changes of [[hierarchical code lists>>doc:sdmx:Glossary.Hierarchical code list.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
577 -|ConceptScheme|VersionableObjectEventType|(% style="width:638px" %)ConceptScheme is used to subscribe to changes of [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
578 -|MetadataStructureDefinition|VersionableObjectEventType|(% style="width:638px" %)MetadataStructureDefinition is used to subscribe to changes of [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
579 -|KeyFamily|VersionableObjectEventType|(% style="width:638px" %)KeyFamily is used to subscribe to changes of key families. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
580 -|StructureSet|VersionableObjectEventType|(% style="width:638px" %)StructureSet is used to subscribe to changes of [[structure sets>>doc:sdmx:Glossary.Structure set.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
581 -|ReportingTaxonomy|VersionableObjectEventType|(% style="width:638px" %)ReportingTaxonomy is used to subscribe to changes of reporting taxonomies. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
582 -|Process|VersionableObjectEventType|(% style="width:638px" %)Process is used to subscribe to changes of processes. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
583 -|AttachmentConstraint|VersionableObjectEventType|(% style="width:638px" %)AttachmentConstraint is used to subscribe to changes of attachment (% style="color:#e74c3c" %)constraints(%%). The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
584 -|ContentConstraint|VersionableObjectEventType|(% style="width:638px" %)ContentConstraint is used to subscribe to changes of content (% style="color:#e74c3c" %)constraints(%%). The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
585 -|ProvisionAgreement|VersionableObjectEventType|(% style="width:638px" %)ProvisionAgreement is used to subscribe to changes of a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
586 -|TransformationScheme|VersionableObjectEventType|(% style="width:638px" %)TransformationScheme is used to subscribe to changes of a transformation scheme. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
587 -|NameAliasScheme|VersionableObjectEventType|(% style="width:638px" %)NameAliasScheme is used to subscribe to changes of a name alias scheme. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
588 -|NamePersonalisationScheme|VersionableObjectEventType|(% style="width:638px" %)NamePersonalisationScheme is used to subscribe to changes of a name peronsalisation scheme. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
589 -|RulesetScheme|VersionableObjectEventType|(% style="width:638px" %)RulesetScheme is used to subscribe to changes of a ruleset scheme. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
590 -|UserDefinedOperatorScheme|VersionableObjectEventType|(% style="width:638px" %)UserDefinedOperatorScheme is used to subscribe to changes of a user defined operator scheme. The [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object are those identified in the AgencyID collection, effectively making separate (% style="color:#e74c3c" %)version(%%) of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and (% style="color:#e74c3c" %)version(%%) fields can be selected.
546 +|**Name**|**Type**|**Documentation**|
547 +|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.|
548 +|AllEvents|EmptyType|AllEvents creates a subscription to structural events for all structural objects maintained by the agencies referenced.|
549 +|AgencyScheme|VersionableObjectEve ntType|AgencyScheme is used to subscribe to changes of agency schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
550 +|DataConsmerScheme|VersionableObjectEve ntType|DataConsmerScheme is used to subscribe to changes of data consumer schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
551 +|DataProviderScheme|VersionableObjectEve ntType|DataProviderScheme is used to subscribe to changes of data provider schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
552 +|OrganisationUnitSche me|VersionableObjectEve ntType|OrganisationUnitScheme is used to subscribe to changes of organisation unit schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
553 +|Dataflow|VersionableObjectEve ntType|Dataflow is used to subscribe to changes of data flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
554 +|Metadataflow|VersionableObjectEve ntType|Metadataflow is used to subscribe to changes of metadata flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
555 +|CategoryScheme|VersionableObjectEve ntType|CategoryScheme is used to subscribe to changes of category schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
556 +|Categorisation|IdentifiableObjectEv entType|Categorisation is used to subscribe to changes of categorizations. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id field can be selected.|
557 +|Codelist|VersionableObjectEve ntType|Codelist is used to subscribe to changes of code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
558 +|HierarchicalCodelist|VersionableObjectEve ntType|HierarchicalCodelist is used to subscribe to changes of hierarchical code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
559 +|ConceptScheme|VersionableObjectEve ntType|ConceptScheme is used to subscribe to changes of concept schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
560 +|MetadataStructureDef inition|VersionableObjectEve ntType|MetadataStructureDefinition is used to subscribe to changes of metadata structure definitions. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
561 +|KeyFamily|VersionableObjectEve ntType|KeyFamily is used to subscribe to changes of key families. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
562 +|StructureSet|VersionableObjectEve ntType|StructureSet is used to subscribe to changes of structure sets. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
563 +|ReportingTaxonomy|VersionableObjectEve ntType|ReportingTaxonomy is used to subscribe to changes of reporting taxonomies. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
564 +|Process|VersionableObjectEve ntType|Process is used to subscribe to changes of processes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
565 +|AttachmentConstraint|VersionableObjectEve ntType|AttachmentConstraint is used to subscribe to changes of attachment constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
566 +|ContentConstraint|VersionableObjectEve ntType|ContentConstraint is used to subscribe to changes of content constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
567 +|ProvisionAgreement|VersionableObjectEve ntType|ProvisionAgreement is used to subscribe to changes of a provision agreement. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
568 +|TransformationScheme|VersionableObjectEve ntType|TransformationScheme is used to subscribe to changes of a transformation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
569 +|NameAliasScheme|VersionableObjectEve ntType|NameAliasScheme is used to subscribe to changes of a name alias scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
570 +|NamePersonalisationS cheme|VersionableObjectEve ntType|NamePersonalisationScheme is used to subscribe to changes of a name peronsalisation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
571 +|RulesetScheme|VersionableObjectEve ntType|RulesetScheme is used to subscribe to changes of a ruleset scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
572 +|UserDefinedOperatorS cheme|VersionableObjectEve ntType|UserDefinedOperatorScheme is used to subscribe to changes of a user defined operator scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|
591 591  
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