Version 8.1 by Helena on 2025/07/03 11:02

Hide last authors
Helena 3.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1 Introduction =
6
7 The registry schemas have been updated to reflect the various changes in the standard and to introduce new constructs for managing [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. In addtion, the constructs that had existed for querying [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] have been removed as this is now handled by the query messages.
8
9 As was done with the query, the registry message set now contains distinct messages for each operation. The messages will eventually allow the registry to function in more standard web service mannter.
10
11 = 2 Schema Documentation =
12
13 == 2.1 Registry Namespace ==
14
15 http://www.sdmx.org/resources/sdmxml/schemas/v3_1/registry
16
17 === 2.1.1 Summary ===
18
19 Referenced Namespaces:
20
21 |**Namespace**|**Prefix**|
22 |http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|
23 |http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure|structure|
24 |http://www.w3.org/2001/XMLSchema|xs|
25
26 Contents:
27 39 Complex Types
28 5 Simple Types
29
30 === 2.1.2 Complex Types ===
31
Helena 3.3 32 **RegistrationType:** Registration provides the information needed for data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] set registration. A [[data source>>doc:sdmx:Glossary.Data source.WebHome]] must be supplied here if not already provided in the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]. The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] must be associated with a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]], or a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] definition. If possible, the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] should be specified. Only in cases where this is not possible should the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] be used.
Helena 3.2 33
Helena 3.3 34 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 3.2 35 id?, validFrom?, validTo?, lastUpdated?, indexTimeSeries?, indexDataSet?, indexAttributes?, indexReportingPeriod?
36
37 Content:
38 ProvisionAgreement, Datasource
39
Helena 3.3 40 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 41
Helena 3.4 42 (% style="width:1107.29px" %)
43 |**Name**|**Type**|**Documentation**
44 |id|IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a registry assigned identification for the registration. This must be provided in a response message (unless an error occurred while submitting a new registration), and should be included when updating or deleting a registration.
45 |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides an inclusive start date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.
46 |validTo|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides an inclusive end date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.
47 |lastUpdated|xs:dateTime|The lastUpdated [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a timestamp for the last time the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] was updated.
48 |indexTimeSeries (default: false)|xs:boolean|The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data. The default value is false, and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will always be assumed false when the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] references a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]].
49 |indexDataSet (default: false)|xs:boolean|The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] (as indicated in the set's structure definition). The default value is false.
50 |indexAttributes (default: false)|xs:boolean|The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or the presence of the metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] (as indicated in the set's structure definition). The default value is false.
51 |indexReportingPeriod (default: false)|xs:boolean|The indexReportingPeriod, if true, indicates that the registry must index the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] ranges for which data is present for the [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The default value is false, and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will always be assumed false when the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] references a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]].
Helena 3.2 52
53 Element Documentation:
54
Helena 3.4 55 (% style="width:1118.29px" %)
56 |**Name**|**Type**|**Documentation**
57 |ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreement provides a reference to the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that the data is being registered against.
58 |Datasource|DataSourceType|Datasource identifies the [[data source>>doc:sdmx:Glossary.Data source.WebHome]](s) where the registered data can be retrieved.
Helena 3.2 59
Helena 3.3 60 **DataSourceType:** DataSourceType specifies the properties of a data or metadata source. Either a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]], a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]], or both must be specified.
Helena 3.2 61
62 Content:
Helena 5.1 63 (SimpleDataSource | QueryableDataSource) [1..2]
Helena 3.2 64
65 Element Documentation:
66
Helena 3.5 67 (% style="width:1038.29px" %)
68 |**Name**|(% style="width:221px" %)**Type**|(% style="width:536px" %)**Documentation**
69 |SimpleDataSource|(% style="width:221px" %)xs:anyURI|(% style="width:536px" %)SimpleDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that is an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data or metadata message. It requires only the URL of the data.
70 |QueryableDataSource|(% style="width:221px" %)QueryableDataSourceType|(% style="width:536px" %)QueryableDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that can be queried using the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] REST interfaces.
Helena 3.2 71
Helena 3.3 72 **SimpleDataSourceType:** SimpleDataSourceType describes a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The URL of the data is contained in the content.
Helena 3.2 73
74 Derivation:
75
Helena 3.20 76 > xs:anySimpleType (restriction)
77 > xs:anyURI (extension)
78 > SimpleDataSourceType
Helena 3.2 79
80 Attributes:
81 TYPE?
82
83 Content:
Helena 3.5 84 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 85
Helena 3.5 86 (% style="width:1046.29px" %)
87 |**Name**|**Type**|**Documentation**
88 |TYPE (fixed: SIMPLE)|xs:string|TYPE is a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is used to ensure only one simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, when it is referenced in a uniqueness (% style="color:#e74c3c" %)constraint(%%).
Helena 3.2 89
Helena 3.5 90 **QueryableDataSourceType:** QueryableDataSourceType describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]], and add a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for ensuring only one queryable source can be provided.
Helena 3.2 91
92 Derivation:
93
94 QueryableDataSourceType (extension)
95 QueryableDataSourceType
96
97 Attributes:
98 isRESTDatasource, isWebServiceDatasource, TYPE?
99
100 Content:
101 DataURL, WSDLURL?, WADLURL?
102
Helena 3.5 103 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 104
Helena 3.5 105 (% style="width:1084.29px" %)
106 |**Name**|**Type**|**Documentation**
107 |isRESTDatasource|xs:boolean|The isRESTDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates, if true, that the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is accessible via the REST protocol.
108 |isWebServiceDatasource|xs:boolean|The isWebServiceDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates, if true, that the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is accessible via Web Services protocols.
109 |TYPE (fixed: QUERY)|xs:string|TYPE is a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is used to ensure only one queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, when it is referenced in a uniqueness (% style="color:#e74c3c" %)constraint(%%).
Helena 3.2 110
111 Element Documentation:
112
113 |**Name**|**Type**|**Documentation**|
Helena 3.5 114 |DataURL|xs:anyURI|DataURL contains the URL of the [[data source>>doc:sdmx:Glossary.Data source.WebHome]].|
115 |WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].|
116 |WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].|
Helena 3.2 117
118 **IdentifiableQueryType:** IdentifiableQueryType describes the structure of a query for an identifiable object.
119
120 Attributes:
121 id?
122
123 Content:
124 {Empty}
125
Helena 3.5 126 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 127
Helena 3.5 128 (% style="width:1040.29px" %)
129 |**Name**|**Type**|**Documentation**
130 |id (default:%)|IDQueryType|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.
Helena 3.2 131
132 **VersionableQueryType:** VersionableQueryType describes the structure of a query for a versionable object.
133
134 Derivation:
135
136 IdentifiableQueryType (extension)
137 VersionableQueryType
138
139 Attributes:
140 id?, version?
141
142 Content:
143 {Empty}
144
145 Attribute Documentation:
146
Helena 3.6 147 (% style="width:1070.29px" %)
148 |**Name**|**Type**|(% style="width:775px" %)**Documentation**
149 |id (default: %)|IDQueryType|(% style="width:775px" %)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.
150 |version (default:\*)|VersionQueryType|(% style="width:775px" %)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(%%).
Helena 3.2 151
152 **MaintainableQueryType:** MaintainableQueryType describes the structure of a query for a maintainable object.
153
154 Derivation:
155
156 IdentifiableQueryType (extension)
157 VersionableQueryType (extension)
158 MaintainableQueryType
159
160 Attributes:
161 id?, version?, agencyID?
162
163 Content:
164 {Empty}
165
166 Attribute Documentation:
167
Helena 3.7 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.
Helena 3.2 173
174 **StatusMessageType:** StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.
175
176 Attributes:
177 status
178
179 Content:
180 MessageText
181
182 Attribute Documentation:
183
Helena 3.7 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.
Helena 3.2 187
188 Element Documentation:
189
Helena 3.7 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.
Helena 3.2 193
Helena 3.7 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.
Helena 3.2 195
196 Content:
197 RegistrationRequest+
198
199 Element Documentation:
200
Helena 3.7 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.
Helena 3.2 204
205 **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.
206
207 Attributes:
208 action
209
210 Content:
211 Registration
212
213 Attribute Documentation:
214
Helena 3.7 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.
Helena 3.2 218
219 Element Documentation:
220
Helena 3.7 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.
Helena 3.2 224
225 **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.
226
227 Content:
228 RegistrationStatus+
229
230 Element Documentation:
231
Helena 3.7 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.
Helena 3.2 235
236 **RegistrationStatusType:** RegistrationStatusType describes the structure of a registration status.
237
238 Content:
239 Registration, StatusMessage
240
241 Element Documentation:
242
Helena 3.7 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.
Helena 3.2 247
Helena 3.7 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.
Helena 3.2 249
250 Attributes:
251 returnConstraints?
252
253 Content:
Helena 5.1 254 QueryType, (All | ProvisionAgreement | DataProvider | Dataflow | Metadataflow), ReferencePeriod?, (DataKeySet | CubeRegion | MetadataTargetRegion)
Helena 3.2 255
256 Attribute Documentation:
257
Helena 3.7 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.
Helena 3.2 261
262 Element Documentation:
263
Helena 3.7 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.
Helena 3.2 276
277 **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.
278
279 Content:
280 StatusMessage, QueryResult
281
282 Element Documentation:
283
Helena 3.8 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.
Helena 3.2 288
Helena 3.8 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]].
Helena 3.2 290
291 Attributes:
292 timeSeriesMatch
293
294 Content:
Helena 5.1 295 (DataResult | MetadataResult)
Helena 3.2 296
297 Attribute Documentation:
298
Helena 3.9 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]].
Helena 3.2 302
303 Element Documentation:
304
Helena 3.9 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" %)
Helena 3.2 309
Helena 3.9 310 **ResultType:**
Helena 3.2 311
Helena 3.9 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
Helena 3.2 314 Content:
Helena 3.9 315 Registration, (% style="color:#e74c3c" %)Constraint
Helena 3.2 316
317 Element Documentation:
318
Helena 3.9 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.
Helena 3.2 323
Helena 3.10 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.
Helena 3.9 325
Helena 3.2 326 Attributes:
327 action?, externalDependencies?
328
329 Content:
Helena 5.1 330 (StructureLocation | Structures), SubmittedStructure
Helena 3.2 331
Helena 3.12 332 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 333
Helena 3.12 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.
Helena 3.2 338
339 Element Documentation:
340
Helena 3.12 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.
Helena 3.2 346
Helena 3.12 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.
Helena 3.2 348
349 Attributes:
350 action?, externalDependencies?
351
352 Content:
353 MaintainableObject
354
Helena 3.12 355 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 356
Helena 3.12 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.
Helena 3.2 361
362 Element Documentation:
363
Helena 3.12 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" %)
Helena 3.2 367
368 **SubmitStructureResponseType:** SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
369
370 Content:
371 SubmissionResult+
372
373 Element Documentation:
374
Helena 3.12 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.
Helena 3.2 378
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
381 Content:
382 SubmittedStructure, StatusMessage
383
384 Element Documentation:
385
Helena 3.12 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.
Helena 3.2 390
Helena 3.12 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.
Helena 3.2 392
393 Content:
394 SubscriptionRequest+
395
396 Element Documentation:
397
Helena 3.12 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" %)
Helena 3.2 401
Helena 3.13 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]].
Helena 3.2 403
404 Content:
405 Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
406
407 Element Documentation:
408
Helena 3.13 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]].
Helena 3.2 418
Helena 3.13 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.
Helena 3.2 420
421 Attributes:
422 action
423
424 Content:
Helena 3.13 425 [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
Helena 3.2 426
Helena 3.13 427 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 428
Helena 3.14 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]].
Helena 3.2 432
433 Element Documentation:
434
Helena 3.14 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.
Helena 3.2 438
Helena 3.14 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.
Helena 3.2 440
441 Content:
442 SubscriptionStatus+
443
444 Element Documentation:
445
Helena 3.14 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]].
Helena 3.2 449
Helena 3.14 450 **SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request.
Helena 3.2 451
452 Content:
453 SubscriptionURN?, SubscriberAssignedID?, StatusMessage
454
455 Element Documentation:
456
Helena 3.15 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.
Helena 3.2 462
Helena 3.14 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.
Helena 3.2 464
465 Content:
466 Organisation
467
468 Element Documentation:
469
Helena 3.15 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.
Helena 3.2 473
Helena 3.14 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.
Helena 3.2 475
476 Content:
477 StatusMessage, Subscription
478
479 Element Documentation:
480
Helena 3.15 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]].
Helena 3.2 485
Helena 3.15 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.
Helena 3.2 487
488 Content:
Helena 5.1 489 EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?
Helena 3.2 490
491 Element Documentation:
492
Helena 3.15 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.
Helena 3.2 502
Helena 3.15 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.
Helena 3.2 504
505 Derivation:
506
507 xs:anySimpleType (restriction)
508 xs:anyURI (extension)
509 NotificationURLType
510
511 Attributes:
512 isSOAP?
513
514 Content:
Helena 3.15 515 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 516
Helena 3.15 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.
Helena 3.2 520
Helena 3.15 521 **ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] period.
Helena 3.2 522
523 Content:
524 StartDate, EndDate
525
526 Element Documentation:
527
Helena 3.15 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]].
Helena 3.2 532
Helena 3.15 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.
Helena 3.2 534
535 Content:
Helena 3.15 536
Helena 5.1 537 (Structura l RepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents) [1..3]
Helena 3.2 538
539 Element Documentation:
540
Helena 3.15 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]].
Helena 3.2 546
Helena 3.15 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.
Helena 3.2 548
549 Attributes:
550 TYPE?
551
552 Content:
Helena 4.2 553 AgencyID+, (AllEvents|(AgencyScheme | DataConsmerScheme | DataProviderScheme | OrganisationUnitScheme | Dataflow | Metadataflow | CategoryScheme | Categorisation | Codelist | Hierarchica l Codelist | ConceptScheme | MetadataStructureDefinition | KeyFamily | StructureSet | ReportingTaxonomy | Process | AttachmentConstraint | ContentConstraint | ProvisionAgreement | TransformationScheme | NameAliasScheme | NamePersonalisationScheme | RulesetScheme | UserDefinedOperatorScheme)+)
Helena 3.2 554
Helena 3.16 555 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 556
Helena 3.16 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.
Helena 3.2 560
561 Element Documentation:
562
Helena 3.16 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.
Helena 3.2 591
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
594 Content:
Helena 4.2 595 (All | URN | ID)
Helena 3.2 596
597 Element Documentation:
598
Helena 3.17 599 (% style="width:1024.29px" %)
600 |**Name**|**Type**|(% style="width:815px" %)**Documentation**
601 |All|EmptyType|(% style="width:815px" %)All subscribes to the events all instances of the containing object meeting the other criteria specified.
602 |URN|xs:anyURI|(% style="width:815px" %)URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
603 |ID|IDQueryType|(% style="width:815px" %)ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object. The default value is the wildcard character("%").
Helena 3.2 604
605 **VersionableObjectEventType:** VersionableObjectEventType describes the structure of a reference to a versionable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
606
607 Content:
Helena 4.2 608 (All|URN | (ID, Version))
Helena 3.2 609
610 Element Documentation:
611
Helena 3.17 612 (% style="width:1041.29px" %)
613 |**Name**|**Type**|(% style="width:819px" %)**Documentation**
614 |All|EmptyType|(% style="width:819px" %)All subscribes to the events all instances of the containing object meeting the other criteria specified.
615 |URN|xs:anyURI|(% style="width:819px" %)URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
616 |ID|IDQueryType|(% style="width:819px" %)ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object and the value provided in the (% style="color:#e74c3c" %)version(%%) field matches the (% style="color:#e74c3c" %)version(%%) of the object. The default value is the wildcard character("%").
617 |Version|VersionQueryType|(% style="width:819px" %)(% style="color:#e74c3c" %)Version(%%) subscribes to the events of the specific instance of the object type where the value provided in the id field matches the id of the object and the value here matches the (% style="color:#e74c3c" %)version(%%) of the object. The default value is the wildcard character("%"). Note that in addition to being wild-carded, this can also be bound to the latest (% style="color:#e74c3c" %)version(%%) of the object with the late-bound character("\*").
Helena 3.2 618
Helena 3.18 619 **DataRegistrationEventsType:** DataRegistrationEventsType details the data registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. It is possible to subscribe to all data registration events in the repository, or specific events for; single registrations, [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]], [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]], key families, and [[categories>>doc:sdmx:Glossary.Category.WebHome]] that categorize [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] or key families.
Helena 3.2 620
621 Attributes:
622 TYPE?
623
624 Content:
Helena 4.2 625 (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference |[[Category>>doc:sdmx:Glossary.Category.WebHome]])+)
Helena 3.2 626
Helena 3.18 627 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 628
Helena 3.18 629 (% style="width:1029.29px" %)
630 |**Name**|**Type**|(% style="width:638px" %)**Documentation**
631 |TYPE (fixed: DATA)|xs:string|(% style="width:638px" %)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 (% style="color:#e74c3c" %)constraint(%%).
Helena 3.2 632
633 Element Documentation:
634
Helena 3.18 635 (% style="width:1052.29px" %)
636 |**Name**|**Type**|(% style="width:592px" %)**Documentation**
637 |AllEvents|EmptyType|(% style="width:592px" %)AllEvents subscribes to all data registration events in the repository.
638 |RegistrationID|IDType|(% style="width:592px" %)RegistrationID subscribes to all the data registration events for the unique registration referenced.
639 |ProvisionAgreement|ProvisionAgreementReferenceType|(% style="width:592px" %)ProvisionAgreementReference subscribes to all data registration events for the explicitly referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
640 |DataProvider|DataProviderReferenceType|(% style="width:592px" %)DataProviderReference subscribes to all data registration events for the explicitly referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]].
641 |DataflowReference|MaintainableEventType|(% style="width:592px" %)DataflowReference subscribes to all data registration events for the [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] referenced by this object. This may reference one or more [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]], as the specific references fields allow for a wild-carded value.
642 |KeyFamilyReference|MaintainableEventType|(% style="width:592px" %)KeyFamilyReference subscribes to all data registration events for the key families referenced by this object. This may reference one or more key families, as the specific references fields allow for a wild-carded value.
643 |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|CategoryReferenceType|(% style="width:592px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]] subscribes to all data registration events for any [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] or key families that are categorized by the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]].
Helena 3.2 644
Helena 3.18 645 **MetadataRegistrationEventsType:** MetadataRegistrationEventsType details the metadata registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. It is possible to subscribe to all metadata registration events in the repository, or specific events for; single registrations, [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]], [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], and [[categories>>doc:sdmx:Glossary.Category.WebHome]] that categorize [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] or [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
Helena 3.2 646
647 Attributes:
648 TYPE?
649
650 Content:
Helena 3.22 651 (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | Category)+)
Helena 3.2 652
Helena 3.19 653 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 654
Helena 3.19 655 (% style="width:1016.29px" %)
656 |**Name**|**Type**|(% style="width:569px" %)**Documentation**
657 |TYPE (fixed: METADATA)|xs:string|(% style="width:569px" %)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.
Helena 3.2 658
659 Element Documentation:
660
Helena 3.19 661 (% style="width:1020.29px" %)
662 |**Name**|**Type**|**Documentation**
663 |AllEvents|EmptyType|AllEvents subscribes to all metadata registration events in the repository.
664 |RegistrationID|IDType|RegistrationID subscribes to all the metadata registration events for the unique registration referenced.
665 |ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreementReference subscribes to all metadata registration events for the explicitly referenced provision agreement.
666 |DataProvider|DataProviderReferenceType|DataProvider subscribes to all metadata registration events for the explicitly referenced data provider.
667 |MetadataflowReference|MaintainableEventType|MetadataflowReference subscribes to all metadata registration events for the [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] referenced by this object. This may reference one or more [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]], as the specific references fields allow for a wild-carded value.
668 |MetadataStructureDefinitionReference|MaintainableEventType|MetadataStructureDefinitionReference subscribes to all metadata registration events for the [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] referenced by this object. This may reference one or more [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], as the specific references fields allow for a wild-carded value.
669 |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|CategoryReferenceType|[[Category>>doc:sdmx:Glossary.Category.WebHome]] subscribes to all metadata registration events for any [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] or [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] that are categorized by the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]].
Helena 3.2 670
671 **MaintainableEventType:** MaintainableEventType provides a reference to a maintainable object's event with either the URN of the specific object, or a set of potentially wild-carded reference fields.
672
673 Content:
Helena 5.1 674 (URN | Ref)
Helena 3.2 675
676 Element Documentation:
677
Helena 3.20 678 (% style="width:1049.29px" %)
679 |**Name**|**Type**|**Documentation**
680 |URN|xs:anyURI|URN provides an explicit reference to a single object.
681 |Ref|MaintainableQueryType|Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.
Helena 3.2 682
683 **StructuralEventType:** StructuralEventType provides the details of a structure event, specifically the object that changed.
684
685 Content:
686 Structures
687
688 Element Documentation:
689
Helena 3.20 690 (% style="width:1083.29px" %)
691 |**Name**|**Type**|**Documentation**
692 |Structures|StructuresType|Structures contains the details of the structural object that has triggered the event. Although this container allows for multiple structural object, it should only contain the one changed object.
Helena 3.2 693
694 **RegistrationEventType:** This provides the details of a data or metadata registration event for the purposes of notification.
695
696 Content:
697 Registration
698
699 Element Documentation:
700
Helena 3.20 701 (% style="width:1106.29px" %)
702 |**Name**|**Type**|**Documentation**
703 |Registration|RegistrationType|Registration provides the changed details of the data or metadata registration.
Helena 3.2 704
705 === 2.1.3 Simple Types ===
706
707 **IDQueryType:** IDQueryType is a simple type that allows for an identifier to be substituted with a wild card character ("%").
708
709 Union of:
710 IDType, WildCardValueType.
711
712 **NestedIDQueryType:** NestedIDQueryType is a simple type that allows for a nested identifier to be substituted with a wild card character ("%").
713
714 Union of:
715 NestedIDType, WildCardValueType.
716
Helena 3.20 717 **VersionQueryType:** VersionQueryType is a simple type that allows for a (% style="color:#e74c3c" %)version(%%) number to be substituted with a wild card character ("%") or a late bound character ("\*").
Helena 3.2 718
719 Union of:
720 LegacyVersionNumberType, SemanticVersionNumberType, SemanticVersionReferenceType, WildcardType, WildCardValueType.
721
722 **StatusType:** StatusType provides an enumeration of values that detail the status of queries or requests.
723
724 Derived by restriction of xs:NMTOKEN.
725
726 Enumerations:
727
Helena 3.20 728 (% style="width:1013.29px" %)
729 |**Value**|**Documentation**
730 |Success|Query or request successful.
731 |Warning|Query or request successful, but with warnings.
732 |Failure|Query or request not successful.
Helena 3.2 733
734 **QueryTypeType:** QueryType provides an enumeration of values which specify the objects in the result-set for a registry query.
735
736 Derived by restriction of xs:NMTOKEN.
737
738 Enumerations:
739
Helena 3.20 740 (% style="width:1023.29px" %)
741 |**Value**|(% style="width:630px" %)**Documentation**
742 |[[DataSets>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:630px" %)Only references [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] should be returned.
743 |MetadataSets|(% style="width:630px" %)Only references to [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] should be returned.
744 |AllSets|(% style="width:630px" %)References to both [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] should be returned.
745
746 |