Skip to Content
Last modified by Elena on 2025/09/10 11:19
From version 3.14
edited by Helena
on 2025/07/02 17:11
Change comment: There is no comment for this version
To version 3.10
edited by Helena
on 2025/07/02 17:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -329,22 +329,21 @@
329 329  Content:
330 330  (StructureLocation|Structures), SubmittedStructure
331 331  
332 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
332 +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.
334 +|**Name**|**Type**|**Documentation**|
335 +|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.|
336 +|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.
340 +|**Name**|**Type**|**Documentation**|
341 +
342 +|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.|
343 +|Structures|StructuresType|Structures allows for the inline definition of structural components for submission.|
344 +|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.
346 +**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:
354 +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.
356 +|**Name**|**Type**|**Documentation**|
357 +|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.|
358 +|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" %)
362 +|**Name**|**Type**|**Documentation**|
363 +|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.
372 +|**Name**|**Type**|**Documentation**|
373 +|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.
382 +|**Name**|**Type**|**Documentation**|
383 +|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.|
384 +|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.
386 +**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" %)
393 +|**Name**|**Type**|**Documentation**|
394 +|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]].
396 +**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]].
403 +|**Name**|**Type**|**Documentation**|
404 +|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.|
405 +|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.|
406 +|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.|
407 +|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.|
408 +|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.|
409 +|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.|
410 +|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.
412 +**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]]
418 +Subscription
426 426  
427 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
420 +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]].
422 +|**Name**|**Type**|**Documentation**|
423 +|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.
427 +|**Name**|**Type**|**Documentation**|
428 +|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.
430 +**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]].
437 +|**Name**|**Type**|**Documentation**|
438 +|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.
440 +**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request.
451 451  
452 452  Content:
453 453  SubscriptionURN?, SubscriberAssignedID?, StatusMessage
... ... @@ -455,11 +455,11 @@
455 455  Element Documentation:
456 456  
457 457  |**Name**|**Type**|**Documentation**|
458 -|SubscriptionURN|xs:anyURI|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]].|
459 -|SubscriberAssignedID|IDType|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.|
460 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information.|
448 +|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.|
449 +|SubscriberAssignedID|IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.|
450 +|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.|
461 461  
462 -**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.
452 +**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
463 463  
464 464  Content:
465 465  Organisation
... ... @@ -467,9 +467,9 @@
467 467  Element Documentation:
468 468  
469 469  |**Name**|**Type**|**Documentation**|
470 -|Organisation|OrganisationReferenc eType|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.|
460 +|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.|
471 471  
472 -**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.
462 +**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.
473 473  
474 474  Content:
475 475  StatusMessage, Subscription