Wiki source code of Part VI. Registry

Version 9.1 by Helena on 2025/07/03 14:54

Hide last authors
Helena 2.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1. Introduction =
6
Helena 6.1 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.
Helena 2.2 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 =
Helena 3.2 12
Helena 2.2 13 == 2.1 Registry Namespace ==
14
15 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/registry**
16
17 === 2.1.1 Summary ===
18
19 Referenced Namespaces:
Helena 3.2 20
Helena 4.1 21 (% style="width:706.294px" %)
22 |(% style="width:505px" %)**Namespace**|(% style="width:198px" %)**Prefix**
23 |(% style="width:505px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:198px" %)com
24 |(% style="width:505px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|(% style="width:198px" %)str
25 |(% style="width:505px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:198px" %)xs
Helena 2.2 26
27 Contents:
28 39 Complex Types
29 5 Simple Types
30
31 === 2.1.2 Complex Types ===
32
Helena 6.1 33 **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 2.2 34
Helena 6.1 35 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 36 id?, validFrom?, validTo?, lastUpdated?, indexTimeSeries?, indexDataSet?, indexAttributes?, indexReportingPeriod?
37
38 Content:
39 ProvisionAgreement, Datasource
40
Helena 6.1 41 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 42
Helena 4.1 43 (% style="width:927.294px" %)
44 |(% style="width:165px" %)**Name**|(% style="width:202px" %)**Type**|(% style="width:558px" %)**Documentation**
Helena 6.1 45 |(% style="width:165px" %)id|(% style="width:202px" %)com:IDType|(% style="width:558px" %)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.
46 |(% style="width:165px" %)validFrom|(% style="width:202px" %)xs:dateTime|(% style="width:558px" %)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.
47 |(% style="width:165px" %)validTo|(% style="width:202px" %)xs:dateTime|(% style="width:558px" %)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.
48 |(% style="width:165px" %)lastUpdated|(% style="width:202px" %)xs:dateTime|(% style="width:558px" %)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.
49 |(% style="width:165px" %)indexTimeSeries (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)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]].
50 |(% style="width:165px" %)indexDataSet (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)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.
51 |(% style="width:165px" %)indexAttributes (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)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.
52 |(% style="width:165px" %)indexReportingPeriod (default: false)|(% style="width:202px" %)xs:boolean|(% style="width:558px" %)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 2.2 53
54 Element Documentation:
Helena 3.2 55
Helena 4.1 56 (% style="width:952.294px" %)
57 |(% style="width:176px" %)**Name**|(% style="width:329px" %)**Type**|(% style="width:444px" %)**Documentation**
Helena 6.1 58 |(% style="width:176px" %)ProvisionAgreement|(% style="width:329px" %)com: ProvisionAgreementReferenceType|(% style="width:444px" %)ProvisionAgreement provides a reference to the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that the data is being registered against.
59 |(% style="width:176px" %)Datasource|(% style="width:329px" %)DataSourceType|(% style="width:444px" %)Datasource identifies the [[data source>>doc:sdmx:Glossary.Data source.WebHome]](s) where the registered data can be retrieved.
Helena 2.2 60
Helena 6.1 61 **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 2.2 62
63 Content:
64 (SimpleDataSource | QueryableDataSource)[1..2]
65
66 Element Documentation:
Helena 3.2 67
Helena 4.1 68 (% style="width:979.294px" %)
69 |(% style="width:192px" %)**Name**|(% style="width:226px" %)**Type**|(% style="width:558px" %)**Documentation**
Helena 6.1 70 |(% style="width:192px" %)SimpleDataSource|(% style="width:226px" %)xs:anyURI|(% style="width:558px" %)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.
71 |(% style="width:192px" %)QueryableDataSource|(% style="width:226px" %)QueryableDataSourceType|(% style="width:558px" %)QueryableDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that must be able to accept an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Query Message, and respond appropriately.
Helena 2.2 72
Helena 6.1 73 **SimpleDataSourceType: **SimpleDataSourceType describes a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The URL of the data is contained in the content.
Helena 2.2 74
75 Derivation:
Helena 3.2 76
Helena 2.2 77 * xs:anySimpleType (restriction)
78 ** xs:anyURI (extension)
79 *** SimpleDataSourceType
80
Helena 6.1 81 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 82 TYPE?
83
84 Content:
Helena 6.1 85 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 2.2 86
Helena 4.1 87 (% style="width:1015.29px" %)
88 |(% style="width:199px" %)**Name**|(% style="width:139px" %)**Type**|(% style="width:675px" %)**Documentation**
Helena 6.1 89 |(% style="width:199px" %)TYPE (fixed: SIMPLE)|(% style="width:139px" %)xs:string|(% style="width:675px" %)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 2.2 90
Helena 6.1 91 **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 2.2 92
93 Derivation:
Helena 3.2 94
Helena 2.2 95 * com:QueryableDataSourceType (extension)
96 ** QueryableDataSourceType
97
Helena 6.1 98 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 99 isRESTDatasource, isWebServiceDatasource, TYPE?
100
101 Content:
102 com:DataURL, com:WSDLURL?, com:WADLURL?
103
Helena 6.1 104 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 105
Helena 4.1 106 (% style="width:1027.29px" %)
107 |(% style="width:227px" %)**Name**|(% style="width:223px" %)**Type**|(% style="width:574px" %)**Documentation**
Helena 6.1 108 |(% style="width:227px" %)isRESTDatasource|(% style="width:223px" %)xs:boolean|(% style="width:574px" %)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.
109 |(% style="width:227px" %)isWebServiceDatasource|(% style="width:223px" %)xs:boolean|(% style="width:574px" %)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.
110 |(% style="width:227px" %)TYPE (fixed: QUERY)|(% style="width:223px" %)xs:string|(% style="width:574px" %)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 2.2 111
112 Element Documentation:
Helena 3.2 113
Helena 4.1 114 (% style="width:1034.29px" %)
115 |**Name**|**Type**|(% style="width:644px" %)**Documentation**
Helena 6.1 116 |com:DataURL|xs:anyURI|(% style="width:644px" %)DataURL contains the URL of the [[data source>>doc:sdmx:Glossary.Data source.WebHome]].
117 |com:WSDLURL|xs:anyURI|(% style="width:644px" %)WSDLURL provides the location of a WSDL instance on the internet which describes the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].
118 |com:WADLURL|xs:anyURI|(% style="width:644px" %)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 2.2 119
120 **IdentifiableQueryType: **IdentifiableQueryType describes the structure of a query for an identifiable object.
121
Helena 6.1 122 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 123 id?
124
125 Content:
126 {Empty}
127
Helena 6.1 128 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 129
Helena 4.1 130 (% style="width:973.294px" %)
131 |**Name**|**Type**|(% style="width:593px" %)**Documentation**
Helena 6.1 132 |id (default: %)|IDQueryType|(% style="width:593px" %)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 2.2 133
134 **VersionableQueryType: **VersionableQueryType describes the structure of a query for a versionable object.
135
136 Derivation:
Helena 3.2 137
Helena 2.2 138 * IdentifiableQueryType (extension)
139 ** VersionableQueryType
140
Helena 6.1 141 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
142 id?, (% style="color:#e74c3c" %)version(%%)?
Helena 2.2 143
144 Content:
145 {Empty}
146
Helena 6.1 147 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 148
Helena 4.1 149 (% style="width:999.294px" %)
150 |(% style="width:161px" %)**Name**|(% style="width:132px" %)**Type**|(% style="width:704px" %)**Documentation**
Helena 6.1 151 |(% style="width:161px" %)id (default: %)|(% style="width:132px" %)IDQueryType|(% style="width:704px" %)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.
152 |(% style="width:161px" %)(% style="color:#e74c3c" %)version(%%) (default: *)|(% style="width:132px" %)VersionQueryType|(% style="width:704px" %)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 2.2 153
154 **MaintainableQueryType: **MaintainableQueryType describes the structure of a query for a maintainable object.
155
156 Derivation:
Helena 3.2 157
Helena 2.3 158 * IdentifiableQueryType (extension)
159 ** VersionableQueryType (extension)
160 *** MaintainableQueryType
Helena 2.2 161
Helena 6.1 162 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
163 id?, (% style="color:#e74c3c" %)version(%%)?, agencyID?
Helena 2.2 164
165 Content:
166 {Empty}
167
Helena 6.1 168 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 169
Helena 4.1 170 (% style="width:1012.29px" %)
171 |(% style="width:190px" %)**Name**|(% style="width:136px" %)**Type**|(% style="width:657px" %)**Documentation**
Helena 6.1 172 |(% style="width:190px" %)id (default: %)|(% style="width:136px" %)IDQueryType|(% style="width:657px" %)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.
173 |(% style="width:190px" %)(% style="color:#e74c3c" %)version(%%) (default: *)|(% style="width:136px" %)VersionQueryType|(% style="width:657px" %)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(%%).
174 |(% style="width:190px" %)agencyID (default: %)|(% style="width:136px" %)NestedIDQueryType|(% style="width:657px" %)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 2.2 175
176 **StatusMessageType: **StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.
177
Helena 6.1 178 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 179 status
180
181 Content:
182 MessageText*
183
Helena 6.1 184 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 185
Helena 4.1 186 (% style="width:995.294px" %)
187 |**Name**|(% style="width:123px" %)**Type**|(% style="width:661px" %)**Documentation**
Helena 6.1 188 |status|(% style="width:123px" %)StatusType|(% style="width:661px" %)The status [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] carries the status of the query or request.
Helena 2.2 189
190 Element Documentation:
Helena 3.2 191
Helena 4.1 192 (% style="width:1006.29px" %)
193 |**Name**|**Type**|(% style="width:543px" %)**Documentation**
194 |MessageText|com: StatusMessageType|(% style="width:543px" %)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 2.2 195
Helena 6.1 196 **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 2.2 197
198 Content:
199 RegistrationRequest+
200
201 Element Documentation:
Helena 3.2 202
Helena 4.1 203 (% style="width:1015.29px" %)
204 |**Name**|**Type**|(% style="width:653px" %)**Documentation**
Helena 6.1 205 |RegistrationRequest|RegistrationRequestType|(% style="width:653px" %)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 2.2 206
207 **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.
208
Helena 6.1 209 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 210 action
211
212 Content:
213 Registration
214
Helena 6.1 215 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 216
Helena 4.1 217 (% style="width:1012.29px" %)
218 |**Name**|(% style="width:176px" %)**Type**|(% style="width:697px" %)**Documentation**
Helena 6.1 219 |action|(% style="width:176px" %)com:ActionType|(% style="width:697px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this is an addition, a modification, or a deletion of a registration.
Helena 2.2 220
221 Element Documentation:
Helena 3.2 222
Helena 4.1 223 (% style="width:1019.29px" %)
224 |**Name**|(% style="width:163px" %)**Type**|(% style="width:637px" %)**Documentation**
Helena 6.1 225 |Registration|(% style="width:163px" %)RegistrationType|(% style="width:637px" %)Registration contains the details of the data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registration to be added, updated, or deleted.
Helena 2.2 226
227 **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.
228
229 Content:
230 RegistrationStatus+
231
232 Element Documentation:
Helena 3.2 233
Helena 4.1 234 (% style="width:1012.29px" %)
235 |**Name**|**Type**|(% style="width:545px" %)**Documentation**
236 |RegistrationStatus|RegistrationStatusType|(% style="width:545px" %)RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.
Helena 2.2 237
238 **RegistrationStatusType: **RegistrationStatusType describes the structure of a registration status.
239
240 Content:
241 Registration, StatusMessage
242
243 Element Documentation:
Helena 3.2 244
Helena 4.1 245 (% style="width:1005.29px" %)
246 |**Name**|(% style="width:168px" %)**Type**|(% style="width:648px" %)**Documentation**
247 |Registration|(% style="width:168px" %)RegistrationType|(% style="width:648px" %)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.
248 |StatusMessage|(% style="width:168px" %)StatusMessageType|(% style="width:648px" %)StatusMessage provides that status for the registration request, and if necessary, any error or warning information.
Helena 2.2 249
Helena 6.1 250 **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 2.2 251
Helena 6.1 252 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 253 returnConstraints?
254
255 Content:
Helena 6.1 256 QueryType, (All | ProvisionAgreement | DataProvider | [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] | [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]), ReferencePeriod?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
Helena 2.2 257
Helena 6.1 258 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 259
Helena 4.1 260 (% style="width:1016.29px" %)
261 |(% style="width:252px" %)**Name**|(% style="width:148px" %)**Type**|(% style="width:614px" %)**Documentation**
Helena 6.1 262 |(% style="width:252px" %)returnConstraints (default: false)|(% style="width:148px" %)xs:boolean|(% style="width:614px" %)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 2.2 263
264 Element Documentation:
Helena 3.2 265
Helena 4.1 266 (% style="width:1021.29px" %)
267 |**Name**|(% style="width:274px" %)**Type**|(% style="width:566px" %)**Documentation**
268 |QueryType|(% style="width:274px" %)QueryTypeType|(% style="width:566px" %)QueryType defines the type of sets (data, metadata, or both) that are being queried for.
269 |All|(% style="width:274px" %)com:EmptyType|(% style="width:566px" %)All indicates that all registrations meeting the other criteria of the query should be returned.
Helena 6.1 270 |ProvisionAgreement|(% style="width:274px" %)com: ProvisionAgreementRe ferenceType|(% style="width:566px" %)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.
271 |DataProvider|(% style="width:274px" %)com: DataProviderReferenceType|(% style="width:566px" %)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.
272 |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:274px" %)com: DataflowReferenceType|(% style="width:566px" %)[[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.
273 |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|(% style="width:274px" %)com: MetadataflowReferenceType|(% style="width:566px" %)[[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
Helena 4.1 274 |ReferencePeriod|(% style="width:274px" %)com: ReferencePeriodType|(% style="width:566px" %)ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.
275 |DataKeySet|(% style="width:274px" %)str:DataKeySetType|(% style="width:566px" %)DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.
276 |MetadataKeySet|(% style="width:274px" %)str: MetadataKeySetType|(% style="width:566px" %)MetadataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.
Helena 6.1 277 |CubeRegion|(% style="width:274px" %)com:CubeRegionType|(% style="width:566px" %)CubeRegion is used to provide sets of include or excluded values for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] when querying for data.
278 |MetadataTargetRegion|(% style="width:274px" %)com: MetadataTargetRegionType|(% style="width:566px" %)MetadataTargetRegion is used to provide sets of included or excluded values for identifier [[components>>doc:sdmx:Glossary.Component.WebHome]] when querying for metadata.
Helena 2.2 279
280 **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.
281
282 Content:
283 StatusMessage, QueryResult*
284
285 Element Documentation:
Helena 3.2 286
Helena 4.1 287 (% style="width:1027.29px" %)
288 |**Name**|**Type**|(% style="width:607px" %)**Documentation**
289 |StatusMessage|StatusMessageType|(% style="width:607px" %)StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.
290 |QueryResult|QueryResultType|(% style="width:607px" %)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 2.2 291
Helena 6.1 292 **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 2.2 293
Helena 6.1 294 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 295 timeSeriesMatch
296
297 Content:
298 (DataResult | MetadataResult)
299
Helena 6.1 300 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 301
Helena 4.1 302 (% style="width:1025.29px" %)
303 |**Name**|**Type**|(% style="width:791px" %)**Documentation**
Helena 6.1 304 |timeSeriesMatch|xs:boolean|(% style="width:791px" %)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 2.2 305
306 Element Documentation:
Helena 3.2 307
Helena 4.1 308 (% style="width:1024.29px" %)
309 |(% style="width:221px" %)**Name**|(% style="width:174px" %)**Type**|(% style="width:626px" %)**Documentation**
310 |(% style="width:221px" %)DataResult|(% style="width:174px" %)ResultType|(% style="width:626px" %)
311 |(% style="width:221px" %)MetadataResult|(% style="width:174px" %)ResultType|(% style="width:626px" %)
Helena 2.2 312
Helena 6.1 313 **ResultType: **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.
Helena 2.2 314
315 Content:
316 Registration, ContentConstraint*
317
318 Element Documentation:
Helena 3.2 319
Helena 4.1 320 (% style="width:1026.29px" %)
321 |**Name**|**Type**|(% style="width:593px" %)**Documentation**
Helena 6.1 322 |Registration|RegistrationType|(% style="width:593px" %)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.
323 |ContentConstraint|com: ContentConstraintReferenceType|(% style="width:593px" %)ContentConstraint provides a reference to a content (% 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 2.2 324
Helena 6.1 325 **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 2.2 326
Helena 6.1 327 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 328 action?, externalDependencies?
329
330 Content:
331 (StructureLocation | str:Structures), SubmittedStructure*
332
Helena 6.1 333 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 334
Helena 4.1 335 (% style="width:1018.29px" %)
336 |**Name**|**Type**|(% style="width:661px" %)**Documentation**
Helena 6.1 337 |action (default: Append)|com:ActionType|(% style="width:661px" %)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.
338 |externalDependencies (default: false)|xs:boolean|(% style="width:661px" %)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 2.2 339
340 Element Documentation:
Helena 3.2 341
Helena 4.1 342 (% style="width:1015.29px" %)
343 |**Name**|**Type**|(% style="width:677px" %)**Documentation**
Helena 6.1 344 |StructureLocation|xs:anyURI|(% style="width:677px" %)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.
345 |str:Structures|str:StructuresType|(% style="width:677px" %)Structures allows for the inline definition of structural [[components>>doc:sdmx:Glossary.Component.WebHome]] for submission.
346 |SubmittedStructure|SubmittedStructureType|(% style="width:677px" %)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 2.2 347
Helena 6.1 348 **SubmittedStructureType: **SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be populated in order to echo the requested action.
Helena 2.2 349
Helena 6.1 350 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 351 action?, externalDependencies?
352
353 Content:
354 MaintainableObject
355
Helena 6.1 356 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 357
Helena 4.1 358 (% style="width:1024.29px" %)
359 |**Name**|**Type**|(% style="width:714px" %)**Documentation**
Helena 6.1 360 |action|com:ActionType|(% style="width:714px" %)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.
361 |externalDependencies|xs:boolean|(% style="width:714px" %)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 key family 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 2.2 362
363 Element Documentation:
Helena 3.2 364
Helena 4.1 365 (% style="width:1024.29px" %)
366 |(% style="width:308px" %)**Name**|(% style="width:264px" %)**Type**|(% style="width:449px" %)**Documentation**
367 |(% style="width:308px" %)MaintainableObject|(% style="width:264px" %)com: MaintainableReferenceType|(% style="width:449px" %)
Helena 2.2 368
369 **SubmitStructureResponseType: **SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
370
371 Content:
372 SubmissionResult+
373
374 Element Documentation:
Helena 3.2 375
Helena 4.1 376 (% style="width:1024.29px" %)
377 |(% style="width:290px" %)**Name**|(% style="width:279px" %)**Type**|(% style="width:452px" %)**Documentation**
378 |(% style="width:290px" %)SubmissionResult|(% style="width:279px" %)SubmissionResultType|(% style="width:452px" %)SubmissionResult provides a status for each submitted structural object.
Helena 2.2 379
380 **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.
381
382 Content:
383 SubmittedStructure, StatusMessage
384
385 Element Documentation:
Helena 3.2 386
Helena 4.1 387 (% style="width:1043.29px" %)
388 |(% style="width:208px" %)**Name**|(% style="width:231px" %)**Type**|(% style="width:601px" %)**Documentation**
389 |(% style="width:208px" %)SubmittedStructure|(% style="width:231px" %)SubmittedStructureType|(% style="width:601px" %)SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
390 |(% style="width:208px" %)StatusMessage|(% style="width:231px" %)StatusMessageType|(% style="width:601px" %)StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.
Helena 2.2 391
Helena 6.1 392 **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 2.2 393
394 Content:
395 SubscriptionRequest+
396
397 Element Documentation:
Helena 3.2 398
Helena 4.1 399 (% style="width:1043.29px" %)
400 |(% style="width:189px" %)**Name**|(% style="width:241px" %)**Type**|(% style="width:610px" %)**Documentation**
401 |(% style="width:189px" %)SubscriptionRequest|(% style="width:241px" %)SubscriptionRequestType|(% style="width:610px" %)
Helena 2.2 402
Helena 6.1 403 **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 2.2 404
405 Content:
406 Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
407
408 Element Documentation:
409
Helena 4.1 410 (% style="width:996.294px" %)
411 |**Name**|**Type**|(% style="width:570px" %)**Documentation**
Helena 6.1 412 |Organisation|com: OrganisationReferenceType|(% style="width:570px" %)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.
413 |RegistryURN|xs:anyURI|(% style="width:570px" %)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.
414 |NotificationMailTo|NotificationURLType|(% style="width:570px" %)NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
415 |NotificationHTTP|NotificationURLType|(% style="width:570px" %)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.
416 |SubscriberAssignedID|com:IDType|(% style="width:570px" %)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.
417 |ValidityPeriod|ValidityPeriodType|(% style="width:570px" %)Validity period sets a start and end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
418 |EventSelector|EventSelectorType|(% style="width:570px" %)EventSelector indicates an event or events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
Helena 2.2 419
Helena 6.1 420 **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 2.2 421
Helena 6.1 422 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 423 action
424
425 Content:
Helena 6.1 426 [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
Helena 2.2 427
Helena 6.1 428 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 429
Helena 4.1 430 (% style="width:1007.29px" %)
431 |**Name**|(% style="width:153px" %)**Type**|(% style="width:715px" %)**Documentation**
Helena 6.1 432 |action|(% style="width:153px" %)com:ActionType|(% style="width:715px" %)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 2.2 433
434 Element Documentation:
Helena 3.2 435
Helena 4.1 436 (% style="width:1002.29px" %)
437 |(% style="width:161px" %)**Name**|(% style="width:166px" %)**Type**|(% style="width:672px" %)**Documentation**
Helena 6.1 438 |(% style="width:161px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|(% style="width:166px" %)SubscriptionType|(% style="width:672px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] contains the details of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to be added, updated, or deleted.
Helena 2.2 439
Helena 6.1 440 **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 2.2 441
442 Content:
443 SubscriptionStatus+
444
445 Element Documentation:
Helena 3.2 446
Helena 4.1 447 (% style="width:1001.29px" %)
448 |**Name**|**Type**|(% style="width:662px" %)**Documentation**
Helena 6.1 449 |SubscriptionStatus|SubscriptionStatusType|(% style="width:662px" %)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 2.2 450
Helena 6.1 451 **SubscriptionStatusType: **SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request.
Helena 2.2 452
453 Content:
454 SubscriptionURN?, SubscriberAssignedID?, StatusMessage
455
456 Element Documentation:
Helena 3.2 457
Helena 4.1 458 (% style="width:1007.29px" %)
459 |(% style="width:191px" %)**Name**|(% style="width:168px" %)**Type**|(% style="width:645px" %)**Documentation**
Helena 6.1 460 |(% style="width:191px" %)SubscriptionURN|(% style="width:168px" %)xs:anyURI|(% style="width:645px" %)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]].
461 |(% style="width:191px" %)SubscriberAssignedID|(% style="width:168px" %)com:IDType|(% style="width:645px" %)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.
462 |(% style="width:191px" %)StatusMessage|(% style="width:168px" %)StatusMessageType|(% style="width:645px" %)StatusMessage provides that status for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information.
Helena 2.2 463
Helena 6.1 464 **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 2.2 465
466 Content:
467 Organisation
468
469 Element Documentation:
Helena 3.2 470
Helena 4.1 471 (% style="width:1008.29px" %)
472 |**Name**|(% style="width:258px" %)**Type**|(% style="width:551px" %)**Documentation**
Helena 6.1 473 |Organisation|(% style="width:258px" %)com: OrganisationReferenceType|(% style="width:551px" %)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 2.2 474
Helena 6.1 475 **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 2.2 476
477 Content:
Helena 6.1 478 StatusMessage, [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]*
Helena 2.2 479
480 Element Documentation:
Helena 3.2 481
Helena 4.1 482 (% style="width:1018.29px" %)
483 |(% style="width:164px" %)**Name**|(% style="width:178px" %)**Type**|(% style="width:673px" %)**Documentation**
Helena 6.1 484 |(% style="width:164px" %)StatusMessage|(% style="width:178px" %)StatusMessageType|(% style="width:673px" %)StatusMessage provides that status for the query [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information.
485 |(% style="width:164px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|(% style="width:178px" %)SubscriptionType|(% style="width:673px" %)[[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 2.2 486
Helena 6.1 487 **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 2.2 488
489 Content:
490 EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?
491
492 Element Documentation:
Helena 3.2 493
Helena 4.1 494 (% style="width:1003.29px" %)
495 |**Name**|(% style="width:179px" %)**Type**|(% style="width:632px" %)**Documentation**
496 |EventTime|(% style="width:179px" %)xs:dateTime|(% style="width:632px" %)EventTime specifies the time of the triggering event.
497 |ObjectURN|(% style="width:179px" %)xs:anyURI|(% style="width:632px" %)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.
498 |RegistrationID|(% style="width:179px" %)com:IDType|(% style="width:632px" %)RegistrationID provides the id of the registration that underwent an event.
Helena 6.1 499 |SubscriptionURN|(% style="width:179px" %)xs:anyURI|(% style="width:632px" %)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.
Helena 4.1 500 |EventAction|(% style="width:179px" %)com:ActionType|(% style="width:632px" %)EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.
501 |StructuralEvent|(% style="width:179px" %)StructuralEventType|(% style="width:632px" %)StructuralEvent is used to provide the details of the structural object that has changed.
502 |RegistrationEvent|(% style="width:179px" %)RegistrationEventType|(% style="width:632px" %)RegistrationEvent is used to provide the details or the registration object that has changed.
Helena 2.2 503
Helena 6.1 504 **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 2.2 505
506 Derivation:
Helena 3.2 507
Helena 2.3 508 * xs:anySimpleType (restriction)
509 ** xs:anyURI (extension)
510 *** NotificationURLType
Helena 2.2 511
Helena 6.1 512 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 513 isSOAP?
514
515 Content:
516
Helena 6.1 517 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 518
Helena 4.1 519 (% style="width:998.294px" %)
520 |(% style="width:208px" %)**Name**|(% style="width:107px" %)**Type**|(% style="width:680px" %)**Documentation**
Helena 6.1 521 |(% style="width:208px" %)isSOAP (default: false)|(% style="width:107px" %)xs:boolean|(% style="width:680px" %)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 2.2 522
Helena 6.1 523 **ValidityPeriodType: **ValidityPeriodType specifies inclusive start and end-dates for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] period.
Helena 2.2 524
525 Content:
526 StartDate, EndDate
527
528 Element Documentation:
Helena 3.2 529
Helena 4.1 530 (% style="width:1000.29px" %)
531 |(% style="width:152px" %)**Name**|(% style="width:166px" %)**Type**|(% style="width:679px" %)**Documentation**
Helena 6.1 532 |(% style="width:152px" %)StartDate|(% style="width:166px" %)xs:date|(% style="width:679px" %)StartDate is an inclusive start date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
533 |(% style="width:152px" %)EndDate|(% style="width:166px" %)xs:date|(% style="width:679px" %)EndDate is an inclusive end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
Helena 2.2 534
Helena 6.1 535 **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>>doc:sdmx:Glossary.Notification.WebHome]].
Helena 2.2 536
537 Content:
538 (StructuralRepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents)[1..3]
539
540 Element Documentation:
Helena 3.2 541
Helena 4.1 542 (% style="width:1004.29px" %)
543 |(% style="width:260px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:459px" %)**Documentation**
Helena 6.1 544 |(% style="width:260px" %)StructuralRepository Events|(% style="width:281px" %)StructuralRepositoryEventsType|(% style="width:459px" %)StructuralRepositoryEvents details structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
545 |(% style="width:260px" %)DataRegistrationEven ts|(% style="width:281px" %)DataRegistrationEventsType|(% style="width:459px" %)DataRegistrationEvents details the data registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
546 |(% style="width:260px" %)MetadataRegistration Events|(% style="width:281px" %)MetadataRegistrationEventsType|(% style="width:459px" %)MetadataRegistrationEvents details the metadata registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
Helena 2.2 547
Helena 6.1 548 **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 2.2 549
Helena 6.1 550 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 551 TYPE?
552
553 Content:
Helena 6.1 554 AgencyID+, (AllEvents | (AgencyScheme | DataConsmerScheme | DataProviderScheme | OrganisationUnitScheme | [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] | [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] | CategoryScheme | Categorisation | [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] | HierarchicalCodelist | ConceptScheme | MetadataStructureDefinition | KeyFamily | StructureSet | ReportingTaxonomy | Process | AttachmentConstraint | ContentConstraint | ProvisionAgreement | TransformationScheme | NameAliasScheme | NamePersonalisationScheme | RulesetScheme | UserDefinedOperatorScheme)+)
Helena 2.2 555
Helena 6.1 556 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 557
Helena 4.1 558 (% style="width:1013.29px" %)
559 |(% style="width:244px" %)**Name**|(% style="width:218px" %)**Type**|(% style="width:547px" %)**Documentation**
Helena 6.1 560 |(% style="width:244px" %)TYPE (fixed: STRUCTURE)|(% style="width:218px" %)xs:string|(% style="width:547px" %)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 2.2 561
562 Element Documentation:
Helena 3.2 563
Helena 4.1 564 (% style="width:1007.29px" %)
565 |**Name**|**Type**|(% style="width:580px" %)**Documentation**
Helena 6.1 566 |AgencyID|NestedIDQueryType|(% style="width:580px" %)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.
567 |AllEvents|com:EmptyType|(% style="width:580px" %)AllEvents creates a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to structural events for all structural objects maintained by the agencies referenced.
568 |AgencyScheme|VersionableObjectEventType|(% style="width:580px" %)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.
569 |DataConsmerScheme|VersionableObjectEventType|(% style="width:580px" %)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.
570 |DataProviderScheme|VersionableObjectEventType|(% style="width:580px" %)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.
571 |OrganisationUnitSche me|VersionableObjectEventType|(% style="width:580px" %)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.
572 |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|VersionableObjectEventType|(% style="width:580px" %)[[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.
573 |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|VersionableObjectEventType|(% style="width:580px" %)[[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.
574 |CategoryScheme|VersionableObjectEventType|(% style="width:580px" %)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.
575 |Categorisation|IdentifiableObjectEv entType|(% style="width:580px" %)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.
576 |[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|VersionableObjectEventType|(% style="width:580px" %)[[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.
577 |HierarchicalCodelist|VersionableObjectEventType|(% style="width:580px" %)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.
578 |ConceptScheme|VersionableObjectEventType|(% style="width:580px" %)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.
579 |MetadataStructureDef inition|VersionableObjectEventType|(% style="width:580px" %)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.
580 |KeyFamily|VersionableObjectEventType|(% style="width:580px" %)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.
581 |StructureSet|VersionableObjectEventType|(% style="width:580px" %)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.
582 |ReportingTaxonomy|VersionableObjectEventType|(% style="width:580px" %)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.
583 |Process|VersionableObjectEventType|(% style="width:580px" %)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.
584 |AttachmentConstraint|VersionableObjectEventType|(% style="width:580px" %)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.
585 |ContentConstraint|VersionableObjectEventType|(% style="width:580px" %)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.
586 |ProvisionAgreement|VersionableObjectEventType|(% style="width:580px" %)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.
587 |TransformationScheme|VersionableObjectEventType|(% style="width:580px" %)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.
588 |NameAliasScheme|VersionableObjectEventType|(% style="width:580px" %)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.
589 |NamePersonalisationS cheme|VersionableObjectEventType|(% style="width:580px" %)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.
590 |RulesetScheme|VersionableObjectEventType|(% style="width:580px" %)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.
591 |UserDefinedOperatorS cheme|VersionableObjectEventType|(% style="width:580px" %)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 2.2 592
593 **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.
594
595 Content:
596 (All | URN | ID)
597
598 Element Documentation:
Helena 3.2 599
Helena 4.1 600 (% style="width:1004.29px" %)
601 |**Name**|**Type**|(% style="width:774px" %)**Documentation**
602 |All|com:EmptyType|(% style="width:774px" %)All subscribes to the events all instances of the containing object meeting the other criteria specified.
603 |URN|xs:anyURI|(% style="width:774px" %)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.
604 |ID|IDQueryType|(% style="width:774px" %)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 2.2 605
606 **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.
607
608 Content:
Helena 6.1 609 (All | URN | (ID, (% style="color:#e74c3c" %)Version(%%)))
Helena 2.2 610
611 Element Documentation:
Helena 3.2 612
Helena 4.1 613 (% style="width:997.294px" %)
614 |**Name**|**Type**|(% style="width:775px" %)**Documentation**
615 |All|com:EmptyType|(% style="width:775px" %)All subscribes to the events all instances of the containing object meeting the other criteria specified.
616 |URN|xs:anyURI|(% style="width:775px" %)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.
Helena 6.1 617 |ID|IDQueryType|(% style="width:775px" %)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("%").
618 |(%%)(% style="color:#e74c3c" %)Version|VersionQueryType|(% style="width:775px" %)(% 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 2.2 619
Helena 6.1 620 **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 2.2 621
Helena 6.1 622 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 623 TYPE?
624
625 Content:
Helena 6.1 626 (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference | [[Category>>doc:sdmx:Glossary.Category.WebHome]])+)
Helena 2.2 627
Helena 6.1 628 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 629
Helena 4.1 630 (% style="width:1012.29px" %)
631 |**Name**|**Type**|(% style="width:621px" %)**Documentation**
Helena 6.1 632 |TYPE (fixed: DATA)|xs:string|(% style="width:621px" %)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 2.2 633
634 Element Documentation:
Helena 3.2 635
Helena 4.1 636 (% style="width:1019.29px" %)
637 |**Name**|**Type**|(% style="width:521px" %)**Documentation**
638 |AllEvents|com:EmptyType|(% style="width:521px" %)AllEvents subscribes to all data registration events in the repository.
639 |RegistrationID|com:IDType|(% style="width:521px" %)RegistrationID subscribes to all the data registration events for the unique registration referenced.
Helena 6.1 640 |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:521px" %)ProvisionAgreementReference subscribes to all data registration events for the explicitly referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
641 |DataProvider|com: DataProviderReferenceType|(% style="width:521px" %)DataProviderReference subscribes to all data registration events for the explicitly referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]].
642 |DataflowReference|MaintainableEventType|(% style="width:521px" %)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.
Helena 4.1 643 |KeyFamilyReference|MaintainableEventType|(% style="width:521px" %)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.
Helena 6.1 644 |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:521px" %)[[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 2.2 645
Helena 6.1 646 **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 2.2 647
Helena 6.1 648 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
Helena 2.2 649 TYPE?
650
651 Content:
Helena 6.1 652 (AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | [[Category>>doc:sdmx:Glossary.Category.WebHome]])+)
Helena 2.2 653
Helena 6.1 654 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
Helena 3.2 655
Helena 4.1 656 (% style="width:1049.29px" %)
657 |(% style="width:231px" %)**Name**|(% style="width:213px" %)**Type**|(% style="width:602px" %)**Documentation**
Helena 6.1 658 |(% style="width:231px" %)TYPE (fixed: METADATA)|(% style="width:213px" %)xs:string|(% style="width:602px" %)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 2.2 659
660 Element Documentation:
Helena 3.2 661
Helena 4.1 662 (% style="width:1049.29px" %)
663 |**Name**|**Type**|(% style="width:494px" %)**Documentation**
664 |AllEvents|com:EmptyType|(% style="width:494px" %)AllEvents subscribes to all metadata registration events in the repository.
665 |RegistrationID|com:IDType|(% style="width:494px" %)RegistrationID subscribes to all the metadata registration events for the unique registration referenced.
Helena 6.1 666 |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:494px" %)ProvisionAgreementReference subscribes to all metadata registration events for the explicitly referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
667 |DataProvider|com: DataProviderReferenceType|(% style="width:494px" %)DataProvider subscribes to all metadata registration events for the explicitly referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]].
668 |MetadataflowReference|MaintainableEventType|(% style="width:494px" %)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.
669 |MetadataStructureDefinitionReference|MaintainableEventType|(% style="width:494px" %)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.
670 |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:494px" %)[[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 2.2 671
672 **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.
673
674 Content:
675 (URN | Ref)
676
677 Element Documentation:
Helena 3.2 678
Helena 4.1 679 (% style="width:1059.29px" %)
680 |**Name**|(% style="width:207px" %)**Type**|(% style="width:727px" %)**Documentation**
681 |URN|(% style="width:207px" %)xs:anyURI|(% style="width:727px" %)URN provides an explicit reference to a single object.
682 |Ref|(% style="width:207px" %)MaintainableQueryType|(% style="width:727px" %)Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.
Helena 2.2 683
684 **StructuralEventType: **StructuralEventType provides the details of a structure event, specifically the object that changed.
685
686 Content:
687 str:Structures
688
689 Element Documentation:
Helena 3.2 690
Helena 4.1 691 (% style="width:1070.29px" %)
692 |**Name**|**Type**|(% style="width:732px" %)**Documentation**
693 |str:Structures|str:StructuresType|(% style="width:732px" %)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 2.2 694
Helena 6.1 695 **RegistrationEventType: **This provides the details of a data or metadata registration event for the purposes of [[notification>>doc:sdmx:Glossary.Notification.WebHome]].
Helena 2.2 696
697 Content:
698 Registration
699
700 Element Documentation:
Helena 3.2 701
Helena 4.1 702 (% style="width:1003.29px" %)
703 |**Name**|(% style="width:172px" %)**Type**|(% style="width:563px" %)**Documentation**
704 |Registration|(% style="width:172px" %)RegistrationType|(% style="width:563px" %)Registration provides the changed details of the data or metadata registration.
Helena 2.2 705
Helena 3.1 706 === 2.1.3 Simple Types ===
Helena 2.2 707
708 **IDQueryType: **IDQueryType is a simple type that allows for an identifier to be substituted with a wild card character ("%").
709
710 Union of:
711 com:IDType, com:WildCardValueType.
712
713 **NestedIDQueryType: **NestedIDQueryType is a simple type that allows for a nested identifier to be substituted with a wild card character ("%").
714
715 Union of:
716 com:NestedIDType, com:WildCardValueType.
717
Helena 6.1 718 **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 2.2 719
720 Union of:
721 com:VersionType, com:LateBoundVersionType, com:WildCardValueType.
722
723 **StatusType: **StatusType provides an enumeration of values that detail the status of queries or requests.
724
725 Derived by restriction of xs:NMTOKEN .
726
727 Enumerations:
Helena 3.2 728
Helena 4.1 729 (% style="width:1004.29px" %)
730 |(% style="width:183px" %)**Value**|(% style="width:818px" %)**Documentation**
731 |(% style="width:183px" %)Success|(% style="width:818px" %)Query or request successful.
732 |(% style="width:183px" %)Warning|(% style="width:818px" %)Query or request successful, but with warnings.
733 |(% style="width:183px" %)Failure|(% style="width:818px" %)Query or request not successful.
Helena 2.2 734
735 **QueryTypeType: **QueryType provides an enumeration of values which specify the objects in the result-set for a registry query.
736
737 Derived by restriction of xs:NMTOKEN .
738
739 Enumerations:
740
Helena 4.1 741 (% style="width:739.294px" %)
742 |(% style="width:190px" %)**Value**|(% style="width:546px" %)**Documentation**
Helena 6.1 743 |(% style="width:190px" %)DataSets|(% style="width:546px" %)Only references [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] should be returned.
744 |(% style="width:190px" %)MetadataSets|(% style="width:546px" %)Only references to [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] should be returned.
745 |(% style="width:190px" %)AllSets|(% style="width:546px" %)References to both [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] should be returned.