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

Summary

Details

Page properties
Content
... ... @@ -296,32 +296,27 @@
296 296  
297 297  Attribute Documentation:
298 298  
299 -(% style="width:1027.29px" %)
300 -|**Name**|**Type**|(% style="width:793px" %)**Documentation**
301 -|timeSeriesMatch|xs:boolean|(% style="width:793px" %)The timeSeriesMatch [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is true when the result is an exact match with the key found in the registry - that is, when the registered [[data source>>doc:sdmx:Glossary.Data source.WebHome]] provides a matching key. It is set to false when the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is registered with cube-region (% style="color:#e74c3c" %)constraints(%%), or in any other circumstance when it cannot be established that the sought-for keys have been exactly matched. This is always true when the resulting [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is the source of a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
299 +|**Name**|**Type**|**Documentation**|
300 +|timeSeriesMatch|xs:boolean|The timeSeriesMatch attribute is true when the result is an exact match with the key found in the registry - that is, when the registered data source provides a matching key. It is set to false when the data source is registered with cube-region constraints, or in any other circumstance when it cannot be established that the sought-for keys have been exactly matched. This is always true when the resulting data source is the source of a metadata set.|
302 302  
303 303  Element Documentation:
304 304  
305 -(% style="width:709.294px" %)
306 -|(% style="width:159px" %)**Name**|(% style="width:211px" %)**Type**|(% style="width:336px" %)**Documentation**
307 -|(% style="width:159px" %)DataResult|(% style="width:211px" %)ResultType|(% style="width:336px" %)
308 -|(% style="width:159px" %)MetadataResult|(% style="width:211px" %)ResultType|(% style="width:336px" %)
304 +|**Name**|**Type**|**Documentation**|
305 +|DataResult|ResultType| |
306 +|MetadataResult|ResultType| |
309 309  
310 -**ResultType:**
308 +**ResultType:** ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content constraints for the data source may be provided, if the query requested this information.
311 311  
312 -ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content (% style="color:#e74c3c" %)constraints(%%) for the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, if the query requested this information.
313 -
314 314  Content:
315 -Registration, (% style="color:#e74c3c" %)Constraint
311 +Registration, Constraint
316 316  
317 317  Element Documentation:
318 318  
319 -(% style="width:1035.29px" %)
320 -|**Name**|**Type**|(% style="width:731px" %)**Documentation**
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 -|(%%)(% 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.
315 +|**Name**|**Type**|**Documentation**|
316 +|Registration|RegistrationType|Registration provides the details of a matching registration. In addition to the data source and provision agreement information, the id of the registration must also be provided.|
317 +|Constraint|ConstraintReferenceT ype|Constraint provides a reference to a data or metadata constraint in the registry for the resulting data source (or possibly constraints base on the registration provision agreement, data provider, structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields.|
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.
319 +**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.
325 325  
326 326  Attributes:
327 327  action?, externalDependencies?
... ... @@ -329,22 +329,21 @@
329 329  Content:
330 330  (StructureLocation|Structures), SubmittedStructure
331 331  
332 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
327 +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.
329 +|**Name**|**Type**|**Documentation**|
330 +|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.|
331 +|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.
335 +|**Name**|**Type**|**Documentation**|
336 +
337 +|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.|
338 +|Structures|StructuresType|Structures allows for the inline definition of structural components for submission.|
339 +|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.
341 +**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:
349 +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.
351 +|**Name**|**Type**|**Documentation**|
352 +|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.|
353 +|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" %)
357 +|**Name**|**Type**|**Documentation**|
358 +|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.
367 +|**Name**|**Type**|**Documentation**|
368 +|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.
377 +|**Name**|**Type**|**Documentation**|
378 +|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.|
379 +|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.
381 +**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,9 +395,8 @@
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" %)
388 +|**Name**|**Type**|**Documentation**|
389 +|SubscriptionRequest|SubscriptionRequestT ype| |
401 401  
402 402  **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