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

Summary

Details

Page properties
Content
... ... @@ -165,10 +165,11 @@
165 165  
166 166  Attribute Documentation:
167 167  
168 -|**Name**|**Type**|**Documentation**|
169 -|id (default: %)|IDQueryType|The id attribute is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.|
170 -|version (default: \*)|VersionQueryType|The version attribute is used to query for an object based on its version. This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded version will match any version of the object where as a late-bound version will only match the latest version.|
171 -|agencyID (default: %)|NestedIDQueryType|The agencyID attribute is used to query for an object based on its maintenance agency's identifier. This is either an explicit value, or completely wild cared with the "%" value.|
168 +(% style="width:1118.29px" %)
169 +|(% style="width:201px" %)**Name**|(% style="width:127px" %)**Type**|(% style="width:789px" %)**Documentation**
170 +|(% style="width:201px" %)id (default: %)|(% style="width:127px" %)IDQueryType|(% style="width:789px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.
171 +|(% style="width:201px" %)version (default: \*)|(% style="width:127px" %)VersionQueryType|(% style="width:789px" %)The (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its (% style="color:#e74c3c" %)version(%%). This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded (% style="color:#e74c3c" %)version(%%) will match any (% style="color:#e74c3c" %)version(%%) of the object where as a late-bound (% style="color:#e74c3c" %)version(%%) will only match the latest (% style="color:#e74c3c" %)version(%%).
172 +|(% style="width:201px" %)agencyID (default: %)|(% style="width:127px" %)NestedIDQueryType|(% style="width:789px" %)The agencyID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]]'s identifier. This is either an explicit value, or completely wild cared with the "%" value.
172 172  
173 173  **StatusMessageType:** StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.
174 174  
... ... @@ -180,15 +180,17 @@
180 180  
181 181  Attribute Documentation:
182 182  
183 -|**Name**|**Type**|**Documentation**|
184 -|status|StatusType|The status attribute carries the status of the query or request.|
184 +(% style="width:1011.29px" %)
185 +|**Name**|**Type**|**Documentation**
186 +|status|StatusType|The status [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] carries the status of the query or request.
185 185  
186 186  Element Documentation:
187 187  
188 -|**Name**|**Type**|**Documentation**|
189 -|MessageText|StatusMessageType|MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors.|
190 +(% style="width:1011.29px" %)
191 +|**Name**|**Type**|**Documentation**
192 +|MessageText|StatusMessageType|MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors.
190 190  
191 -**SubmitRegistrationsRequestType:** SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/metadata set registrations.
194 +**SubmitRegistrationsRequestType:** SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registrations.
192 192  
193 193  Content:
194 194  RegistrationRequest+
... ... @@ -195,8 +195,9 @@
195 195  
196 196  Element Documentation:
197 197  
198 -|**Name**|**Type**|**Documentation**|
199 -|RegistrationRequest|RegistrationRequestT ype|RegistrationRequest provides the details of a requested registration and the action to take on it. A reference to a provision agreement that exists in the registry must be provide along with a simple and/or queryable data source. The id should only be provided when updating or deleting a registration.|
201 +(% style="width:1012.29px" %)
202 +|**Name**|**Type**|**Documentation**
203 +|RegistrationRequest|RegistrationRequestType|RegistrationRequest provides the details of a requested registration and the action to take on it. A reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that exists in the registry must be provide along with a simple and/or queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The id should only be provided when updating or deleting a registration.
200 200  
201 201  **RegistrationRequestType:** RegistrationRequestType describes the structure of a single registration request. It contains the details of a registation and an action field to indicate the action to be taken on the contained registration.
202 202  
... ... @@ -208,14 +208,15 @@
208 208  
209 209  Attribute Documentation:
210 210  
211 -|**Name**|**Type**|**Documentation**|
212 -|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a registration.|
215 +(% style="width:1008.29px" %)
216 +|**Name**|**Type**|**Documentation**
217 +|action|ActionType|The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this is an addition, a modification, or a deletion of a registration.
213 213  
214 214  Element Documentation:
215 215  
216 -|**Name**|**Type**|**Documentation**|
217 -
218 -|Registration|RegistrationType|Registration contains the details of the data/metadata set registration to be added, updated, or deleted.|
221 +(% style="width:1013.29px" %)
222 +|**Name**|**Type**|**Documentation**
223 +|Registration|RegistrationType|Registration contains the details of the data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registration to be added, updated, or deleted.
219 219  
220 220  **SubmitRegistrationsResponseType:** SubmitRegistrationsResponseType describes the structure of a registration response. For each submitted registration in the request, a registration status is provided. The status elements should be provided in the same order as the submitted registrations, although each status will echo the request to ensure accurate processing of the responses.
221 221  
... ... @@ -224,8 +224,9 @@
224 224  
225 225  Element Documentation:
226 226  
227 -|**Name**|**Type**|**Documentation**|
228 -|RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.|
232 +(% style="width:1023.29px" %)
233 +|**Name**|**Type**|**Documentation**
234 +|RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.
229 229  
230 230  **RegistrationStatusType:** RegistrationStatusType describes the structure of a registration status.
231 231  
... ... @@ -234,11 +234,12 @@
234 234  
235 235  Element Documentation:
236 236  
237 -|**Name**|**Type**|**Documentation**|
238 -|Registration|RegistrationType|Registration, at the very least echoes the submitted registration. It the request was to create a new registration and it was successful, an id must be supplied.|
239 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration request, and if necessary, any error or warning information.|
243 +(% style="width:1005.29px" %)
244 +|**Name**|**Type**|(% style="width:578px" %)**Documentation**
245 +|Registration|RegistrationType|(% style="width:578px" %)Registration, at the very least echoes the submitted registration. It the request was to create a new registration and it was successful, an id must be supplied.
246 +|StatusMessage|StatusMessageType|(% style="width:578px" %)StatusMessage provides that status for the registration request, and if necessary, any error or warning information.
240 240  
241 -**QueryRegistrationRequestType:** QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, reference metadata, or both) must be specified. It is possible to query for registrations for a particular provision agreement, data provider, or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing constraints in the form of explicit time periods, constraint regions, and key sets. When constraint regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.
248 +**QueryRegistrationRequestType:** QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]], or both) must be specified. It is possible to query for registrations for a particular [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing (% style="color:#e74c3c" %)constraints(%%) in the form of explicit [[time periods>>doc:sdmx:Glossary.Time period.WebHome]], (% style="color:#e74c3c" %)constraint(%%) regions, and key sets. When (% style="color:#e74c3c" %)constraint(%%) regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.
242 242  
243 243  Attributes:
244 244  returnConstraints?
... ... @@ -248,22 +248,24 @@
248 248  
249 249  Attribute Documentation:
250 250  
251 -|**Name**|**Type**|**Documentation**|
252 -|returnConstraints (default: false)|xs:boolean|The returnConstraints attribute determines whether information about the constraints on the data or metadata sets returned should also be sent the results.|
258 +(% style="width:1004.29px" %)
259 +|**Name**|**Type**|**Documentation**
260 +|returnConstraints (default: false)|xs:boolean|The returnConstraints [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] determines whether information about the (% style="color:#e74c3c" %)constraints(%%) on the data or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] returned should also be sent the results.
253 253  
254 254  Element Documentation:
255 255  
256 -|**Name**|**Type**|**Documentation**|
257 -|QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for.|
258 -|All|EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned.|
259 -|ProvisionAgreement|ProvisionAgreementRe ferenceType|ProvisionAgreement provides a reference to a provision agreement in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.|
260 -|DataProvider|DataProviderReferenc eType|DataProvider provides a reference to a data provider in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.|
261 -|Dataflow|DataflowReferenceTyp e|Dataflow provides a reference to a data flow in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.|
262 -|Metadataflow|MetadataflowReferenc eType|Metadataflow provides a reference to a metadata flow in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields|
263 -|ReferencePeriod|ReferencePeriodType|ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.|
264 -|DataKeySet|DataKeySetType|DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.|
265 -|CubeRegion|CubeRegionType|CubeRegion is used to provide sets of include or excluded values for dimensions when querying for data.|
266 -|MetadataTargetRegion|MetadataTargetRegion Type|MetadataTargetRegion is used to provide sets of included or excluded values for identifier components when querying for metadata.|
264 +(% style="width:1056.29px" %)
265 +|**Name**|**Type**|**Documentation**
266 +|QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for.
267 +|All|EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned.
268 +|ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreement provides a reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.
269 +|DataProvider|DataProviderReferenceType|DataProvider provides a reference to a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.
270 +|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|DataflowReferenceType|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] provides a reference to a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.
271 +|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|MetadataflowReferenceType|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] provides a reference to a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields
272 +|ReferencePeriod|ReferencePeriodType|ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.
273 +|DataKeySet|DataKeySetType|DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.
274 +|CubeRegion|CubeRegionType|CubeRegion is used to provide sets of include or excluded values for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] when querying for data.
275 +|MetadataTargetRegion|MetadataTargetRegionType|MetadataTargetRegion is used to provide sets of included or excluded values for identifier [[components>>doc:sdmx:Glossary.Component.WebHome]] when querying for metadata.
267 267  
268 268  **QueryRegistrationResponseType:** QueryRegistrationResponseType describes the structure of a registration query response. It provides a status for the request, and if successful, the resulting data and/or metadata results.
269 269  
... ... @@ -272,11 +272,12 @@
272 272  
273 273  Element Documentation:
274 274  
275 -|**Name**|**Type**|**Documentation**|
276 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.|
277 -|QueryResult|QueryResultType|QueryResult contains a result for a successful registration query. It can occur multiple times, for each registration the meets the conditions specified in the query.|
284 +(% style="width:1034.29px" %)
285 +|**Name**|**Type**|**Documentation**
286 +|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.
287 +|QueryResult|QueryResultType|QueryResult contains a result for a successful registration query. It can occur multiple times, for each registration the meets the conditions specified in the query.
278 278  
279 -**QueryResultType:** QueryResultType describes the structure of a query result for a single data source. Either a data result or metadata result is detailed, depending on the data source.
289 +**QueryResultType:** QueryResultType describes the structure of a query result for a single [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. Either a data result or metadata result is detailed, depending on the [[data source>>doc:sdmx:Glossary.Data source.WebHome]].
280 280  
281 281  Attributes:
282 282  timeSeriesMatch
... ... @@ -286,27 +286,32 @@
286 286  
287 287  Attribute Documentation:
288 288  
289 -|**Name**|**Type**|**Documentation**|
290 -|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.|
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]].
291 291  
292 292  Element Documentation:
293 293  
294 -|**Name**|**Type**|**Documentation**|
295 -|DataResult|ResultType| |
296 -|MetadataResult|ResultType| |
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" %)
297 297  
298 -**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.
310 +**ResultType:**
299 299  
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 +
300 300  Content:
301 -Registration, Constraint
315 +Registration, (% style="color:#e74c3c" %)Constraint
302 302  
303 303  Element Documentation:
304 304  
305 -|**Name**|**Type**|**Documentation**|
306 -|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.|
307 -|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.|
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.
308 308  
309 -**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.
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.
310 310  
311 311  Attributes:
312 312  action?, externalDependencies?
... ... @@ -314,21 +314,22 @@
314 314  Content:
315 315  (StructureLocation|Structures), SubmittedStructure
316 316  
317 -Attribute Documentation:
332 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
318 318  
319 -|**Name**|**Type**|**Documentation**|
320 -|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.|
321 -|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.|
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.
322 322  
323 323  Element Documentation:
324 324  
325 -|**Name**|**Type**|**Documentation**|
326 -
327 -|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.|
328 -|Structures|StructuresType|Structures allows for the inline definition of structural components for submission.|
329 -|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.|
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.
330 330  
331 -**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.
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.
332 332  
333 333  Attributes:
334 334  action?, externalDependencies?
... ... @@ -336,16 +336,18 @@
336 336  Content:
337 337  MaintainableObject
338 338  
339 -Attribute Documentation:
355 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
340 340  
341 -|**Name**|**Type**|**Documentation**|
342 -|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.|
343 -|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.|
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.
344 344  
345 345  Element Documentation:
346 346  
347 -|**Name**|**Type**|**Documentation**|
348 -|MaintainableObject|MaintainableUrnRefer enceType| |
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" %)
349 349  
350 350  **SubmitStructureResponseType:** SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
351 351  
... ... @@ -354,8 +354,9 @@
354 354  
355 355  Element Documentation:
356 356  
357 -|**Name**|**Type**|**Documentation**|
358 -|SubmissionResult|SubmissionResultType|SubmissionResult provides a status for each submitted structural object.|
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.
359 359  
360 360  **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.
361 361  
... ... @@ -364,11 +364,12 @@
364 364  
365 365  Element Documentation:
366 366  
367 -|**Name**|**Type**|**Documentation**|
368 -|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.|
369 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.|
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.
370 370  
371 -**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.
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.
372 372  
373 373  Content:
374 374  SubscriptionRequest+
... ... @@ -375,10 +375,11 @@
375 375  
376 376  Element Documentation:
377 377  
378 -|**Name**|**Type**|**Documentation**|
379 -|SubscriptionRequest|SubscriptionRequestT ype| |
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" %)
380 380  
381 -**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.
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]].
382 382  
383 383  Content:
384 384  Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
... ... @@ -385,34 +385,37 @@
385 385  
386 386  Element Documentation:
387 387  
388 -|**Name**|**Type**|**Documentation**|
389 -|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.|
390 -|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.|
391 -|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.|
392 -|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.|
393 -|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.|
394 -|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.|
395 -|EventSelector|EventSelectorType|EventSelector indicates an event or events for the subscription.|
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]].
396 396  
397 -**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.
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.
398 398  
399 399  Attributes:
400 400  action
401 401  
402 402  Content:
403 -Subscription
425 +[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
404 404  
405 -Attribute Documentation:
427 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
406 406  
407 -|**Name**|**Type**|**Documentation**|
408 -|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.|
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]].
409 409  
410 410  Element Documentation:
411 411  
412 -|**Name**|**Type**|**Documentation**|
413 -|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.|
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.
414 414  
415 -**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.
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.
416 416  
417 417  Content:
418 418  SubscriptionStatus+
... ... @@ -419,10 +419,11 @@
419 419  
420 420  Element Documentation:
421 421  
422 -|**Name**|**Type**|**Documentation**|
423 -|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.|
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]].
424 424  
425 -**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request.
450 +**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request.
426 426  
427 427  Content:
428 428  SubscriptionURN?, SubscriberAssignedID?, StatusMessage
... ... @@ -430,11 +430,11 @@
430 430  Element Documentation:
431 431  
432 432  |**Name**|**Type**|**Documentation**|
433 -|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.|
434 -|SubscriberAssignedID|IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.|
435 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.|
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.|
436 436  
437 -**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
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.
438 438  
439 439  Content:
440 440  Organisation
... ... @@ -442,9 +442,9 @@
442 442  Element Documentation:
443 443  
444 444  |**Name**|**Type**|**Documentation**|
445 -|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.|
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.|
446 446  
447 -**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.
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.
448 448  
449 449  Content:
450 450  StatusMessage, Subscription