Skip to Content

Wiki source code of Part V. Query

Version 5.1 by Helena on 2025/06/24 16:36
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1. Introduction =
6
7 The query constructs in SDMX have been modified to more closely follow the information model. The intention is to create a consistent structure for all queries so that they can be more easily processed and so that there is no ambiguity as to what the purpose of the request is. This means that for structural metadata, the queries derive from types as they do in the information model. Because a data flow and a metadata flow both are derived from the structure usage, there query constructs are nearly identical. The same basic principle is applied to the data and metadata queries. Where possible, they are consistent with each other.
8
9 To allow for web services to be explicit in the inputs to their functions, specific messages have been created for the various structural objects. This allows a function for querying codelists to be explicit as to the fact that the only acceptable input to this query is a codelist query.
10
11 Finally, a mechanism for requesting structure specific schemas has been introduced. The intentions is that one could request the schemas from an organisation so that they will have them readily available for processing of data retrieved from the same organisation.
12
13 = 2. Schema Documentation - =
14
15 == 2.2 Query Namespace ==
16
17 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/query**
18
19 === 2.2.1 Summary ===
20
21 Referenced Namespaces:
22
23 |**Namespace**|**Prefix**
24 | |
25 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
26 |http:~/~/www.w3.org/2001/XMLSchema|xs
27
28 Contents:
29 52 Global Elements
30 145 Complex Types
31 11 Simple Types
32
33 === 2.2.2 Global Elements ===
34
35 **//StructuralMetadataWhere// (//MaintainableWhereType//): **StructuralMetadataWhere is an abstract substitution head that forms the basis of any structural metadata query's details. This contains the actual parameters to be matched. These parameters are implicitly joined by an "and" connector (i.e. each of the parameters must be matched in order to satisfy the query). If it is necessary to supply "or" conditions for a parameter, this should be done by supplying multiple queries.
36
37 Substitutions: CategorisationWhere, CategorySchemeWhere, CodelistWhere, ConceptSchemeWhere, ConstraintWhere, DataflowWhere, DataStructureWhere, HierarchicalCodelistWhere, MetadataflowWhere, MetadataStructureWhere, OrganisationSchemeWhere, ProcessWhere, ProvisionAgreementWhere, ReportingTaxonomyWhere, StructureSetWhere, StructuresWhere, TransformationSchemeWhere, VtlMappingSchemeWhere, NamePersonalisationSchemeWhere, RulesetSchemeWhere, UserDefinedOperatorSchemeWhere, CustomTypeSchemeWhere
38
39 **//ItemWhere// (//ItemWhereType//): **ItemWhere is an abstract substitution head to query for an item within a parent item where or an item scheme query. An item where query is implicitly an and-query - that is the conditions within the item where must all be met in order to return a match. If this is nested within another item where, the meaning is that the conditions specified must be matched within the hierarchy provided.
40
41 Substitutions: CategoryWhere, CodeWhere, ConceptWhere, OrganisationWhere, ReportingCategoryWhere, TransformationWhere, VtlMappingWhere, NamePersonalisationWhere, RulesetWhere, UserDefinedOperatorWhere, CustomTypeWhere
42
43 **//ComponentListWhere// (//ComponentListWhereType//): **ComponentListWhere is an abstract substitution head to query for a component list within a structure. A component list where query is implicitly an and-query - that is the conditions within the component list where must all be met in order to return a match.
44
45 Substitutions: GroupWhere, MetadataTargetWhere, ReportStructureWhere
46
47 **//ComponentWhere// (//ComponentWhereType//): **ComponentWhere is an abstract substitution head to query for a component within a component list or a structure. A component where query is implicitly an and-query - that is the conditions within the component where must all be met in order to return a match.
48
49 Substitutions: GroupDimensionWhere, AttributeWhere, DimensionWhere, TimeDimensionWhere, PrimaryMeasureWhere, MeasureDimensionWhere, TargetObjectWhere, MetadataAttributeWhere
50
51 **NumericValue (NumericValueType): **NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.
52
53 **TextValue (QueryTextType): **TextValue is used to query for the value of a concept or component based on textual parameters. The text value can be language specific (where parallel multi-lingual values are available) and is qualified with an operator indicating how the supplied text should be matched against the sought components. If only a simple equality check is necessary, regardless of language, the Value element can be used.
54
55 **TimeValue (TimePeriodValueType): **TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
56
57 **Value (SimpleValueType): **Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.
58
59 **CategorisationWhere (CategorisationWhereType): **CategorisationWhere defines the parameters for a categorisation query. All parameters must be matched for an object to satisfy the query.In addition to querying based on the basic maintainable properties, it is also possible to search based on the source object being categorized and target category the object is categorized against.
60
61 Substitution For: //StructuralMetadataWhere//
62
63 **CategorySchemeWhere (CategorySchemeWhereType): **CategorySchemeWhere contains the parameters for a category scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a category scheme based on the details of its categories. In any case, the category scheme will be returned according the indicated return detail.
64
65 Substitution For: //StructuralMetadataWhere//
66
67 **CategoryWhere (CategoryWhereType): **CategoryWhere is used to query for categories matching the parameters supplied. It allows for nested category queries so that hierarchical categories can be queried explicitly by their nested level, although a top level category will always result in a search for categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
68
69 Substitution For: //ItemWhere//
70
71 **CodelistWhere (CodelistWhereType): **CodelistWhere defines the parameters for a codelist query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a codlist based on the details of its codes. In any case, the codelist will be returned according the indicated return detail.
72
73 Substitution For: //StructuralMetadataWhere//
74
75 **CodeWhere (CodeWhereType): **CodeWhere is used to query for codes matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
76
77 Substitution For: //ItemWhere//
78
79 **ConceptSchemeWhere (ConceptSchemeWhereType): **ConceptSchemeWhere defines the parameters for a concept scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a concept scheme based on the details of its concepts. In any case, the concept scheme will be returned according the indicated return detail.
80
81 Substitution For: //StructuralMetadataWhere//
82
83 **ConceptWhere (ConceptWhereType): **ConceptWhere is used to query for concepts matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
84
85 Substitution For: //ItemWhere//
86
87 **ConstraintWhere (ConstraintWhereType): **AttachmentConstraintWhere contains the parameters for a constraint query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a constraint based on the objects it applies to.
88
89 Substitution For: //StructuralMetadataWhere//
90
91 **DataflowWhere (DataflowWhereType): **DataflowWhere defines the parameters for a dataflow query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a dataflow based on the key family it defines the usage of.
92
93 Substitution For: //StructuralMetadataWhere//
94
95 **DataStructureWhere (DataStructureWhereType): **DataStructureWhere contains the parameters for a data structure definition query. All parameters must be matched for an object to satisfy the query. The query is simply a refinement of the base structure query to make the parameters specific to the data structure definition.
96
97 Substitution For: //StructuralMetadataWhere//
98
99 **GroupWhere (GroupWhereType): **GroupWhere is used to query for a data structure definition that contains a group meeting the conditions detailed in this container. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
100
101 Substitution For: //ComponentListWhere//
102
103 **GroupDimensionWhere (DimensionWhereType): **GroupDimensionWhere is used to query a group based on the details of the dimensions it groups. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
104
105 Substitution For: //ComponentWhere//
106
107 **AttributeWhere (AttributeWhereType): **AttributeWhere is used to query for a data structure definition that contains an attribute meeting the conditions contained in this structure. The attribute can be queried based on its identification, the concept from which it takes its semantic, its attachment level, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
108
109 Substitution For: //ComponentWhere//
110
111 **DimensionWhere (DimensionWhereType): **DimensionWhere is used to query for a data structure definition that contains a dimension meeting the conditions contained in this structure. The dimension can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
112
113 Substitution For: //ComponentWhere//
114
115 **TimeDimensionWhere (TimeDimensionWhereType): **TimeDimensionWhere is used to query for a data structure definition that contains a time dimension meeting the conditions contained in this structure. The time dimension can be queried based on its identification and the concept from which it takes its semantic. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
116
117 Substitution For: //ComponentWhere//
118
119 **PrimaryMeasureWhere (PrimaryMeasureWhereType): **PrimaryMeasureWhere is used to query for a data structure definition that contains a primary measure meeting the conditions contained in this structure. The primary measure can be queried based on its identification, the concept from which it takes its semantic, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
120
121 Substitution For: //ComponentWhere//
122
123 **MeasureDimensionWhere (MeasureDimensionWhereType): **MeasureDimensionWhere is used to query for a data structure definition that contains a measure dimension meeting the conditions contained in this structure. The cross-sectional measure can be queried based on its identification, the concept from which it takes its semantic, and the concept scheme it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
124
125 Substitution For: //ComponentWhere//
126
127 **HierarchicalCodelistWhere (HierarchicalCodelistWhereType): **HierarchicalCodelistWhere defines the parameters for a hierarchical codelist query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a hierarchical codelist based on the codelists it arranges into hierarchies.
128
129 Substitution For: //StructuralMetadataWhere//
130
131 **MetadataflowWhere (MetadataflowWhereType): **MetadataflowWhere contains the parameters for a metadataflow query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a metadataflow based on the metadata structure definition it defines the usage of.
132
133 Substitution For: //StructuralMetadataWhere//
134
135 **MetadataStructureWhere (MetadataStructureWhereType): **MetadataStructureWhere contains the parameters for a metadata structure definition query. All parameters must be matched for an object to satisfy the query. The query is simply a refinement of the base structure query to make the parameters specific to the metadata structure definition.
136
137 Substitution For: //StructuralMetadataWhere//
138
139 **MetadataTargetWhere (MetadataTargetWhereType): **MetadataTargetWhere is used to query for a metadata structure definition that contains a metadata target meeting the conditions contained in this structure. The metadata target can be queried based on its identification and/or the details of its target objects. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
140
141 Substitution For: //ComponentListWhere//
142
143 **TargetObjectWhere (TargetObjectWhereType): **IdentifierComponentWhere is used to query for specific target identifiers or metadata structure definitions where a contained identifier component meets the conditions detailed. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
144
145 Substitution For: //ComponentWhere//
146
147 **ReportStructureWhere (ReportStructureWhereType): **ReportStructureWhere is used to query for metadata structure definitions where a given report structure meets the conditions specified. A report structure can be queried based on identification or details about its metadata attributes. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
148
149 Substitution For: //ComponentListWhere//
150
151 **MetadataAttributeWhere (MetadataAttributeWhereType): **MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query metadata structure definitions where a contained metadata attribute meets the conditions specified. A metadata attribute can be queried based on its identification, the concept from which it takes its semantic, and an item scheme it uses as its representation. Nested metadata attributes allow for the querying of metadata attributes explicitly at nested level, although a top level metadata attribute query will be processed by querying metadata attributes at any level. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
152
153 Substitution For: //ComponentWhere//
154
155 **OrganisationSchemeWhere (OrganisationSchemeWhereType): **OrganisationSchemeWhere defines the parameters for an organisation scheme query, regardless of the specific type of organisation scheme being sought. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for an organisation scheme based on the details of its organisations. In any case, the organisation scheme will be returned according the indicated return detail.
156
157 Substitution For: //StructuralMetadataWhere//
158
159 **OrganisationWhere (OrganisationWhereType): **OrganisationWhere is used to query for organisations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
160
161 Substitution For: //ItemWhere//
162
163 **ProcessWhere (ProcessWhereType): **ProcessWhere contains the parameters for a process query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the process steps defined within the process. In any case, the entire process will be returned according the indicated return detail.
164
165 Substitution For: //StructuralMetadataWhere//
166
167 **ProvisionAgreementWhere (ProvisionAgreementWhereType): **ProvisionAgreementWhere contains the parameters for a provision agreement query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a provision agreement based on the data provider and the structure usage it pairs.
168
169 Substitution For: //StructuralMetadataWhere//
170
171 **ReportingTaxonomyWhere (ReportingTaxonomyWhereType): **ReportingTaxonomyWhere contains the parameters for a reporting taxonomy query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a reporting taxonomy based on the details of its reporting categories. In any case, the reporting taxonomy will be returned according the indicated return detail.
172
173 Substitution For: //StructuralMetadataWhere//
174
175 **ReportingCategoryWhere (ReportingCategoryWhereType): **ReportingCategoryWhere is used to query for reporting categories matching the parameters supplied. It allows for nested reporting category queries so that hierarchical reporting categories can be queried explicitly by their nested level, although a top level reporting category will always result in a search for reporting categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
176
177 Substitution For: //ItemWhere//
178
179 **StructureSetWhere (StructureSetWhereType): **StructureSetWhere contains the parameters for a structure query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search based on the structures that are related by the set or the objects which are mapped by the set's maps. In any case, the structure set will be returned according the indicated return detail.
180
181 Substitution For: //StructuralMetadataWhere//
182
183 **StructuresWhere (StructuresWhereType): **StructuresWhere defines the parameters for a structures query. All parameters must be matched for an object to satisfy the query. Only the basic maintainable parameters are available.
184
185 Substitution For: //StructuralMetadataWhere//
186
187 **TransformationSchemeWhere (TransformationSchemeWhereType): **TransformationSchemeWhere contains the parameters for a transformation scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the transformations defined within the scheme.
188
189 Substitution For: //StructuralMetadataWhere//
190
191 **TransformationWhere (TransformationWhereType): **TransformationWhere is used to query for transformations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
192
193 Substitution For: //ItemWhere//
194
195 **VtlMappingSchemeWhere (VtlMappingSchemeWhereType): **VtlMappingSchemeWhere contains the parameters for a VTL mapping scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the VTL mappings defined within the scheme.
196
197 Substitution For: //StructuralMetadataWhere//
198
199 **VtlMappingWhere (VtlMappingWhereType): **VtlMappingWhere is used to query for VTL mappings matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
200
201 Substitution For: //ItemWhere//
202
203 **NamePersonalisationSchemeWhere (NamePersonalisationSchemeWhereType): **NamePersonalisationSchemeWhere contains the parameters for a name personalisation scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the name personalisations defined within the scheme.
204
205 Substitution For: //StructuralMetadataWhere//
206
207 **NamePersonalisationWhere (NamePersonalisationWhereType): **NamePersonalisationWhere is used to query for name personalisations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
208
209 Substitution For: //ItemWhere//
210
211 **RulesetSchemeWhere (RulesetSchemeWhereType): **RulesetSchemeWhere contains the parameters for a ruleset scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the rulesets defined within the scheme.
212
213 Substitution For: //StructuralMetadataWhere//
214
215 **RulesetWhere (RulesetWhereType): **RulesetWhere is used to query for rulesets matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
216
217 Substitution For: //ItemWhere//
218
219 **UserDefinedOperatorSchemeWhere (UserDefinedOperatorSchemeWhereType): **UserDefinedOperatorSchemeWhere contains the parameters for a user defined operator scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the user defined operators defined within the scheme.
220
221 Substitution For: //StructuralMetadataWhere//
222
223 **UserDefinedOperatorWhere (UserDefinedOperatorWhereType): **UserDefinedOperatorWhere is used to query for user defined operators matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
224
225 Substitution For: //ItemWhere//
226
227 **CustomTypeSchemeWhere (CustomTypeSchemeWhereType): **CustomTypeSchemeWhere contains the parameters for a custom type scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the custom types defined within the scheme.
228
229 Substitution For: //StructuralMetadataWhere//
230
231 **CustomTypeWhere (CustomTypeWhereType): **CustomTypeWhere is used to query for custom types matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
232
233 Substitution For: //ItemWhere//
234
235 === 2.1.3 Complex Types ===
236
237 **//ReturnDetailsBaseType//: **ReturnDetailsBaseType is an abstract type that forms the basis for any query return details.
238
239 Attributes:
240 defaultLimit?, detail?
241
242 Content:
243 {Empty}
244
245 Attribute Documentation:
246
247 |**Name**|**Type**|**Documentation**
248 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
249 |detail|xs:string|>The detail attribute is used to indicate how much of the matched object should be returned.
250
251 **//StructuralMetadataQueryType//: **StructureWhereQueryType is an abstract base type that serves as the basis for any structural metadata query. Concrete instances of this type are implied to be an and-query. A structural object will be returned for any object where all of the conditions are met.
252
253 Content:
254 ReturnDetails, //StructuralMetadataWhere//
255
256 Element Documentation:
257
258 |**Name**|**Type**|**Documentation**
259 |ReturnDetails|StructureReturnDetai lsType|
260 |//StructuralMetadataWh ere//|//MaintainableWhereTyp e//|StructuralMetadataWhere is an abstract substitution head that forms the basis of any structural metadata query's details. This contains the actual parameters to be matched. These parameters are implicitly joined by an "and" connector (i.e. each of the parameters must be matched in order to satisfy the query). If it is necessary to supply "or" conditions for a parameter, this should be done by supplying multiple queries.
261
262 **//StructureReturnDetailsBaseType//: **StructureReturnDetailsBaseType is an abstract base type which forms the basis of StructureReturnDetailsType.
263
264 Derivation:
265
266 * //ReturnDetailsBaseType// (restriction)
267 ** //StructureReturnDetailsBaseType//
268
269 Attributes:
270 defaultLimit?, detail?
271
272 Content:
273 {Empty}
274
275 Attribute Documentation:
276
277 |**Name**|**Type**|**Documentation**
278 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
279 |detail (default: Full)|StructureReturnDetai lType|The detail attribute is used to indicate whether the response to the query should return the full details of matched objects, or just a subset of the information should be returned. A value of "Full" indicates that the full details of all matched objects should be returned. A value of "CompleteStub" indicates that the identification information, name, description, and annotations for the matched object should be returned. A value of "Stub" indicates that just the identification information and name should be returned for the matched objects. Note that this applies only to the object(s) matched by the query parameters. The References element has a separate field for indicating the level of detail returned for referenced objects.
280
281 **StructureReturnDetailsType: **StructureReturnDetailsType defines the structure of the return details for any structural metadata query.
282
283 Derivation:
284
285 * //ReturnDetailsBaseType// (restriction)
286 ** //StructureReturnDetailsBaseType// (extension)
287 *** StructureReturnDetailsType
288
289 Attributes:
290 defaultLimit?, detail?, returnMatchedArtefact?
291
292 Content:
293 References
294
295 Attribute Documentation:
296
297 |**Name**|**Type**|**Documentation**
298 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
299 |detail (default: Full)|StructureReturnDetai lType|The detail attribute is used to indicate whether the response to the query should return the full details of matched objects, or just a subset of the information should be returned. A value of "Full" indicates that the full details of all matched objects should be returned. A value of "CompleteStub" indicates that the identification information, name, description, and annotations for the matched object should be returned. A value of "Stub" indicates that just the identification information and name should be returned for the matched objects. Note that this applies only to the object(s) matched by the query parameters. The References element has a separate field for indicating the level of detail returned for referenced objects.
300 |returnMatchedArtefact (default: true)|xs:boolean|The returnMatchedArtefact attribute indicates whether the object(s) match by the query should be returned. If this is set to false, only the reference objects from the match object(s) will be returned.
301
302 Element Documentation:
303
304 |**Name**|**Type**|**Documentation**
305 |References|ReferencesType|References is used to communicate how objects that reference or are referenced by the object(s) being queried should be returned.
306
307 **MaintainableReturnDetailsType: **MaintainableReturnDetailsType defines the structure for the return details of a non-item scheme maintainable object. It eliminates the detail options that are specific to searching an item scheme
308
309 Derivation:
310
311 * //ReturnDetailsBaseType// (restriction)
312 ** //StructureReturnDetailsBaseType// (extension)
313 *** StructureReturnDetailsType (restriction)
314 **** MaintainableReturnDetailsType
315
316 Attributes:
317 defaultLimit?, detail?, returnMatchedArtefact?
318
319 Content:
320 References
321
322 Attribute Documentation:
323
324 |**Name**|**Type**|**Documentation**
325 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
326 |detail (default: Full)|MaintainableReturnDe tailType|The detail attribute is used to indicate whether the response to the query should return the full details of matched objects, or just a subset of the information should be returned. A value of "Full" indicates that the full details of all matched objects should be returned. A value of "CompleteStub" indicates that the identification information, name, description, and annotations for the matched object should be returned. A value of "Stub" indicates that just the identification information and name should be returned for the matched objects. Note that this applies only to the object(s) matched by the query parameters. The References element has a separate field for indicating the level of detail returned for referenced objects.
327 |returnMatchedArtefact (default: true)|xs:boolean|The returnMatchedArtefact attribute indicates whether the object(s) match by the query should be returned. If this is set to false, only the reference objects from the match object(s) will be returned.
328
329 Element Documentation:
330
331 |**Name**|**Type**|**Documentation**
332 |References|ReferencesType|References is used to communicate how objects that reference or are referenced by the object(s) being queried should be returned.
333
334 **ReferencesType: **ReferencesType defines the structure for indicating which referenced objects should be returned in a structural metadata query. It is possible to return both objects which reference the object(s) matched by the query and objects referenced from the match object(s). The type(s) of reference objects to be returned consists of a choice between None, All, Default, or an explicit list of object types.
335
336 Attributes:
337 processConstraints?, detail?
338
339 Content:
340 (None | All | Parents | ParentsAndSiblings | Children | Descendants | SpecificObjects)
341
342 Attribute Documentation:
343
344 |**Name**|**Type**|**Documentation**
345 |processConstraints (default: false)|xs:boolean|The processConstraints attribute is used to request that the query process any relevant constraints for the match object(s) in order to return only the applicable portion of any referenced codelists. A value of "true" indicates that constraints should be processed.
346 |detail (default: Full)|MaintainableReturnDe tailType|The detail attribute indicates the amount of detail that should be returned for reference objects. A value of "Full" indicates that the full details of all reference objects should be returned. A value of "CompleteStub" indicates that the identification information, name, description, and annotations for the reference object should be returned. A value of "Stub" indicates that just the identification information and name should be returned for the reference objects.
347
348 Element Documentation:
349
350 |**Name**|**Type**|**Documentation**
351 |None|com:EmptyType|None indicates that no reference objects should be returned.
352 |All|com:EmptyType|All is a convenience to indicate that the sets indicated by the ParentsAndSiblings and Descendants should be returned.
353 |Parents|com:EmptyType|Parents is a convenience to indicate that any object that refers to the matched object should be returned. This is typically used when the query the goal is to find object refer to a set of unknown objects.
354 |ParentsAndSiblings|com:EmptyType|ParentsAndSiblings is a convenience to indicate that any object that refers to the matched object should be returned, along with any other objects referenced by those referring objects.
355 |Children|com:EmptyType|Children is a convenience to indicate that all object referred to by the matched object should be returned.
356 |Descendants|com:EmptyType|Descendants is a convenience to indicate that all object referred to by the matched object should be returned, along with any objects referenced by the referred objects, and so on. This is a deep resolution, where all outgoing references starting at the matched object are resolved.
357 |SpecificObjects|com: MaintainableObjectTy peListType|SpecificObjects is used to enumerate specific types of object to be returned. Theses objects will either refer to or are referred by the matched object. Only the maintainable objects listed here will be returned.
358
359 **//AnnotableWhereType//: **AnnotableWhereType is an abstract base type for querying an annotable artefact.
360
361 Content:
362 Annotation?
363
364 Element Documentation:
365
366 |**Name**|**Type**|**Documentation**
367 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
368
369 **AnnotationWhereType: **AnnotationWhereType defines the structure for querying the details of an annotation.
370
371 Content:
372 Type?, Title?, Text?
373
374 Element Documentation:
375
376 |**Name**|**Type**|**Documentation**
377 |Type|QueryStringType|Type is a parameter for matching the type field of an annotation.
378 |Title|QueryStringType|Title is a parameter for matching the title field of an annotation.
379 |Text|QueryTextType|Text is a parameter for matching the text field of an annotation.
380
381 **//IdentifiableWhereType//: **IdentifiableWhereType is an abstract base type that serves as the basis for any query for an identifiable object.
382
383 Derivation:
384
385 * //AnnotableWhereType// (extension)
386 ** //IdentifiableWhereType//
387
388 Content:
389 Annotation?, URN?, ID?
390
391 Element Documentation:
392
393 |**Name**|**Type**|**Documentation**
394 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
395 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
396 |ID|QueryIDType|ID is used to match the id of the identified object.
397
398 **//NameableWhereType//: **NameableWhereType is an abstract base type that serves as the basis for any query for a nameable object.
399
400 Derivation:
401
402 * //AnnotableWhereType// (extension)
403 ** //IdentifiableWhereType// (extension)
404 *** //NameableWhereType//
405
406 Content:
407 Annotation?, URN?, ID?, Name?, Description?
408
409 Element Documentation:
410
411 |**Name**|**Type**|**Documentation**
412 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
413 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
414 |ID|QueryIDType|ID is used to match the id of the identified object.
415 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
416 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
417
418 **//VersionableWhereType//: **VersionableQueryType is an abstract base type that serves as the basis for any query for a versionable object.
419
420 Derivation:
421
422 * //AnnotableWhereType// (extension)
423 ** //IdentifiableWhereType// (extension)
424 *** //NameableWhereType// (extension)
425 **** //VersionableWhereType//
426
427 Content:
428 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?
429
430 Element Documentation:
431
432 |**Name**|**Type**|**Documentation**
433 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
434 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
435 |ID|QueryIDType|ID is used to match the id of the identified object.
436 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
437 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
438 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
439 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
440 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
441 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
442
443 **//MaintainableWhereType//: **MaintainableQueryType is an abstract base type that serves as the basis for any query for a maintainable object.
444
445 Derivation:
446
447 * //AnnotableWhereType// (extension)
448 ** //IdentifiableWhereType// (extension)
449 *** //NameableWhereType// (extension)
450 **** //VersionableWhereType// (extension)
451 ***** //MaintainableWhereType//
452
453 Attributes:
454 type?
455
456 Content:
457 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
458
459 Attribute Documentation:
460
461 |**Name**|**Type**|**Documentation**
462 |type|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
463
464 Element Documentation:
465
466 |**Name**|**Type**|**Documentation**
467 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
468 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
469 |ID|QueryIDType|ID is used to match the id of the identified object.
470 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
471 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
472 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
473 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
474 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
475 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
476 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
477
478 **//ItemSchemeWhereType//: **ItemSchemeQueryType is an abstract base type that serves as the basis for any query for an item scheme.
479
480 Derivation:
481
482 * //AnnotableWhereType// (extension)
483 ** //IdentifiableWhereType// (extension)
484 *** //NameableWhereType// (extension)
485 **** //VersionableWhereType// (extension)
486 ***** //MaintainableWhereType// (extension)
487 ****** //ItemSchemeWhereType//
488
489 Attributes:
490 type?
491
492 Content:
493 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, //ItemWhere*//
494
495 Attribute Documentation:
496
497 |**Name**|**Type**|**Documentation**
498 |type|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
499
500 Element Documentation:
501
502 |**Name**|**Type**|**Documentation**
503 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
504 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
505 |ID|QueryIDType|ID is used to match the id of the identified object.
506 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
507 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
508 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
509 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
510 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
511 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
512 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
513 |//ItemWhere//|//ItemWhereType//|ItemWhere is an abstract substitution head to query for an item within a parent item where or an item scheme query. An item where query is implicitly an and-query - that is the conditions within the item where must all be met in order to return a match. If this is nested within another item where, the meaning is that the conditions specified must be matched within the hierarchy provided.
514
515 **//ItemWhereType//: **ItemQueryType is an abstract base type that serves as the basis for a query for an item within an item scheme query. A nested item where is provided to query for items nested within other items. The conditions within an item query are implied to be in an and-query. If an id and a child item where condition are supplied, then both conditions will have to met in order for the item query to return true. If, for instance, a query based on names in multiple languages is required, then multiple instances of the element utilizing this type should be used within an or-query container.
516
517 Derivation:
518
519 * //AnnotableWhereType// (extension)
520 ** //IdentifiableWhereType// (extension)
521 *** //NameableWhereType// (extension)
522 **** //ItemWhereType//
523
524 Content:
525 Annotation?, URN?, ID?, Name?, Description?, (Parent | //ItemWhere+//)?
526
527 Element Documentation:
528
529 |**Name**|**Type**|**Documentation**
530 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
531 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
532 |ID|QueryIDType|ID is used to match the id of the identified object.
533 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
534 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
535 |Parent|//com: LocalItemReferenceTy pe//|Parent is used to query for an item where it declares the item referenced here as its parent. This is used for items that are not nested in a hierarchy. If child items are sought for an item that is contained in a nested hierarchy (e.g. a category) on can query directly for the parent category and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details.
536 |//ItemWhere//|//ItemWhereType//|ItemWhere is an abstract substitution head to query for an item within a parent item where or an item scheme query. An item where query is implicitly an and-query - that is the conditions within the item where must all be met in order to return a match. If this is nested within another item where, the meaning is that the conditions specified must be matched within the hierarchy provided.
537
538 **//StructureWhereType//: **StructureWhereType is an abstract base type that serves as the basis for a query for a structure object.
539
540 Derivation:
541
542 * //AnnotableWhereType// (extension)
543 ** //IdentifiableWhereType// (extension)
544 *** //NameableWhereType// (extension)
545 **** //VersionableWhereType// (extension)
546 ***** //MaintainableWhereType// (extension)
547 ****** //StructureWhereType//
548
549 Attributes:
550 type?
551
552 Content:
553 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, //ComponentListWhere*//, //ComponentWhere*//
554
555 Attribute Documentation:
556
557 |**Name**|**Type**|**Documentation**
558 |type|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
559
560 Element Documentation:
561
562 |**Name**|**Type**|**Documentation**
563 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
564 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
565 |ID|QueryIDType|ID is used to match the id of the identified object.
566 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
567 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
568 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
569 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
570 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
571 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
572 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
573 |UsedConcept|com: ConceptReferenceType|UsedConcept is used to query for a structure that uses the referenced concept as the basis of one of its components.
574 |UsedRepresentation|//com: ItemSchemeReferenceB aseType//|UsedRepresentation is used to query for a structure that uses the referenced item scheme for the representation of one of its components.
575 |//ComponentListWhere//|//ComponentListWhereTy pe//|ComponentListWhere is an abstract substitution head to query for a component list within a structure. A component list where query is implicitly an and-query - that is the conditions within the component list where must all be met in order to return a match.
576 |//ComponentWhere//|//ComponentWhereType//|ComponentWhere is an abstract substitution head to query for a component within a component list or a structure. A component where query is implicitly an and-query - that is the conditions within the component where must all be met in order to return a match.
577
578 **//ComponentListWhereType//: **ComponentListWhereType is an abstract base type that serves as the basis for a query for a component list within a structure query. A list of component where children are provided to query for the list's child components. The conditions within a component list query are implied to be in an and-query. If an id and a child component where condition are supplied, then both conditions will have to met in order for the component list query to return true. If, for instance, a query based on names in multiple languages is required, then multiple instances of the element utilizing this type should be used within an or-query container.
579
580 Derivation:
581
582 * //AnnotableWhereType// (extension)
583 ** //IdentifiableWhereType// (extension)
584 *** //ComponentListWhereType//
585
586 Content:
587 Annotation?, URN?, ID?, //ComponentWhere*//
588
589 Element Documentation:
590
591 |**Name**|**Type**|**Documentation**
592 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
593 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
594 |ID|QueryIDType|ID is used to match the id of the identified object.
595 |//ComponentWhere//|//ComponentWhereType//|ComponentWhere is an abstract substitution head to query for a component within a component list or a structure. A component where query is implicitly an and-query - that is the conditions within the component where must all be met in order to return a match.
596
597 **//ComponentWhereType//: **ComponentWhereType is an abstract base type that serves as the basis for a query for a component within a component list where or a structure query. A concept identity and a local representation condition are available to seek a component that utilizes a particular concept or representation scheme. The conditions within a component query are implied to be in an and-query. If an id and a concept identity condition are supplied, then both conditions will have to met in order for the component query to return true. If, for instance, a query based on names in multiple languages is required, then multiple instances of the element utilizing this type should be used within an or-query container.
598
599 Derivation:
600
601 * //AnnotableWhereType// (extension)
602 ** //IdentifiableWhereType// (extension)
603 *** //ComponentWhereType//
604
605 Content:
606 Annotation?, URN?, ID?, ConceptIdentity?, Enumeration?
607
608 Element Documentation:
609
610 |**Name**|**Type**|**Documentation**
611 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
612 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
613 |ID|QueryIDType|ID is used to match the id of the identified object.
614 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
615 |Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
616
617 **//StructureUsageWhereType//: **StructureUsageWhereType is an abstract base type that serves as the basis for a query for a structure usage object.
618
619 Derivation:
620
621 * //AnnotableWhereType// (extension)
622 ** //IdentifiableWhereType// (extension)
623 *** //NameableWhereType// (extension)
624 **** //VersionableWhereType// (extension)
625 ***** //MaintainableWhereType// (extension)
626 ****** //StructureUsageWhereType//
627
628 Attributes:
629 type?
630
631 Content:
632 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure?
633
634 Attribute Documentation:
635
636 |**Name**|**Type**|**Documentation**
637 |type|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
638
639 Element Documentation:
640
641 |**Name**|**Type**|**Documentation**
642 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
643 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
644 |ID|QueryIDType|ID is used to match the id of the identified object.
645 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
646 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
647 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
648 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
649 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
650 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
651 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
652 |Structure|//com: StructureReferenceBa seType//|Structure is used to match the structure referenced by a structure usage object. Only structure usages which reference the supplied structure will be returned.
653
654 **ConceptValueType: **ConceptValueType describes the structure of a query for the value of the underlying concept of a component. It provides a reference to a concept in a concept scheme via a URN and/or a complete set of reference fields, as well as a numeric, text, or un-typed value.
655
656 Content:
657 Concept, (NumericValue[1..2] | TextValue+ | TimeValue[1..2] | Value)
658
659 Element Documentation:
660
661 |**Name**|**Type**|**Documentation**
662 |Concept|com: ConceptReferenceType|
663 |NumericValue|NumericValueType|NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.
664 |TextValue|QueryTextType|TextValue is used to query for the value of a concept or component based on textual parameters. The text value can be language specific (where parallel multi-lingual values are available) and is qualified with an operator indicating how the supplied text should be matched against the sought components. If only a simple equality check is necessary, regardless of language, the Value element can be used.
665 |TimeValue|TimePeriodValueType|TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
666 |Value|SimpleValueType|Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.
667
668 **CodeValueType: **CodeValueType is used to query for data or reference metadata where a component which uses the referenced codelist as its representation enumeration has the value provided. Note that this is only applicable when the value is a coded value, which is to say that it does not apply to a codelist which is specified as the representation or an identifiable object target in a metadata target.
669
670 Attributes:
671 value
672
673 Content:
674 Codelist
675
676 Attribute Documentation:
677
678 |**Name**|**Type**|**Documentation**
679 |value|xs:string|The value attribute indicates the coded value that is to be queried for.
680
681 Element Documentation:
682
683 |**Name**|**Type**|**Documentation**
684 |Codelist|com: CodelistReferenceTyp e|Codelist references the codelist for which the coded value is being sought.
685
686 **SimpleValueType: **SimpleValueType describes the structure of a simple value query. A value is provided as the content in string format.
687
688 Derivation:
689
690 * xs:anySimpleType (restriction)
691 ** xs:string (extension)
692 *** SimpleValueType
693
694 Attributes:
695 operator?
696
697 Content:
698 Attribute Documentation:
699
700 |**Name**|**Type**|**Documentation**
701 |operator (default: equal)|com: SimpleOperatorType|The operator attribute indicates the operator to apply to the string value query. The options are equal and notEqual.
702
703 **NumericValueType: **NumericValueType describes the structure of a numeric query. A value is provided as the content in decimal format.
704
705 Derivation:
706
707 * xs:anySimpleType (restriction)
708 ** xs:decimal (extension)
709 *** NumericValueType
710
711 Attributes:
712 operator?
713
714 Content:
715 Attribute Documentation:
716
717 |**Name**|**Type**|**Documentation**
718 |operator (default: equal)|com: OrderedOperatorType|The operator attribute indicates the operator to apply to the numeric value query, such as equal to or greater than.
719
720 **QueryStringType: **QueryStringType defines the structure of a string query.
721
722 Derivation:
723
724 * xs:anySimpleType (restriction)
725 ** xs:string (extension)
726 *** QueryStringType
727
728 Attributes:
729 operator?
730
731 Content:
732 Attribute Documentation:
733
734 |**Name**|**Type**|**Documentation**
735 |operator (default: equal)|com:TextOperatorType|The operator attribute indicates how the supplied value should be applied to the objects being searched in order to constitute a match. For example, a value of "EqualTo" means the value of the field being search should exactly match the value supplied. See the defining type for further details.
736
737 **QueryIDType: **QueryIDType defines the structure of a query for an identifier.
738
739 Derivation:
740
741 * xs:anySimpleType (restriction)
742 ** xs:string (restriction)
743 *** com:NestedIDType (restriction)
744 **** com:IDType (extension)
745 ***** QueryIDType
746
747 Attributes:
748 operator?
749
750 Content:
751 Attribute Documentation:
752
753 |**Name**|**Type**|**Documentation**
754 |operator (default: equal)|com:TextOperatorType|The operator attribute indicates how the supplied value should be applied to the objects being searched in order to constitute a match. For example, a value of "EqualTo" means the value of the field being search should exactly match the value supplied. See the defining type for further details.
755
756 **QueryNestedIDType: **QueryNestedIDType defines the structure of a query for a nested identifier.
757
758 Derivation:
759
760 * xs:anySimpleType (restriction)
761 ** xs:string (restriction)
762 *** com:NestedIDType (extension)
763 **** QueryNestedIDType
764
765 Attributes:
766 operator?
767
768 Content:
769 Attribute Documentation:
770
771 |**Name**|**Type**|**Documentation**
772 |operator (default: equal)|com:TextOperatorType|The operator attribute indicates how the supplied value should be applied to the objects being searched in order to constitute a match. For example, a value of "EqualTo" means the value of the field being search should exactly match the value supplied. See the defining type for further details.
773
774 **QueryTextType: **QueryTextType describes the structure of a textual query value. A language must be specified if parallel multi-lingual values are available, otherwise it is ignored.
775
776 Derivation:
777
778 * xs:anySimpleType (restriction)
779 ** xs:string (extension)
780 *** com:TextType (extension)
781 **** QueryTextType
782
783 Attributes:
784 xml:lang?, operator?
785
786 Content:
787 Attribute Documentation:
788
789 |**Name**|**Type**|**Documentation**
790 |xml:lang (default: en)|xs:language|The xml:lang attribute specifies a language code for the text. If not supplied, the default language is assumed to be English.
791 |operator (default: equal)|com:TextOperatorType|The operator attribute indicates how the supplied value should be applied to the objects being searched in order to constitute a match. For example, a value of "EqualTo" means the value of the field being search should exactly match the value supplied. See the defining type for further details.
792
793 **TimePeriodValueType: **TimePeriodValueType describes the structure of a time period query. A value is provided as the content in the SDMX time period format.
794
795 Derivation:
796
797 * xs:anySimpleType (restriction)
798 ** com:ObservationalTimePeriodType (extension)
799 *** TimePeriodValueType
800
801 Attributes:
802 operator?, reportingYearStartDay?
803
804 Content:
805
806 Attribute Documentation:
807
808 |**Name**|**Type**|**Documentation**
809 |operator (default: equal)|com:TimeOperatorType|The operator attribute indicates the operator to apply to the value query, such as equal to or greater than.
810 |reportingYearStartDay (default: Any)|ReportingYearStartDa yQueryType|The reportingYearStartDay attribute allows a reporting year start day to be specified for the reporting period time value. If this time value provided is not a report period, this value can be ignored. If an explicit value is provided, this will effectively turn the time parameter into a distinct time range. For example if the time parameter value is "2010-Q1" and this attribute has a value of "~-~-04-01", the parameter will be treated as "2010-04-01/2010-06-30". If a value of "Any" is provided, then data will be matched regardless of its reporting year start day. For example, a query of 2011-A1 would return all data that belongs to a reporting year of 2011, regardless of the start day of the reporting year. For the puroses of matching data reporting against a Gregorian period against a time parameter value that is a reporting period, a value of "Any" will be treated as a start day of January 1. Therefore, if the time paramter value was 2011-A1, data reported against 2011 would be matched but data reporting against '2011-06/P1Y' would not be matched.
811
812 **CategorisationQueryType: **CategorisationQueryType defines the structure of a categorisation query. The parameters for the query are contained in the CategorisationWhere element. The References element is used to indicate how objects that are referenced from the matched categorisations should be returned.
813
814 Derivation:
815
816 * //StructuralMetadataQueryType// (restriction)
817 ** CategorisationQueryType
818
819 Content:
820 ReturnDetails, CategorisationWhere
821
822 Element Documentation:
823
824 |**Name**|**Type**|**Documentation**
825 |ReturnDetails|MaintainableReturnDe tailsType|
826 |CategorisationWhere|CategorisationWhereT ype|CategorisationWhere defines the parameters for a categorisation query. All parameters must be matched for an object to satisfy the query.In addition to querying based on the basic maintainable properties, it is also possible to search based on the source object being categorized and target category the object is categorized against.
827
828 **//CategorisationWhereBaseType//: **CategorisationWhereBaseType is an abstract base type which forms the basis for the CategorisationWhereType.
829
830 Derivation:
831
832 * //AnnotableWhereType// (extension)
833 ** //IdentifiableWhereType// (extension)
834 *** //NameableWhereType// (extension)
835 **** //VersionableWhereType// (extension)
836 ***** //MaintainableWhereType// (restriction)
837 ****** //CategorisationWhereBaseType//
838
839 Attributes:
840 type?
841
842 Content:
843 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
844
845 Attribute Documentation:
846
847 |**Name**|**Type**|**Documentation**
848 |type (fixed: Categorisation)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
849
850 Element Documentation:
851
852 |**Name**|**Type**|**Documentation**
853 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
854 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
855 |ID|QueryIDType|ID is used to match the id of the identified object.
856 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
857 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
858 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
859 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
860 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
861 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
862 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
863
864 **CategorisationWhereType: **CategorisationWhereType contains a set of parameters for a categorisation query. All supplied parameters must be matched in order for an object to satisfy the query.
865
866 Derivation:
867 //AnnotableWhereType// (extension)
868 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
869 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
870 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
871 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
872 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //CategorisationWhereBaseType// (extension)
873 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CategorisationWhereType
874
875 Attributes:
876 type?
877
878 Content:
879 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CategoryScheme?, TargetCategory?, ObjectReference?, CategorisedObjectType*
880
881 Attribute Documentation:
882
883 |**Name**|**Type**|**Documentation**
884 |type (fixed: Categorisation)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
885
886 Element Documentation:
887
888 |**Name**|**Type**|**Documentation**
889 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
890 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
891 |ID|QueryIDType|ID is used to match the id of the identified object.
892 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
893 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
894 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
895 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
896 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
897 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
898 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
899 |CategoryScheme|com: CategorySchemeRefere nceType|CategoryScheme references a category scheme for which categorisations or sought for any of the scheme's categories. Any categorisation which has a target of a category defined in the scheme will be returned.
900 |TargetCategory|com: CategoryReferenceTyp e|TargetCategory references the category that defines the target of the categorisation (the category which an object is categorized against). Only categorisations which refence the category supplied here will be returned.
901 |ObjectReference|com: ObjectReferenceType|ObjectReference references the object that is the source of the categorisation (the object which is categorized). Only categorisations which reference the object supplied here will be returned.
902 |CategorisedObjectTyp e|com: ObjectTypeCodelistTy pe|CategorisedObjectType is used to specify the type of objects that are categorised by the categorisations being sought. For example, this could be used to find an caategorisation which classifies a code list.
903
904 **CategorySchemeQueryType: **CategorySchemeQueryType defines the structure of a category scheme query. The parameters for the query are contained in the CategorySchemeWhere element. The References element is used to indicate how objects that reference the matched category scheme should be returned.
905
906 Derivation:
907 //StructuralMetadataQueryType// (restriction)
908 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CategorySchemeQueryType
909
910 Content:
911 ReturnDetails, CategorySchemeWhere
912
913 Element Documentation:
914
915 |**Name**|**Type**|**Documentation**
916 |ReturnDetails|StructureReturnDetai lsType|
917 |CategorySchemeWhere|CategorySchemeWhereT ype|CategorySchemeWhere contains the parameters for a category scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a category scheme based on the details of its categories. In any case, the category scheme will be returned according the indicated return detail.
918
919 **CategorySchemeWhereType: **CategorySchemeWhereType defines the parameters of a category scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
920
921 Derivation:
922 //AnnotableWhereType// (extension)
923 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
924 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
925 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
926 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
927 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (restriction)
928 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CategorySchemeWhereType
929
930 Attributes:
931 type?
932
933 Content:
934 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CategoryWhere*
935
936 Attribute Documentation:
937
938 |**Name**|**Type**|**Documentation**
939 |type (fixed: CategoryScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
940
941 Element Documentation:
942
943 |**Name**|**Type**|**Documentation**
944 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
945 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
946 |ID|QueryIDType|ID is used to match the id of the identified object.
947 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
948 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
949 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
950 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
951 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
952 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
953 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
954 |CategoryWhere|CategoryWhereType|CategoryWhere is used to query for categories matching the parameters supplied. It allows for nested category queries so that hierarchical categories can be queried explicitly by their nested level, although a top level category will always result in a search for categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
955
956 **CategoryWhereType: **CategoryQueryWhereType contains a set of parameters for matching a category. All supplied parameters must be matched in order for an object to satisfy the query.
957
958 Derivation:
959 //AnnotableWhereType// (extension)
960 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
961 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
962 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
963 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CategoryWhereType
964
965 Content:
966 Annotation?, ID?, Name?, Description?, CategoryWhere*
967
968 Element Documentation:
969
970 |**Name**|**Type**|**Documentation**
971 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
972 |ID|QueryIDType|ID is used to match the id of the identified object.
973 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
974 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
975 |CategoryWhere|CategoryWhereType|CategoryWhere is used to query for categories matching the parameters supplied. It allows for nested category queries so that hierarchical categories can be queried explicitly by their nested level, although a top level category will always result in a search for categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
976
977 **CodelistQueryType: **CodelistQueryType defines the structure of a codelist query. The parameters for the query are contained in the CodelistWhere element. The References element is used to indicate how objects that reference the matched codelist should be returned.
978
979 Derivation:
980 //StructuralMetadataQueryType// (restriction)
981 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CodelistQueryType
982
983 Content:
984 ReturnDetails, CodelistWhere
985
986 Element Documentation:
987
988 |**Name**|**Type**|**Documentation**
989 |ReturnDetails|StructureReturnDetai lsType|
990 |CodelistWhere|CodelistWhereType|CodelistWhere defines the parameters for a codelist query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a codlist based on the details of its codes. In any case, the codelist will be returned according the indicated return detail.
991
992 **CodelistWhereType: **CodelistWhereType contains the parameters of a codelist query. All supplied parameters must be matched in order for an object to satisfy the query.
993
994 Derivation:
995 //AnnotableWhereType// (extension)
996 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
997 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
998 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
999 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
1000 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (restriction)
1001 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CodelistWhereType
1002
1003 Attributes:
1004 type?
1005
1006 Content:
1007 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CodeWhere*
1008
1009 Attribute Documentation:
1010
1011 |**Name**|**Type**|**Documentation**
1012 |type (fixed: Codelist)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
1013
1014 Element Documentation:
1015
1016 |**Name**|**Type**|**Documentation**
1017 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1018 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1019 |ID|QueryIDType|ID is used to match the id of the identified object.
1020 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1021 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1022 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1023 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1024 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1025 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1026 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1027 |CodeWhere|CodeWhereType|CodeWhere is used to query for codes matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
1028
1029 **CodeWhereType: **CodeWhereType defines a set of parameters for matching a code. All supplied parameters must be matched in order for an object to satisfy the query.
1030
1031 Derivation:
1032 //AnnotableWhereType// (extension)
1033 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1034 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1035 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
1036 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CodeWhereType
1037
1038 Content:
1039 Annotation?, ID?, Name?, Description?, Parent?
1040
1041 Element Documentation:
1042
1043 |**Name**|**Type**|**Documentation**
1044 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1045 |ID|QueryIDType|ID is used to match the id of the identified object.
1046 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1047 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1048 |Parent|com: LocalCodeReferenceTy pe|Parent is used to query for an item where it declares the item referenced here as its parent. This is used for items that are not nested in a hierarchy. If child items are sought for an item that is contained in a nested hierarchy (e.g. a category) on can query directly for the parent category and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details.
1049
1050 **ConceptSchemeQueryType: **ConceptSchemeQueryType defines the structure of a category scheme query. The parameters for the query are contained in the ConceptSchemeWhere element. The References element is used to indicate how objects that reference or are referenced from the matched concept scheme should be returned.
1051
1052 Derivation:
1053 //StructuralMetadataQueryType// (restriction)
1054 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ConceptSchemeQueryType
1055
1056 Content:
1057 ReturnDetails, ConceptSchemeWhere
1058
1059 Element Documentation:
1060
1061 |**Name**|**Type**|**Documentation**
1062 |ReturnDetails|StructureReturnDetai lsType|
1063 |ConceptSchemeWhere|ConceptSchemeWhereTy pe|ConceptSchemeWhere defines the parameters for a concept scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a concept scheme based on the details of its concepts. In any case, the concept scheme will be returned according the indicated return detail.
1064
1065 **ConceptSchemeWhereType: **ConceptSchemeWhereType contains the parameters of a concept scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
1066
1067 Derivation:
1068 //AnnotableWhereType// (extension)
1069 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1070 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1071 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1072 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
1073 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (restriction)
1074 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ConceptSchemeWhereType
1075
1076 Attributes:
1077 type?
1078
1079 Content:
1080 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ConceptWhere*
1081
1082 Attribute Documentation:
1083
1084 |**Name**|**Type**|**Documentation**
1085 |type (fixed: ConceptScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
1086
1087 Element Documentation:
1088
1089 |**Name**|**Type**|**Documentation**
1090 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1091 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1092 |ID|QueryIDType|ID is used to match the id of the identified object.
1093 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1094 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1095 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1096 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1097 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1098 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1099 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1100 |ConceptWhere|ConceptWhereType|ConceptWhere is used to query for concepts matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
1101
1102 **//ConceptWhereBaseType//: **ConceptWhereBaseType is an abstract base type that forms the basis for the ConceptWhereType.
1103
1104 Derivation:
1105 //AnnotableWhereType// (extension)
1106 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1107 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1108 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
1109 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ConceptWhereBaseType//
1110
1111 Content:
1112 Annotation?, ID?, Name?, Description?, Parent?
1113
1114 Element Documentation:
1115
1116 |**Name**|**Type**|**Documentation**
1117 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1118 |ID|QueryIDType|ID is used to match the id of the identified object.
1119 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1120 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1121 |Parent|com: LocalConceptReferenc eType|Parent is used to query for an item where it declares the item referenced here as its parent. This is used for items that are not nested in a hierarchy. If child items are sought for an item that is contained in a nested hierarchy (e.g. a category) on can query directly for the parent category and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details.
1122
1123 **ConceptWhereType: **ConceptWhereType defines a set of parameters for matching a concept. All supplied parameters must be matched in order for an object to satisfy the query. In addition to the base parameters for an item, a concept can be queried based on the item scheme that is used as a core representation.
1124
1125 Derivation:
1126 //AnnotableWhereType// (extension)
1127 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1128 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1129 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
1130 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ConceptWhereBaseType// (extension)
1131 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ConceptWhereType
1132
1133 Content:
1134 Annotation?, ID?, Name?, Description?, Parent?, Enumeration?
1135
1136 Element Documentation:
1137
1138 |**Name**|**Type**|**Documentation**
1139 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1140 |ID|QueryIDType|ID is used to match the id of the identified object.
1141 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1142 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1143 |Parent|com: LocalConceptReferenc eType|Parent is used to query for an item where it declares the item referenced here as its parent. This is used for items that are not nested in a hierarchy. If child items are sought for an item that is contained in a nested hierarchy (e.g. a category) on can query directly for the parent category and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details.
1144 |Enumeration|com: CodelistReferenceTyp e|Enumeration is used to query for a concept based on the codelist that is used as the enumeration for its core representation.
1145
1146 **ConstraintQueryType: **ConstraintQueryType defines the structure of a constraint query. The parameters for the query are contained in the ConstraintWhere element. The References element is used to indicate how objects that are referenced from the matched constraint should be returned.
1147
1148 Derivation:
1149 //StructuralMetadataQueryType// (restriction)
1150 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ConstraintQueryType
1151
1152 Content:
1153 ReturnDetails, ConstraintWhere
1154
1155 Element Documentation:
1156
1157 |**Name**|**Type**|**Documentation**
1158 |ReturnDetails|MaintainableReturnDe tailsType|
1159 |ConstraintWhere|ConstraintWhereType|AttachmentConstraintWhere contains the parameters for a constraint query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a constraint based on the objects it applies to.
1160
1161 **//ConstraintWhereBaseType//: **ConstraintWhereBaseType is an abstract base type which forms the basis for the ConstraintWhereType.
1162
1163 Derivation:
1164 //AnnotableWhereType// (extension)
1165 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1166 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1167 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1168 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
1169 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ConstraintWhereBaseType//
1170
1171 Attributes:
1172 type?
1173
1174 Content:
1175 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
1176
1177 Attribute Documentation:
1178
1179 |**Name**|**Type**|**Documentation**
1180 |type (default: Constraint)|ConstraintTypeCodeli stType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
1181
1182 Element Documentation:
1183
1184 |**Name**|**Type**|**Documentation**
1185 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1186 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1187 |ID|QueryIDType|ID is used to match the id of the identified object.
1188 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1189 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1190 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1191 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1192 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1193 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1194 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1195
1196 **ConstraintWhereType: **ConstraintWhereType contains the parameters of a constraint query. All supplied parameters must be matched in order for an object to stratify the query.
1197
1198 Derivation:
1199 //AnnotableWhereType// (extension)
1200 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1201 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1202 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1203 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
1204 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ConstraintWhereBaseType// (extension)
1205 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ConstraintWhereType
1206
1207 Attributes:
1208 type?, allowable?
1209
1210 Content:
1211 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ConstraintAttachmentWhere?
1212
1213 Attribute Documentation:
1214
1215 |**Name**|**Type**|**Documentation**
1216 |type (default: Constraint)|ConstraintTypeCodeli stType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
1217 |allowable|xs:boolean|The allowable attribute indicates whether the returned search should be limited to only allowable constraints. This only applies to content constraint. If this attribute has a value of true, this indicates that only matching allowable content constraints should be returned. If this is false, than only actual content constraints returned. If no value is provided, all matching content constraints will be returned, regardless of whether they are stating actual or allowable content.
1218
1219 Element Documentation:
1220
1221 |**Name**|**Type**|**Documentation**
1222 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1223 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1224 |ID|QueryIDType|ID is used to match the id of the identified object.
1225 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1226 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1227 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1228 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1229 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1230 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1231 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1232 |ConstraintAttachment Where|ConstraintAttachment WhereType|ConstraintAttachmentWhere identifies a collection of objects to which a constraint may be attached. This container is an implicit and-query, meaning all of the objects referenced in here must be part of the constraint attachment in order for a constraint to match.
1233
1234 **ConstraintAttachmentWhereType: **ConstraintAttachmentWhereType describes the structure for querying for a constraint based on the objects it is attached to. A constraint attachment query is implicitly an and-query meaning all of the referenced objects must be part of a constraints attachment in order to return a match. It is treated as a condition within its parent query.
1235
1236 Content:
1237 (DataProvider | Dataflow | DataStructure | Metadataflow | MetadataStructure | ProvisionAgreement | DataSet | MetadataSet | DataSourceURL)+
1238
1239 Element Documentation:
1240
1241 |**Name**|**Type**|**Documentation**
1242 |DataProvider|com: DataProviderReferenc eType|DataProviderReference references a data provider to which a constraint is attached. It is referenced via a URN and/or a full set of reference fields. If a constraint is attached to the data provider referenced, a match will be returned.
1243 |Dataflow|com: DataflowReferenceTyp e|DataflowReference references a data flow to which a constraint is attached. It is referenced via a URN and/or a full set of reference fields. If a constraint is attached to the data flow referenced, a match will be returned.
1244 |DataStructure|com: DataStructureReferen ceType|DataStructureReference references a data structure definition to which a constraint is attached. It is referenced via a URN and/or a full set of reference fields. If a constraint is attached to the data structure definition referenced, a match will be returned.
1245 |Metadataflow|com: MetadataflowReferenc eType|MetadataflowReference references a metadata flow to which a constraint is attached. It is referenced via a URN and/or a full set of reference fields. If a constraint is attached to the metadata flow referenced, a match will be returned.
1246 |MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructureReference references a metadata structure definition to which a constraint is attached. It is referenced via a URN and/or a full set of reference fields. If a constraint is attached to the metadata structure definition referenced, a match will be returned.
1247 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference references a provision agreement to which a constraint is attached. It is referenced via a URN and/or a full set of reference fields. If a constraint is attached to the provision agreement referenced, a match will be returned.
1248 |DataSet|com:SetReferenceType|DataSetReference references a data set to which a constraint is attached. If a constraint is attached to the data set referenced, a match will be returned.
1249 |MetadataSet|com:SetReferenceType|MetadataSetReference references a reference metadata set to which a constraint is attached. If a constraint is attached to the metadata set referenced, a match will be returned.
1250 |DataSourceURL|xs:anyURI|DataSourceURL references a queryable data source to which a constraint it attached. The data source is referenced by its data URL. If a constraint is attached to the data source described (by matching the data URL), a match will be returned.
1251
1252 **DataQueryType: **DataQueryType defines the structure of a query for data. This is generally appliable for any data request, but can be refined depending on the type of data being queried (generic or structured, time series specific or not) to the requirements of the requested format.
1253
1254 Content:
1255 ReturnDetails, DataWhere
1256
1257 Element Documentation:
1258
1259 |**Name**|**Type**|**Documentation**
1260 |ReturnDetails|DataReturnDetailsTyp e|ReturnDetails contains the details of how the returned data should be structured, what type of data (e.g. active or deleted observations), and the limit of the amount of observations to be returned.
1261 |DataWhere|DataParametersAndTyp e|DataWhere contains the details of the data query.
1262
1263 **TimeSeriesDataQueryType: **TimeSeriesDataQueryType defines the structure of a query for data. This specifically applies to requesting time series only structured data.
1264
1265 Derivation:
1266 DataQueryType (restriction)
1267 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TimeSeriesDataQueryType
1268
1269 Content:
1270 ReturnDetails, DataWhere
1271
1272 Element Documentation:
1273
1274 |**Name**|**Type**|**Documentation**
1275 |ReturnDetails|TimeSeriesDataReturn DetailsType|ReturnDetails contains the details of how the returned data should be structured, what type of data (e.g. active or deleted observations), and the limit of the amount of observations to be returned.
1276 |DataWhere|DataParametersAndTyp e|DataWhere contains the details of the data query.
1277
1278 **GenericDataQueryType: **GenericDataQueryType defines the structure of a query for data formatted in the generic format. This structure generally applies to any type of generic data request, but can be refined to request time series only data.
1279
1280 Derivation:
1281 DataQueryType (restriction)
1282 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataQueryType
1283
1284 Content:
1285 ReturnDetails, DataWhere
1286
1287 Element Documentation:
1288
1289 |**Name**|**Type**|**Documentation**
1290 |ReturnDetails|GenericDataReturnDet ailsType|ReturnDetails contains the details of how the returned data should be structured, what type of data (e.g. active or deleted observations), and the limit of the amount of observations to be returned.
1291 |DataWhere|DataParametersAndTyp e|DataWhere contains the details of the data query.
1292
1293 **GenericTimeSeriesDataQueryType: **GenericTimeSeriesDataQueryType defines the structure of a query for time series only data formatted in the generic format.
1294
1295 Derivation:
1296 DataQueryType (restriction)
1297 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataQueryType (restriction)
1298 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericTimeSeriesDataQueryType
1299
1300 Content:
1301 ReturnDetails, DataWhere
1302
1303 Element Documentation:
1304
1305 |**Name**|**Type**|**Documentation**
1306 |ReturnDetails|GenericTimeSeriesDat aReturnDetailsType|ReturnDetails contains the details of how the returned data should be structured, what type of data (e.g. active or deleted observations), and the limit of the amount of observations to be returned.
1307 |DataWhere|DataParametersAndTyp e|DataWhere contains the details of the data query.
1308
1309 **//DataReturnDetailsBaseType//: **DataReturnDetailsBaseType is an abstract base type which forms the basis of the DataReturnDetailsType.
1310
1311 Derivation:
1312 //ReturnDetailsBaseType// (restriction)
1313 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DataReturnDetailsBaseType//
1314
1315 Attributes:
1316 defaultLimit?, detail?
1317
1318 Content:
1319 {Empty}
1320
1321 Attribute Documentation:
1322
1323 |**Name**|**Type**|**Documentation**
1324 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
1325 |detail (default: Full)|DataReturnDetailType|The detail attribute is used to indicate whether the response to the query should return the full details of matched data sets, or just a subset of the information should be returned. A value of "Full" indicates that the complete data set (including data and documentation) will be returned. A value of "DataOnly" indicates that only the observation values and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. Dimension values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the DataSet, Group, and Series level Attributes).
1326
1327 **DataReturnDetailsType: **DataReturnDetailsType specifies the specifics of the how data should be returned, including how it should be structured and how many and what type (e.g. active or deleted) observations should be returned.
1328
1329 Derivation:
1330 //ReturnDetailsBaseType// (restriction)
1331 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DataReturnDetailsBaseType// (extension)
1332 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataReturnDetailsType
1333
1334 Attributes:
1335 defaultLimit?, detail?, observationAction?
1336
1337 Content:
1338 FirstNObservations?, LastNObservations?, Structure*
1339
1340 Attribute Documentation:
1341
1342 |**Name**|**Type**|**Documentation**
1343 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
1344 |detail (default: Full)|DataReturnDetailType|The detail attribute is used to indicate whether the response to the query should return the full details of matched data sets, or just a subset of the information should be returned. A value of "Full" indicates that the complete data set (including data and documentation) will be returned. A value of "DataOnly" indicates that only the observation values and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. Dimension values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the DataSet, Group, and Series level Attributes).
1345 |observationAction (default: Active)|ObservationActionCod eType|The observationAction attribute specifies the type of observations (added, deleted, udpated, or current) to be returned. In the absence of the Updated parameter, this will return all observations that have ever existed for Added, any observations that have ever been updated for Updated, and any observations that have ever been deleted for Deleted. Note that since observations themselves contain no status in the data messages, it is only possible to query for active observations or deleted observations, but not both. It is possible to subset active observation into recently added and recently updated, however it is only possible to retrieve on or the other. If active observations are returned, there will be no distinction as to whether an individual observation was updated or added during the requested Update parameter.
1346
1347 Element Documentation:
1348
1349 |**Name**|**Type**|**Documentation**
1350 |FirstNObservations|xs:int|FirstNObservations specifies that number of observations indicated should be returned, starting from the earliest observation. Note that this can be used in conjunction with the LastNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1351 |LastNObservations|xs:int|LastNObservations specifies that number of observations indicated should be returned, starting from the latest observation and working back. Note that this can be used in conjunction with the FirstNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1352 |Structure|com: DataStructureRequest Type|Structure defines how the is requested to be oriented in the returned message. For each data structure, dataflow, or provision agreement, a dimension at the observation level can be specified, and in the case that the dimension is a measure and the query is for structured data, the measure can be specified as being explicit. For any matched data in which there is not a structure specification, the query service can orient that data in any manner, although it is recommended that time be used as the observation dimension.
1353
1354 **GenericDataReturnDetailsType: **GenericDataReturnDetailsType specifies the specifics of the how data should be returned as it pertains to a request for generic data.
1355
1356 Derivation:
1357 //ReturnDetailsBaseType// (restriction)
1358 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DataReturnDetailsBaseType// (extension)
1359 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataReturnDetailsType (restriction)
1360 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataReturnDetailsType
1361
1362 Attributes:
1363 defaultLimit?, detail?, observationAction?
1364
1365 Content:
1366 FirstNObservations?, LastNObservations?, Structure*
1367
1368 Attribute Documentation:
1369
1370 |**Name**|**Type**|**Documentation**
1371 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
1372 |detail (default: Full)|DataReturnDetailType|The detail attribute is used to indicate whether the response to the query should return the full details of matched data sets, or just a subset of the information should be returned. A value of "Full" indicates that the complete data set (including data and documentation) will be returned. A value of "DataOnly" indicates that only the observation values and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. Dimension values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the DataSet, Group, and Series level Attributes).
1373 |observationAction (default: Active)|ObservationActionCod eType|The observationAction attribute specifies the type of observations (added, deleted, udpated, or current) to be returned. In the absence of the Updated parameter, this will return all observations that have ever existed for Added, any observations that have ever been updated for Updated, and any observations that have ever been deleted for Deleted. Note that since observations themselves contain no status in the data messages, it is only possible to query for active observations or deleted observations, but not both. It is possible to subset active observation into recently added and recently updated, however it is only possible to retrieve on or the other. If active observations are returned, there will be no distinction as to whether an individual observation was updated or added during the requested Update parameter.
1374
1375 Element Documentation:
1376
1377 |**Name**|**Type**|**Documentation**
1378 |FirstNObservations|xs:int|FirstNObservations specifies that number of observations indicated should be returned, starting from the earliest observation. Note that this can be used in conjunction with the LastNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1379 |LastNObservations|xs:int|LastNObservations specifies that number of observations indicated should be returned, starting from the latest observation and working back. Note that this can be used in conjunction with the FirstNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1380 |Structure|com: GenericDataStructure RequestType|Structure defines how the is requested to be oriented in the returned message. For each data structure, dataflow, or provision agreement, a dimension at the observation level can be specified, and in the case that the dimension is a measure and the query is for structured data, the measure can be specified as being explicit. For any matched data in which there is not a structure specification, the query service can orient that data in any manner, although it is recommended that time be used as the observation dimension.
1381
1382 **GenericTimeSeriesDataReturnDetailsType: **GenericTimeSeriesDataReturnDetailsType specifies the specifics of the how data should be returned as it pertains to a request for time series only oriented data in the generic format.
1383
1384 Derivation:
1385 //ReturnDetailsBaseType// (restriction)
1386 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DataReturnDetailsBaseType// (extension)
1387 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataReturnDetailsType (restriction)
1388 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataReturnDetailsType (restriction)
1389 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericTimeSeriesDataReturnDetailsType
1390
1391 Attributes:
1392 defaultLimit?, detail?, observationAction?
1393
1394 Content:
1395 FirstNObservations?, LastNObservations?, Structure*
1396
1397 Attribute Documentation:
1398
1399 |**Name**|**Type**|**Documentation**
1400 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
1401 |detail (default: Full)|DataReturnDetailType|The detail attribute is used to indicate whether the response to the query should return the full details of matched data sets, or just a subset of the information should be returned. A value of "Full" indicates that the complete data set (including data and documentation) will be returned. A value of "DataOnly" indicates that only the observation values and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. Dimension values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the DataSet, Group, and Series level Attributes).
1402 |observationAction (default: Active)|ObservationActionCod eType|The observationAction attribute specifies the type of observations (added, deleted, udpated, or current) to be returned. In the absence of the Updated parameter, this will return all observations that have ever existed for Added, any observations that have ever been updated for Updated, and any observations that have ever been deleted for Deleted. Note that since observations themselves contain no status in the data messages, it is only possible to query for active observations or deleted observations, but not both. It is possible to subset active observation into recently added and recently updated, however it is only possible to retrieve on or the other. If active observations are returned, there will be no distinction as to whether an individual observation was updated or added during the requested Update parameter.
1403
1404 Element Documentation:
1405
1406 |**Name**|**Type**|**Documentation**
1407 |FirstNObservations|xs:int|FirstNObservations specifies that number of observations indicated should be returned, starting from the earliest observation. Note that this can be used in conjunction with the LastNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1408 |LastNObservations|xs:int|LastNObservations specifies that number of observations indicated should be returned, starting from the latest observation and working back. Note that this can be used in conjunction with the FirstNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1409 |Structure|com: TimeSeriesGenericDat aStructureRequestTyp e|Structure defines how the is requested to be oriented in the returned message. For each data structure, dataflow, or provision agreement, a dimension at the observation level can be specified, and in the case that the dimension is a measure and the query is for structured data, the measure can be specified as being explicit. For any matched data in which there is not a structure specification, the query service can orient that data in any manner, although it is recommended that time be used as the observation dimension.
1410
1411 **TimeSeriesDataReturnDetailsType: **TimeSeriesDataReturnDetailsType specifies the specifics of the how data should be returned as it pertains to a request for time series only oriented data in the structured format.
1412
1413 Derivation:
1414 //ReturnDetailsBaseType// (restriction)
1415 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DataReturnDetailsBaseType// (extension)
1416 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataReturnDetailsType (restriction)
1417 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TimeSeriesDataReturnDetailsType
1418
1419 Attributes:
1420 defaultLimit?, detail?, observationAction?
1421
1422 Content:
1423 FirstNObservations?, LastNObservations?, Structure*
1424
1425 Attribute Documentation:
1426
1427 |**Name**|**Type**|**Documentation**
1428 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
1429 |detail (default: Full)|DataReturnDetailType|The detail attribute is used to indicate whether the response to the query should return the full details of matched data sets, or just a subset of the information should be returned. A value of "Full" indicates that the complete data set (including data and documentation) will be returned. A value of "DataOnly" indicates that only the observation values and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. Dimension values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the DataSet, Group, and Series level Attributes).
1430 |observationAction (default: Active)|ObservationActionCod eType|The observationAction attribute specifies the type of observations (added, deleted, udpated, or current) to be returned. In the absence of the Updated parameter, this will return all observations that have ever existed for Added, any observations that have ever been updated for Updated, and any observations that have ever been deleted for Deleted. Note that since observations themselves contain no status in the data messages, it is only possible to query for active observations or deleted observations, but not both. It is possible to subset active observation into recently added and recently updated, however it is only possible to retrieve on or the other. If active observations are returned, there will be no distinction as to whether an individual observation was updated or added during the requested Update parameter.
1431
1432 Element Documentation:
1433
1434 |**Name**|**Type**|**Documentation**
1435 |FirstNObservations|xs:int|FirstNObservations specifies that number of observations indicated should be returned, starting from the earliest observation. Note that this can be used in conjunction with the LastNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1436 |LastNObservations|xs:int|LastNObservations specifies that number of observations indicated should be returned, starting from the latest observation and working back. Note that this can be used in conjunction with the FirstNObservations. For example, if both FirstNObservations and LastNObservations had a value of 1, then the first and the last observation would be returned.
1437 |Structure|com: TimeSeriesDataStruct ureRequestType|Structure defines how the is requested to be oriented in the returned message. For each data structure, dataflow, or provision agreement, a dimension at the observation level can be specified, and in the case that the dimension is a measure and the query is for structured data, the measure can be specified as being explicit. For any matched data in which there is not a structure specification, the query service can orient that data in any manner, although it is recommended that time be used as the observation dimension.
1438
1439 **//DataParametersType//: **DataParametersType defines the parameters for querying for data. This structure is refined by separate And/Or constructs which make logical restrictions on which parameters apply in such cases.
1440
1441 Content:
1442 DataSetID*, DataProvider*, DataStructure*, Dataflow*, ProvisionAgreement*, Category*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue*, AttributeValue*, PrimaryMeasureValue*, AttachmentConstraint*, TimeFormat*, Or*, And*
1443
1444 Element Documentation:
1445
1446 |**Name**|**Type**|**Documentation**
1447 |DataSetID|QueryIDType|DataSetID is used to match the id of the data set. Only data from data sets with an identifier satisfying these conditions will be matched.
1448 |DataProvider|com: DataProviderReferenc eType|DataProvider is used to match the provider of data to the referenced data provider. Only data from data sets provided by the referenced data provider will be matched.
1449 |DataStructure|com: DataStructureReferen ceType|DataStructure is used to match the underlying structure of the data. Only data from data sets that conform to referenced data structure definition will be matched.
1450 |Dataflow|com: DataflowReferenceTyp e|Dataflow is used to match the flow which data is reported against. Only data from data sets report against referenced dataflow will be matched.
1451 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement is used to match the provision agreement which data is reported against. Only data from data sets report against the referenced provision agreement will be matched.
1452 |Category|com: CategoryReferenceTyp e|Category is used to match a data based on the categorization of its underlying structure (data structure definition), or the usage of that structure (data flow). Only data whose underlying structure or structure usage are categorized against the referenced category will be matched.
1453 |Updated|com: TimeRangeValueType|Updated is used to match data based on when it was last updated (including additions and deletions). Only data which satisfies the conditions for the last update parameters supplied here will be matched.
1454 |ConceptValue|ConceptValueType|ConceptValue is used to match data based on the value of a particular concept. This concept may be used as a dimension, attribute, or measure for the data. So long as the referenced concept has the specified value for a given data point, it will be matched.
1455 |RepresentationValue|CodeValueType|RepresentationValue is used to match data based on a representation scheme having a particular value. This representation scheme may be used as the representation of a dimension, attribute, or measure. So long as the value of the concept using the referenced codelist has the value specified, any data point for the concept will be matched.
1456 |DimensionValue|DimensionValueType|DimensionValue is used to match data based on the value of a dimension. Any data with the dimension with the supplied identifier satisfies the conditions supplied will be matched.
1457 |TimeDimensionValue|TimeDimensionValueTy pe|TimeDimensionValue is used to match data based on the value of the time dimension. Any data with a time value satisfying the conditions supplied will be matched.
1458 |AttributeValue|AttributeValueType|AttributeValue is used to match data based on the value of an attribute. Any data with an attribute with the supplied identifier satisfies the conditions supplied will be matched.
1459 |PrimaryMeasureValue|PrimaryMeasureValueT ype|PrimaryMeasureValue is used to match data based on the value of the primary measure. Any data with its value satisfying the conditions supplied will be matched.
1460 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint in order to match data which matches the effective data keys or cube regions defined in the constraint. Data will be returned by first matching data on the keys and cube regions that are marked as included (or all data if none), and then excluding the data that satisfies the conditions of the excluded keys and cube regions.
1461 |TimeFormat|com:TimeDataType|TimeFormat is used to match data when a frequency dimension is not explicitly defined. Only data reported against the supplied time data type will be returned.
1462 |Or|DataParametersOrType|Or contains a collection of additional parameters, any one of which can be satisfied to result in a match.
1463 |And|DataParametersAndTyp e|And contains a collection of additional parameters, all of which must be satisfied to result in a match.
1464
1465 **DataParametersOrType: **DataParametersOrType refines the base data parameters to define a set of parameters joined by an "or" condition. Only one of the parameters supplied in an instance of this type can be satisfied to result in a match.
1466
1467 Derivation:
1468 //DataParametersType// (restriction)
1469 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataParametersOrType
1470
1471 Content:
1472 DataSetID*, DataProvider*, DataStructure*, Dataflow*, ProvisionAgreement*, Category*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue*, AttributeValue*, PrimaryMeasureValue*, AttachmentConstraint*, TimeFormat*, And*
1473
1474 Element Documentation:
1475
1476 |**Name**|**Type**|**Documentation**
1477 |DataSetID|QueryIDType|DataSetID is used to match the id of the data set. Only data from data sets with an identifier satisfying these conditions will be matched.
1478 |DataProvider|com: DataProviderReferenc eType|DataProvider is used to match the provider of data to the referenced data provider. Only data from data sets provided by the referenced data provider will be matched.
1479 |DataStructure|com: DataStructureReferen ceType|DataStructure is used to match the underlying structure of the data. Only data from data sets that conform to referenced data structure definition will be matched.
1480 |Dataflow|com: DataflowReferenceTyp e|Dataflow is used to match the flow which data is reported against. Only data from data sets report against referenced dataflow will be matched.
1481 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement is used to match the provision agreement which data is reported against. Only data from data sets report against the referenced provision agreement will be matched.
1482 |Category|com: CategoryReferenceTyp e|Category is used to match a data based on the categorization of its underlying structure (data structure definition), or the usage of that structure (data flow). Only data whose underlying structure or structure usage are categorized against the referenced category will be matched.
1483 |Updated|com: TimeRangeValueType|Updated is used to match data based on when it was last updated (including additions and deletions). Only data which satisfies the conditions for the last update parameters supplied here will be matched.
1484 |ConceptValue|ConceptValueType|ConceptValue is used to match data based on the value of a particular concept. This concept may be used as a dimension, attribute, or measure for the data. So long as the referenced concept has the specified value for a given data point, it will be matched.
1485 |RepresentationValue|CodeValueType|RepresentationValue is used to match data based on a representation scheme having a particular value. This representation scheme may be used as the representation of a dimension, attribute, or measure. So long as the value of the concept using the referenced codelist has the value specified, any data point for the concept will be matched.
1486 |DimensionValue|DimensionValueType|DimensionValue is used to match data based on the value of a dimension. Any data with the dimension with the supplied identifier satisfies the conditions supplied will be matched.
1487 |TimeDimensionValue|TimeDimensionValueTy pe|TimeDimensionValue is used to match data based on the value of the time dimension. Any data with a time value satisfying the conditions supplied will be matched.
1488 |AttributeValue|AttributeValueType|AttributeValue is used to match data based on the value of an attribute. Any data with an attribute with the supplied identifier satisfies the conditions supplied will be matched.
1489 |PrimaryMeasureValue|PrimaryMeasureValueT ype|PrimaryMeasureValue is used to match data based on the value of the primary measure. Any data with its value satisfying the conditions supplied will be matched.
1490 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint in order to match data which matches the effective data keys or cube regions defined in the constraint. Data will be returned by first matching data on the keys and cube regions that are marked as included (or all data if none), and then excluding the data that satisfies the conditions of the excluded keys and cube regions.
1491 |TimeFormat|com:TimeDataType|TimeFormat is used to match data when a frequency dimension is not explicitly defined. Only data reported against the supplied time data type will be returned.
1492 |And|DataParametersAndTyp e|And contains a collection of additional parameters, all of which must be satisfied to result in a match.
1493
1494 **DataParametersAndType: **DataParametersAndType refines the base data parameters to define a set of parameters joined by an "and" conditions. All of the parameters supplied in an instance of this type must be satisfied to result in a match. As a result of this condition, the maximum occurrence of some parameters has been reduced so as to not allow for impossible conditions to be specified (for example data cannot be matched is it is specified that the data set identifier should be "xyz" and the data identifier should be "abc".
1495
1496 Derivation:
1497 //DataParametersType// (restriction)
1498 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataParametersAndType
1499
1500 Content:
1501 DataSetID?, DataProvider?, DataStructure?, Dataflow?, ProvisionAgreement?, Category*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue?, AttributeValue*, PrimaryMeasureValue?, AttachmentConstraint*, TimeFormat?, Or*
1502
1503 Element Documentation:
1504
1505 |**Name**|**Type**|**Documentation**
1506 |DataSetID|QueryIDType|DataSetID is used to match the id of the data set. Only data from data sets with an identifier satisfying these conditions will be matched.
1507 |DataProvider|com: DataProviderReferenc eType|DataProvider is used to match the provider of data to the referenced data provider. Only data from data sets provided by the referenced data provider will be matched.
1508 |DataStructure|com: DataStructureReferen ceType|DataStructure is used to match the underlying structure of the data. Only data from data sets that conform to referenced data structure definition will be matched.
1509 |Dataflow|com: DataflowReferenceTyp e|Dataflow is used to match the flow which data is reported against. Only data from data sets report against referenced dataflow will be matched.
1510 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement is used to match the provision agreement which data is reported against. Only data from data sets report against the referenced provision agreement will be matched.
1511 |Category|com: CategoryReferenceTyp e|Category is used to match a data based on the categorization of its underlying structure (data structure definition), or the usage of that structure (data flow). Only data whose underlying structure or structure usage are categorized against the referenced category will be matched.
1512 |Updated|com: TimeRangeValueType|Updated is used to match data based on when it was last updated (including additions and deletions). Only data which satisfies the conditions for the last update parameters supplied here will be matched.
1513 |ConceptValue|ConceptValueType|ConceptValue is used to match data based on the value of a particular concept. This concept may be used as a dimension, attribute, or measure for the data. So long as the referenced concept has the specified value for a given data point, it will be matched.
1514 |RepresentationValue|CodeValueType|RepresentationValue is used to match data based on a representation scheme having a particular value. This representation scheme may be used as the representation of a dimension, attribute, or measure. So long as the value of the concept using the referenced codelist has the value specified, any data point for the concept will be matched.
1515 |DimensionValue|DimensionValueType|DimensionValue is used to match data based on the value of a dimension. Any data with the dimension with the supplied identifier satisfies the conditions supplied will be matched.
1516 |TimeDimensionValue|TimeDimensionValueTy pe|TimeDimensionValue is used to match data based on the value of the time dimension. Any data with a time value satisfying the conditions supplied will be matched.
1517 |AttributeValue|AttributeValueType|AttributeValue is used to match data based on the value of an attribute. Any data with an attribute with the supplied identifier satisfies the conditions supplied will be matched.
1518 |PrimaryMeasureValue|PrimaryMeasureValueT ype|PrimaryMeasureValue is used to match data based on the value of the primary measure. Any data with its value satisfying the conditions supplied will be matched.
1519 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint in order to match data which matches the effective data keys or cube regions defined in the constraint. Data will be returned by first matching data on the keys and cube regions that are marked as included (or all data if none), and then excluding the data that satisfies the conditions of the excluded keys and cube regions.
1520 |TimeFormat|com:TimeDataType|TimeFormat is used to match data when a frequency dimension is not explicitly defined. Only data reported against the supplied time data type will be returned.
1521 |Or|DataParametersOrType|Or contains a collection of additional parameters, any one of which can be satisfied to result in a match.
1522
1523 **//DataStructureComponentValueQueryType//: **DataStructureComponentValueQueryType is an abstract base type that is the basis for query a data structure definition component for a particular value. Multiple values may be supplied, but the component value must match all of the value conditions supplied in order to return a match.
1524
1525 Content:
1526 ID?, (NumericValue[1..2] | TextValue+ | TimeValue[1..2] | Value)?
1527
1528 Element Documentation:
1529
1530 |**Name**|**Type**|**Documentation**
1531 |ID|com:NCNameIDType|ID provides the identifier for component for which the value is sought.
1532 |NumericValue|NumericValueType|NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.
1533 |TextValue|QueryTextType|TextValue is used to query for the value of a concept or component based on textual parameters. The text value can be language specific (where parallel multi-lingual values are available) and is qualified with an operator indicating how the supplied text should be matched against the sought components. If only a simple equality check is necessary, regardless of language, the Value element can be used.
1534 |TimeValue|TimePeriodValueType|TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
1535 |Value|SimpleValueType|Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.
1536
1537 **DimensionValueType: **DimensionValueType is used to query for data where a given dimension has a particular value.
1538
1539 Derivation:
1540 //DataStructureComponentValueQueryType// (restriction)
1541 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DimensionValueType
1542
1543 Content:
1544 ID, (NumericValue[1..2] | TimeValue[1..2] | Value)
1545
1546 Element Documentation:
1547
1548 |**Name**|**Type**|**Documentation**
1549 |ID|com:NCNameIDType|ID provides the identifier for component for which the value is sought.
1550 |NumericValue|NumericValueType|NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.
1551 |TimeValue|TimePeriodValueType|TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
1552 |Value|SimpleValueType|Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.
1553
1554 **AttributeValueType: **AttributeValueType is used to query for data where a given attribute has a particular value.
1555
1556 Derivation:
1557 //DataStructureComponentValueQueryType// (restriction)
1558 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] AttributeValueType
1559
1560 Content:
1561 ID, (NumericValue[1..2] | TextValue | TimeValue[1..2] | Value)
1562
1563 Element Documentation:
1564
1565 |**Name**|**Type**|**Documentation**
1566 |ID|com:NCNameIDType|ID provides the identifier for component for which the value is sought.
1567 |NumericValue|NumericValueType|NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.
1568 |TextValue|QueryTextType|TextValue is used to query for the value of a concept or component based on textual parameters. The text value can be language specific (where parallel multi-lingual values are available) and is qualified with an operator indicating how the supplied text should be matched against the sought components. If only a simple equality check is necessary, regardless of language, the Value element can be used.
1569 |TimeValue|TimePeriodValueType|TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
1570 |Value|SimpleValueType|Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.
1571
1572 **PrimaryMeasureValueType: **PrimaryMeasureValueType is used to query for data where the primary measure (i.e. the observed value) has a particular value.
1573
1574 Derivation:
1575 //DataStructureComponentValueQueryType// (restriction)
1576 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] PrimaryMeasureValueType
1577
1578 Content:
1579 ID?, (NumericValue[1..2] | TextValue | TimeValue[1..2] | Value)
1580
1581 Element Documentation:
1582
1583 |**Name**|**Type**|**Documentation**
1584 |ID|com:NCNameIDType|ID provides the identifier for component for which the value is sought.
1585 |NumericValue|NumericValueType|NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.
1586 |TextValue|QueryTextType|TextValue is used to query for the value of a concept or component based on textual parameters. The text value can be language specific (where parallel multi-lingual values are available) and is qualified with an operator indicating how the supplied text should be matched against the sought components. If only a simple equality check is necessary, regardless of language, the Value element can be used.
1587 |TimeValue|TimePeriodValueType|TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
1588 |Value|SimpleValueType|Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.
1589
1590 **TimeDimensionValueType: **TimeDimensionValueType is used to query for data where the time dimension has a particular value.
1591
1592 Derivation:
1593 //DataStructureComponentValueQueryType// (restriction)
1594 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TimeDimensionValueType
1595
1596 Content:
1597 ID?, TimeValue[1..2]
1598
1599 Element Documentation:
1600
1601 |**Name**|**Type**|**Documentation**
1602 |ID|com:NCNameIDType|ID provides the identifier for component for which the value is sought.
1603 |TimeValue|TimePeriodValueType|TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
1604
1605 **DataflowQueryType: **DataflowQueryType defines the structure of a dataflow query. The parameters for the query are contained in the DataflowWhere element. The References element is used to indicate how objects that reference or are referenced from the matched dataflow should be returned.
1606
1607 Derivation:
1608 //StructuralMetadataQueryType// (restriction)
1609 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataflowQueryType
1610
1611 Content:
1612 ReturnDetails, DataflowWhere
1613
1614 Element Documentation:
1615
1616 |**Name**|**Type**|**Documentation**
1617 |ReturnDetails|MaintainableReturnDe tailsType|
1618 |DataflowWhere|DataflowWhereType|DataflowWhere defines the parameters for a dataflow query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a dataflow based on the key family it defines the usage of.
1619
1620 **DataflowWhereType: **DataflowWhereType contains the parameters of a dataflow query. All supplied parameters must be matched in order for an object to satisfy the query.
1621
1622 Derivation:
1623 //AnnotableWhereType// (extension)
1624 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1625 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1626 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1627 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
1628 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureUsageWhereType// (restriction)
1629 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataflowWhereType
1630
1631 Attributes:
1632 type?
1633
1634 Content:
1635 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure?
1636
1637 Attribute Documentation:
1638
1639 |**Name**|**Type**|**Documentation**
1640 |type (fixed: Dataflow)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
1641
1642 Element Documentation:
1643
1644 |**Name**|**Type**|**Documentation**
1645 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1646 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1647 |ID|QueryIDType|ID is used to match the id of the identified object.
1648 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1649 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1650 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1651 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1652 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1653 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1654 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1655 |Structure|com: DataStructureReferen ceType|Structure is used to indicate which key family the dataflow must define a usage for in order to constitute a match.
1656
1657 **DataStructureQueryType: **DataStructureQueryType defines the structure of a data structure definition query. The parameters for the query are contained in the DataStructureWhere element. The References element is used to indicate how objects that reference or are referenced from the matched data structure definition should be returned.
1658
1659 Derivation:
1660 //StructuralMetadataQueryType// (restriction)
1661 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureQueryType
1662
1663 Content:
1664 ReturnDetails, DataStructureWhere
1665
1666 Element Documentation:
1667
1668 |**Name**|**Type**|**Documentation**
1669 |ReturnDetails|MaintainableReturnDe tailsType|
1670 |DataStructureWhere|DataStructureWhereTy pe|DataStructureWhere contains the parameters for a data structure definition query. All parameters must be matched for an object to satisfy the query. The query is simply a refinement of the base structure query to make the parameters specific to the data structure definition.
1671
1672 **//DataStructureWhereBaseType//: **DataStructureWhereBaseType is an abstract base type that forms the basis of the DataStructureWhereType.
1673
1674 Derivation:
1675 //AnnotableWhereType// (extension)
1676 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1677 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1678 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1679 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
1680 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureWhereType// (restriction)
1681 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DataStructureWhereBaseType//
1682
1683 Attributes:
1684 type?
1685
1686 Content:
1687 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, GroupWhere*
1688
1689 Attribute Documentation:
1690
1691 |**Name**|**Type**|**Documentation**
1692 |type (fixed: DataStructure)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
1693
1694 Element Documentation:
1695
1696 |**Name**|**Type**|**Documentation**
1697 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1698 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1699 |ID|QueryIDType|ID is used to match the id of the identified object.
1700 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1701 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1702 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1703 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1704 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1705 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1706 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1707 |UsedConcept|com: ConceptReferenceType|UsedConcept is used to query for a structure that uses the referenced concept as the basis of one of its components.
1708 |UsedRepresentation|com: DataStructureEnumera tionSchemeReferenceT ype|UsedRepresentation is used to query for a structure that uses the referenced item scheme for the representation of one of its components.
1709 |GroupWhere|GroupWhereType|GroupWhere is used to query for a data structure definition that contains a group meeting the conditions detailed in this container. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1710
1711 **DataStructureWhereType: **DataStructureWhereType defines the parameters of a data structure definition query. In addition to querying based on the identification, it is also possible to search for data structure definitions based on information about its components.
1712
1713 Derivation:
1714 //AnnotableWhereType// (extension)
1715 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1716 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1717 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1718 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
1719 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureWhereType// (restriction)
1720 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DataStructureWhereBaseType// (extension)
1721 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureWhereType
1722
1723 Attributes:
1724 type?
1725
1726 Content:
1727 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, GroupWhere*, AttributeWhere*, DimensionWhere*, MeasureDimensionWhere?, TimeDimensionWhere?, PrimaryMeasureWhere?
1728
1729 Attribute Documentation:
1730
1731 |**Name**|**Type**|**Documentation**
1732 |type (fixed: DataStructure)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
1733
1734 Element Documentation:
1735
1736 |**Name**|**Type**|**Documentation**
1737 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1738 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1739 |ID|QueryIDType|ID is used to match the id of the identified object.
1740 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1741 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1742 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1743 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1744 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1745 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1746 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1747 |UsedConcept|com: ConceptReferenceType|UsedConcept is used to query for a structure that uses the referenced concept as the basis of one of its components.
1748 |UsedRepresentation|com: DataStructureEnumera tionSchemeReferenceT ype|UsedRepresentation is used to query for a structure that uses the referenced item scheme for the representation of one of its components.
1749 |GroupWhere|GroupWhereType|GroupWhere is used to query for a data structure definition that contains a group meeting the conditions detailed in this container. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1750 |AttributeWhere|AttributeWhereType|AttributeWhere is used to query for a data structure definition that contains an attribute meeting the conditions contained in this structure. The attribute can be queried based on its identification, the concept from which it takes its semantic, its attachment level, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1751 |DimensionWhere|DimensionWhereType|DimensionWhere is used to query for a data structure definition that contains a dimension meeting the conditions contained in this structure. The dimension can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1752 |MeasureDimensionWher e|MeasureDimensionWher eType|MeasureDimensionWhere is used to query for a data structure definition that contains a measure dimension meeting the conditions contained in this structure. The cross-sectional measure can be queried based on its identification, the concept from which it takes its semantic, and the concept scheme it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1753 |TimeDimensionWhere|TimeDimensionWhereTy pe|TimeDimensionWhere is used to query for a data structure definition that contains a time dimension meeting the conditions contained in this structure. The time dimension can be queried based on its identification and the concept from which it takes its semantic. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1754 |PrimaryMeasureWhere|PrimaryMeasureWhereT ype|PrimaryMeasureWhere is used to query for a data structure definition that contains a primary measure meeting the conditions contained in this structure. The primary measure can be queried based on its identification, the concept from which it takes its semantic, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1755
1756 **//GroupWhereBaseType//: **GroupWhereBaseType is an abstract base type that forms the basis for the GroupWhereType.
1757
1758 Derivation:
1759 //AnnotableWhereType// (extension)
1760 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1761 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentListWhereType// (restriction)
1762 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //GroupWhereBaseType//
1763
1764 Content:
1765 Annotation?, ID?, GroupDimensionWhere*
1766
1767 Element Documentation:
1768
1769 |**Name**|**Type**|**Documentation**
1770 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1771 |ID|QueryIDType|ID is used to match the id of the identified object.
1772 |GroupDimensionWhere|DimensionWhereType|GroupDimensionWhere is used to query a group based on the details of the dimensions it groups. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1773
1774 **GroupWhereType: **GroupWhereType defines the parameters querying for a data structure definition based a group meeting the conditions detailed. Parameters include identification, dimensions used in the group, and the group's referenced attachment constraint. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1775
1776 Derivation:
1777 //AnnotableWhereType// (extension)
1778 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1779 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentListWhereType// (restriction)
1780 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //GroupWhereBaseType// (extension)
1781 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GroupWhereType
1782
1783 Content:
1784 Annotation?, ID?, GroupDimensionWhere*, AttachmentConstraint?
1785
1786 Element Documentation:
1787
1788 |**Name**|**Type**|**Documentation**
1789 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1790 |ID|QueryIDType|ID is used to match the id of the identified object.
1791 |GroupDimensionWhere|DimensionWhereType|GroupDimensionWhere is used to query a group based on the details of the dimensions it groups. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1792 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint queries for a group where the referenced attachment constraint defines the contents of the group.
1793
1794 **DataStructureComponentWhereType: **DataStructureComponentWhereType defines the basic information for querying for a data structure definition component. The component can be queried based on its identification, the concept from which it takes its semantic, and the code list it uses as its representation,. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1795
1796 Derivation:
1797 //AnnotableWhereType// (extension)
1798 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1799 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
1800 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureComponentWhereType
1801
1802 Content:
1803 Annotation?, ID?, ConceptIdentity?, Enumeration?
1804
1805 Element Documentation:
1806
1807 |**Name**|**Type**|**Documentation**
1808 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1809 |ID|QueryIDType|ID is used to match the id of the identified object.
1810 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
1811 |Enumeration|com: CodelistReferenceTyp e|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
1812
1813 **AttributeWhereType: **AttributeWhereType describes the structure of an attribute query. An attribute can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1814
1815 Derivation:
1816 //AnnotableWhereType// (extension)
1817 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1818 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
1819 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureComponentWhereType (extension)
1820 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] AttributeWhereType
1821
1822 Content:
1823 Annotation?, ID?, ConceptIdentity?, Enumeration?, Role*
1824
1825 Element Documentation:
1826
1827 |**Name**|**Type**|**Documentation**
1828 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1829 |ID|QueryIDType|ID is used to match the id of the identified object.
1830 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
1831 |Enumeration|com: CodelistReferenceTyp e|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
1832 |Role|com: ConceptReferenceType|Role is used to specify the role of the attribute.
1833
1834 **DimensionWhereType: **DimensionWhereType describes the structure of a dimension query. A dimension can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1835
1836 Derivation:
1837 //AnnotableWhereType// (extension)
1838 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1839 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
1840 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureComponentWhereType (extension)
1841 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DimensionWhereType
1842
1843 Content:
1844 Annotation?, ID?, ConceptIdentity?, Enumeration?, Role*
1845
1846 Element Documentation:
1847
1848 |**Name**|**Type**|**Documentation**
1849 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1850 |ID|QueryIDType|ID is used to match the id of the identified object.
1851 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
1852 |Enumeration|com: CodelistReferenceTyp e|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
1853 |Role|com: ConceptReferenceType|Role is used to specify the role of the dimension.
1854
1855 **TimeDimensionWhereType: **TimeDimensionWhereType describes the structure of a time dimension query. The time dimension can be queried based on the concept from which it takes its semantic. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1856
1857 Derivation:
1858 //AnnotableWhereType// (extension)
1859 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1860 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
1861 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureComponentWhereType (restriction)
1862 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TimeDimensionWhereType
1863
1864 Content:
1865 Annotation?, ConceptIdentity?
1866
1867 Element Documentation:
1868
1869 |**Name**|**Type**|**Documentation**
1870 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1871 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
1872
1873 **//MeasureDimensionWhereBaseType//: **MeasureDimensionWhereBaseType is an abstract base type which forms the basis for a measure dimension query.
1874
1875 Derivation:
1876 //AnnotableWhereType// (extension)
1877 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1878 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
1879 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MeasureDimensionWhereBaseType//
1880
1881 Content:
1882 Annotation?, ID?, ConceptIdentity?, Enumeration?
1883
1884 Element Documentation:
1885
1886 |**Name**|**Type**|**Documentation**
1887 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1888 |ID|QueryIDType|ID is used to match the id of the identified object.
1889 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
1890 |Enumeration|com: ConceptSchemeReferen ceType|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
1891
1892 **MeasureDimensionWhereType: **MeasureDimensionWhereType describes the structure of a measure dimension query. A measure dimension can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the concept scheme which defines its measure concepts. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1893
1894 Derivation:
1895 //AnnotableWhereType// (extension)
1896 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1897 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
1898 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MeasureDimensionWhereBaseType// (extension)
1899 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MeasureDimensionWhereType
1900
1901 Content:
1902 Annotation?, ID?, ConceptIdentity?, Enumeration?, Role*
1903
1904 Element Documentation:
1905
1906 |**Name**|**Type**|**Documentation**
1907 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1908 |ID|QueryIDType|ID is used to match the id of the identified object.
1909 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
1910 |Enumeration|com: ConceptSchemeReferen ceType|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
1911 |Role|com: ConceptReferenceType|Role is used to specify the role of the dimension.
1912
1913 **PrimaryMeasureWhereType: **MeasureWhereType describes the structure of a measure query. The primary measure can be queried based on the concept from which it takes its semantic, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
1914
1915 Derivation:
1916 //AnnotableWhereType// (extension)
1917 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1918 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
1919 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureComponentWhereType (restriction)
1920 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] PrimaryMeasureWhereType
1921
1922 Content:
1923 Annotation?, ConceptIdentity?, Enumeration?
1924
1925 Element Documentation:
1926
1927 |**Name**|**Type**|**Documentation**
1928 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1929 |ConceptIdentity|com: ConceptReferenceType|ConceptIdentity is used to query for a structure component based on the concept from which it takes its semantic.
1930 |Enumeration|com: CodelistReferenceTyp e|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
1931
1932 **HierarchicalCodelistQueryType: **HierarchicalCodelistQueryType defines the structure of a hierarchical codelist query. The parameters for the query are contained in the HierarchicalCodelistWhere element. The References element is used to indicate how objects that are referenced from the matched hierarchical codelist should be returned.
1933
1934 Derivation:
1935 //StructuralMetadataQueryType// (restriction)
1936 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] HierarchicalCodelistQueryType
1937
1938 Content:
1939 ReturnDetails, HierarchicalCodelistWhere
1940
1941 Element Documentation:
1942
1943 |**Name**|**Type**|**Documentation**
1944 |ReturnDetails|MaintainableReturnDe tailsType|
1945 |HierarchicalCodelist Where|HierarchicalCodelist WhereType|HierarchicalCodelistWhere defines the parameters for a hierarchical codelist query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a hierarchical codelist based on the codelists it arranges into hierarchies.
1946
1947 **//HierarchicalCodelistWhereBaseType//: **HierarchicalCodelistWhereBaseType is an abstract base type which forms the basis for the HierarchicalCodelistWhereType.
1948
1949 Derivation:
1950 //AnnotableWhereType// (extension)
1951 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1952 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1953 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1954 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
1955 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //HierarchicalCodelistWhereBaseType//
1956
1957 Attributes:
1958 type?
1959
1960 Content:
1961 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
1962
1963 Attribute Documentation:
1964
1965 |**Name**|**Type**|**Documentation**
1966 |type (fixed: HierarchicalCodelist)|com: MaintainableTypeCode listType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
1967
1968 Element Documentation:
1969
1970 |**Name**|**Type**|**Documentation**
1971 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
1972 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
1973 |ID|QueryIDType|ID is used to match the id of the identified object.
1974 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1975 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
1976 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
1977 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
1978 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
1979 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
1980 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
1981
1982 **HierarchicalCodelistWhereType: **HierarchicalCodelistWhereType contains the parameters of a hierarchical codelist query. All supplied parameters must be matched in order for an object to satisfy the query.
1983
1984 Derivation:
1985 //AnnotableWhereType// (extension)
1986 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
1987 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
1988 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
1989 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
1990 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //HierarchicalCodelistWhereBaseType// (extension)
1991 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] HierarchicalCodelistWhereType
1992
1993 Attributes:
1994 type?
1995
1996 Content:
1997 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, IncludedCodelist*
1998
1999 Attribute Documentation:
2000
2001 |**Name**|**Type**|**Documentation**
2002 |type (fixed: HierarchicalCodelist)|com: MaintainableTypeCode listType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
2003
2004 Element Documentation:
2005
2006 |**Name**|**Type**|**Documentation**
2007 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2008 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2009 |ID|QueryIDType|ID is used to match the id of the identified object.
2010 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2011 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2012 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2013 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2014 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2015 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2016 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2017 |IncludedCodelist|com: CodelistReferenceTyp e|IncludedCodelist is used to reference a codelist which the hierarchical codelist to be matched references.
2018
2019 **MetadataQueryType: **MetadataQueryType defines the structure of a reference metadata query. Reference metadata is queried as individual reports. The result of this query will be a collection of metadata sets, with only the relevant metadata reports contained within them. If no report level parameters are specified, then the query will result in entire metadata sets being returned.
2020
2021 Content:
2022 ReturnDetails, MetadataParameters
2023
2024 Element Documentation:
2025
2026 |**Name**|**Type**|**Documentation**
2027 |ReturnDetails|MetadataReturnDetail sType|ReturnDetails specifies the details of how the reference metadata should be returned.
2028 |MetadataParameters|MetadataParametersAn dType|MetadataParameters contains the parameters that are to be matched in order to determine which metadata reports are to be returned as the result of the query.
2029
2030 **MetadataReturnDetailsType: **MetadataReturnDetailsType is a structure for detailing how reference metadata should be returned. Only a default size limit can be specified.
2031
2032 Derivation:
2033 //ReturnDetailsBaseType// (extension)
2034 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataReturnDetailsType
2035
2036 Attributes:
2037 defaultLimit?, detail?
2038
2039 Content:
2040 {Empty}
2041
2042 Attribute Documentation:
2043
2044 |**Name**|**Type**|**Documentation**
2045 |defaultLimit|xs:integer|The defaultLimit attribute is the suggested maximum response size in kilobytes.
2046 |detail|xs:string|>The detail attribute is used to indicate how much of the matched object should be returned.
2047
2048 **//MetadataParametersType//: **MetadataParametersType defines the parameters for querying for reference metadata. This structure is refined by separate And/Or constructs which make logical restrictions on which parameters apply in such cases.
2049
2050 Content:
2051 MetadataSetID*, DataProvider*, MetadataStructure*, Metadataflow*, ProvisionAgreement*, Category*, Updated*, ConceptValue*, RepresentationValue*, MetadataTargetValue*, ReportStructureValue*, AttachmentConstraint*, AttachedObject*, AttachedDataKey*, AttachedDataSet*, AttachedReportingPeriod*, Or*, And*
2052
2053 Element Documentation:
2054
2055 |**Name**|**Type**|**Documentation**
2056 |MetadataSetID|QueryIDType|MetadataSetID is used to match the id of the metadata set. Only metadata reports from data sets with an identifier satisfying these conditions will be matched.
2057 |DataProvider|com: DataProviderReferenc eType|DataProviderReference is used to match the provider of reference metadata to the referenced data provider. Only metadata reports from metadata sets provided by the referenced data provider will be matched.
2058 |MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructureReference is used to match the underlying structure of the data. Only metadata reports from metadata sets that conform to referenced metadata structure definition will be matched.
2059 |Metadataflow|com: MetadataflowReferenc eType|MetadataflowReference is used to match the flow which reference metadata is reported against. Only metadata reports from metadata sets report against referenced metadata flow will be matched.
2060 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement is used to match the provision agreement which metadata is reported against. Only metadata from metadata sets report against the referenced provision agreement will be matched.
2061 |Category|com: CategoryReferenceTyp e|CategoryReference is used to match a reference metadata based on the categorization of its underlying structure (metadata structure definition), or the usage of that structure (metadata flow). Only metadata reports whose underlying structure or structure usage are categorized against the referenced category will be matched.
2062 |Updated|com: TimeRangeValueType|Updated is used to match reference metadata based on when it was last updated. Only metadata reports which satisfy the conditions for the last update parameters supplied here will be matched.
2063 |ConceptValue|ConceptValueType|ConceptValue is used to match reference metadata based on the value of a particular concept which defines a metadata attribute. So long as the referenced concept has the specified value for a metadata attribute anywhere within the report structure, the metadata report which contains that attribute will be matched.
2064 |RepresentationValue|CodeValueType|RepresentationValue is used to match reference metadata based on a codelist having a particular value. This codelist only applies in the context of the representation of a metadata attribute. So long as the value of any metadata attribute within the report structure which uses the referenced codelist has the value specified, any metadata report containing the attribute will be matched.
2065 |MetadataTargetValue|MetadataTargetValueT ype|MetadataTargetValue is used to match reference metadata based on the target object values of a particular metadata target. If not report structure is specified in the query, this will result in a search across all metadata reports which may use this metadata target. If a value is not given for a target object which is part of this metadata target, it is assumed that all values are allowed for that target object. Thus, if no target object values are given in the entire metadata target, the query will simply match ant report where the reference metadata target is used. All target object value conditions must be met to constitute a match.
2066 |ReportStructureValue|ReportStructureValue Type|ReportStructureValue is used to match particular reference metadata reports. Only metadata reports based on the referenced report structure will be matched. It is also possible to detail the values of the metadata attributes contained within the reference report. In this case, only metadata reports based on the referenced report structure which have the metadata attribute values specified will be matched.
2067 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint in order to match reference metadata which matches the effective metadata keys or metadata target regions defined in the constraint. Metadata will be returned by first matching metadata on the keys and metadata target regions that are marked as included (or all metadata if none), and then excluding the metadata that satisfies the conditions of the excluded keys and metadata target regions.
2068 |AttachedObject|com: ObjectReferenceType|AttachedObject is used to match reference metadata based on an object which it is attached to, regardless of the report structure or metadata target in which the object is referenced. Any metadata reports attached to the referenced objects will be matched.
2069 |AttachedDataKey|com:DataKeyType|AttachedDataKey is used to match reference metadata based on a data key it is attached to, regardless of the report structure or metadata target in which the data key is referenced. Any metadata reports attached to the supplied data key will be matched.
2070 |AttachedDataSet|com:SetReferenceType|AttachedDataSet is used to query for reference metadata based on a data set it is attached to, regardless of the report structure or metadata target in which the data set is referenced. Any metadata reports attached to the supplied metadata key will be matched.
2071 |AttachedReportingPer iod|com: TimeRangeValueType|AttachedReportingPeriod is used to query for reference metadata based on the reporting period to which it is attached, regardless of the report structure or metadata target in which the reference period is referenced. Any metadata reports attached to a reporting period which falls within the range specified will be matched.
2072 |Or|MetadataParametersOr Type|Or contains a collection of additional parameters, any one of which can be satisfied to result in a match.
2073 |And|MetadataParametersAn dType|And contains a collection of additional parameters, all of which must be satisfied to result in a match.
2074
2075 **MetadataParametersOrType: **MetadataParametersOrType refines the base data parameters to define a set of parameters joined by an "or" condition. Only one of the parameters supplied in an instance of this type can be satisfied to result in a match.
2076
2077 Derivation:
2078 //MetadataParametersType// (restriction)
2079 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataParametersOrType
2080
2081 Content:
2082 MetadataSetID*, DataProvider*, MetadataStructure*, Metadataflow*, ProvisionAgreement*, Category*, Updated*, ConceptValue*, RepresentationValue*, MetadataTargetValue*, ReportStructureValue*, AttachmentConstraint*, AttachedObject*, AttachedDataKey*, AttachedDataSet*, AttachedReportingPeriod*, And*
2083
2084 Element Documentation:
2085
2086 |**Name**|**Type**|**Documentation**
2087 |MetadataSetID|QueryIDType|MetadataSetID is used to match the id of the metadata set. Only metadata reports from data sets with an identifier satisfying these conditions will be matched.
2088 |DataProvider|com: DataProviderReferenc eType|DataProviderReference is used to match the provider of reference metadata to the referenced data provider. Only metadata reports from metadata sets provided by the referenced data provider will be matched.
2089 |MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructureReference is used to match the underlying structure of the data. Only metadata reports from metadata sets that conform to referenced metadata structure definition will be matched.
2090 |Metadataflow|com: MetadataflowReferenc eType|MetadataflowReference is used to match the flow which reference metadata is reported against. Only metadata reports from metadata sets report against referenced metadata flow will be matched.
2091 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement is used to match the provision agreement which metadata is reported against. Only metadata from metadata sets report against the referenced provision agreement will be matched.
2092 |Category|com: CategoryReferenceTyp e|CategoryReference is used to match a reference metadata based on the categorization of its underlying structure (metadata structure definition), or the usage of that structure (metadata flow). Only metadata reports whose underlying structure or structure usage are categorized against the referenced category will be matched.
2093 |Updated|com: TimeRangeValueType|Updated is used to match reference metadata based on when it was last updated. Only metadata reports which satisfy the conditions for the last update parameters supplied here will be matched.
2094 |ConceptValue|ConceptValueType|ConceptValue is used to match reference metadata based on the value of a particular concept which defines a metadata attribute. So long as the referenced concept has the specified value for a metadata attribute anywhere within the report structure, the metadata report which contains that attribute will be matched.
2095 |RepresentationValue|CodeValueType|RepresentationValue is used to match reference metadata based on a codelist having a particular value. This codelist only applies in the context of the representation of a metadata attribute. So long as the value of any metadata attribute within the report structure which uses the referenced codelist has the value specified, any metadata report containing the attribute will be matched.
2096 |MetadataTargetValue|MetadataTargetValueT ype|MetadataTargetValue is used to match reference metadata based on the target object values of a particular metadata target. If not report structure is specified in the query, this will result in a search across all metadata reports which may use this metadata target. If a value is not given for a target object which is part of this metadata target, it is assumed that all values are allowed for that target object. Thus, if no target object values are given in the entire metadata target, the query will simply match ant report where the reference metadata target is used. All target object value conditions must be met to constitute a match.
2097 |ReportStructureValue|ReportStructureValue Type|ReportStructureValue is used to match particular reference metadata reports. Only metadata reports based on the referenced report structure will be matched. It is also possible to detail the values of the metadata attributes contained within the reference report. In this case, only metadata reports based on the referenced report structure which have the metadata attribute values specified will be matched.
2098 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint in order to match reference metadata which matches the effective metadata keys or metadata target regions defined in the constraint. Metadata will be returned by first matching metadata on the keys and metadata target regions that are marked as included (or all metadata if none), and then excluding the metadata that satisfies the conditions of the excluded keys and metadata target regions.
2099 |AttachedObject|com: ObjectReferenceType|AttachedObject is used to match reference metadata based on an object which it is attached to, regardless of the report structure or metadata target in which the object is referenced. Any metadata reports attached to the referenced objects will be matched.
2100 |AttachedDataKey|com:DataKeyType|AttachedDataKey is used to match reference metadata based on a data key it is attached to, regardless of the report structure or metadata target in which the data key is referenced. Any metadata reports attached to the supplied data key will be matched.
2101 |AttachedDataSet|com:SetReferenceType|AttachedDataSet is used to query for reference metadata based on a data set it is attached to, regardless of the report structure or metadata target in which the data set is referenced. Any metadata reports attached to the supplied metadata key will be matched.
2102 |AttachedReportingPer iod|com: TimeRangeValueType|AttachedReportingPeriod is used to query for reference metadata based on the reporting period to which it is attached, regardless of the report structure or metadata target in which the reference period is referenced. Any metadata reports attached to a reporting period which falls within the range specified will be matched.
2103 |And|MetadataParametersAn dType|And contains a collection of additional parameters, all of which must be satisfied to result in a match.
2104
2105 **MetadataParametersAndType: **MetadataParametersAndType refines the base data parameters to define a set of parameters joined by an "and" conditions. All of the parameters supplied in an instance of this type must be satisfied to result in a match. As a result of this condition, the maximum occurrence of some parameters has been reduced so as to not allow for impossible conditions to be specified (for example data cannot be matched is it is specified that the data set identifier should be "xyz" and the data identifier should be "abc".
2106
2107 Derivation:
2108 //MetadataParametersType// (restriction)
2109 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataParametersAndType
2110
2111 Content:
2112 MetadataSetID?, DataProvider?, MetadataStructure?, Metadataflow?, ProvisionAgreement*, Category*, Updated?, ConceptValue*, RepresentationValue*, MetadataTargetValue?, ReportStructureValue?, AttachmentConstraint*, AttachedObject*, AttachedDataKey?, AttachedDataSet?, AttachedReportingPeriod?, Or*
2113
2114 Element Documentation:
2115
2116 |**Name**|**Type**|**Documentation**
2117 |MetadataSetID|QueryIDType|MetadataSetID is used to match the id of the metadata set. Only metadata reports from data sets with an identifier satisfying these conditions will be matched.
2118 |DataProvider|com: DataProviderReferenc eType|DataProviderReference is used to match the provider of reference metadata to the referenced data provider. Only metadata reports from metadata sets provided by the referenced data provider will be matched.
2119 |MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructureReference is used to match the underlying structure of the data. Only metadata reports from metadata sets that conform to referenced metadata structure definition will be matched.
2120 |Metadataflow|com: MetadataflowReferenc eType|MetadataflowReference is used to match the flow which reference metadata is reported against. Only metadata reports from metadata sets report against referenced metadata flow will be matched.
2121 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement is used to match the provision agreement which metadata is reported against. Only metadata from metadata sets report against the referenced provision agreement will be matched.
2122 |Category|com: CategoryReferenceTyp e|CategoryReference is used to match a reference metadata based on the categorization of its underlying structure (metadata structure definition), or the usage of that structure (metadata flow). Only metadata reports whose underlying structure or structure usage are categorized against the referenced category will be matched.
2123 |Updated|com: TimeRangeValueType|Updated is used to match reference metadata based on when it was last updated. Only metadata reports which satisfy the conditions for the last update parameters supplied here will be matched.
2124 |ConceptValue|ConceptValueType|ConceptValue is used to match reference metadata based on the value of a particular concept which defines a metadata attribute. So long as the referenced concept has the specified value for a metadata attribute anywhere within the report structure, the metadata report which contains that attribute will be matched.
2125 |RepresentationValue|CodeValueType|RepresentationValue is used to match reference metadata based on a codelist having a particular value. This codelist only applies in the context of the representation of a metadata attribute. So long as the value of any metadata attribute within the report structure which uses the referenced codelist has the value specified, any metadata report containing the attribute will be matched.
2126 |MetadataTargetValue|MetadataTargetValueT ype|MetadataTargetValue is used to match reference metadata based on the target object values of a particular metadata target. If not report structure is specified in the query, this will result in a search across all metadata reports which may use this metadata target. If a value is not given for a target object which is part of this metadata target, it is assumed that all values are allowed for that target object. Thus, if no target object values are given in the entire metadata target, the query will simply match ant report where the reference metadata target is used. All target object value conditions must be met to constitute a match.
2127 |ReportStructureValue|ReportStructureValue Type|ReportStructureValue is used to match particular reference metadata reports. Only metadata reports based on the referenced report structure will be matched. It is also possible to detail the values of the metadata attributes contained within the reference report. In this case, only metadata reports based on the referenced report structure which have the metadata attribute values specified will be matched.
2128 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint in order to match reference metadata which matches the effective metadata keys or metadata target regions defined in the constraint. Metadata will be returned by first matching metadata on the keys and metadata target regions that are marked as included (or all metadata if none), and then excluding the metadata that satisfies the conditions of the excluded keys and metadata target regions.
2129 |AttachedObject|com: ObjectReferenceType|AttachedObject is used to match reference metadata based on an object which it is attached to, regardless of the report structure or metadata target in which the object is referenced. Any metadata reports attached to the referenced objects will be matched.
2130 |AttachedDataKey|com:DataKeyType|AttachedDataKey is used to match reference metadata based on a data key it is attached to, regardless of the report structure or metadata target in which the data key is referenced. Any metadata reports attached to the supplied data key will be matched.
2131 |AttachedDataSet|com:SetReferenceType|AttachedDataSet is used to query for reference metadata based on a data set it is attached to, regardless of the report structure or metadata target in which the data set is referenced. Any metadata reports attached to the supplied metadata key will be matched.
2132 |AttachedReportingPer iod|com: TimeRangeValueType|AttachedReportingPeriod is used to query for reference metadata based on the reporting period to which it is attached, regardless of the report structure or metadata target in which the reference period is referenced. Any metadata reports attached to a reporting period which falls within the range specified will be matched.
2133 |Or|MetadataParametersOr Type|Or contains a collection of additional parameters, any one of which can be satisfied to result in a match.
2134
2135 **MetadataTargetValueType: **MetadataTargetValueType describes the structure that is used to match reference metadata where a given metadata target's target object have particular values. If a value is not given for a target object which is part of the metadata target, it is assumed that all values are allowed for that target object. Thus, if no target object values are given in the entire metadata target, the query will simply match ant report where the reference metadata target is used. All target object value conditions must be met to constitute a match.
2136
2137 Content:
2138 ID, TargetObjectValue*
2139
2140 Element Documentation:
2141
2142 |**Name**|**Type**|**Documentation**
2143 |ID|com:NCNameIDType|
2144 |TargetObjectValue|TargetObjectValueTyp e|TargetObjectValue is used to match reference metadata where a given target object in a metadata target references a particular object or time period.
2145
2146 **TargetObjectValueType: **IdentifierComponentValueType describes the structure that is used to match reference metadata where a given identifier component has a particular value.
2147
2148 Content:
2149 ID, (DataSet | DataKey | Object | TimeValue[1..2])
2150
2151 Element Documentation:
2152
2153 |**Name**|**Type**|**Documentation**
2154 |ID|com:NCNameIDType|ID identifies the metadata target object.
2155 |DataSet|com:SetReferenceType|DataSet provides a reference to a data set which the target object should reference to result in a match.
2156 |DataKey|com:DataKeyType|DataKey provides a data key (set of dimension values) which the target object should reference to result in a match.
2157 |Object|com: ObjectReferenceType|Object provides a reference to any SDMX identifiable object which the target object should reference to result in a match.
2158 |TimeValue|TimePeriodValueType|TimeValue is used to provide a time value or range for matching a reporting period which the target object should reference to result in a match.
2159
2160 **ReportStructureValueType: **ReportStructureValueType describes the structure that is used to match reference metadata where the metadata attributes of a report structure have particular values. All metadata attribute value conditions must be met to constitute a match.
2161
2162 Content:
2163 ID, MetadataAttributeValue*
2164
2165 Element Documentation:
2166
2167 |**Name**|**Type**|**Documentation**
2168 |ID|com:NCNameIDType|
2169 |MetadataAttributeVal ue|MetadataAttributeVal ueType|MetadataAttributeValue is used to match reference metadata where a metadata attribute has a particular value within the referenced report structure.
2170
2171 **MetadataAttributeValueType: **MetadataAttributeValueType describes the structure that is used to match reference metadata where a metadata attribute has a particular value. Metadata attribute value queries can be nested for querying nested metadata attributes. If no value is provided, then simply the presence of the metadata attribute within the given context will result in a match. All nested metadata attribute value conditions must be met to constitute a match.
2172
2173 Content:
2174 ID, (Value | TextValue+ | NumericValue[1..2] | TimeValue[1..2])?, MetadataAttributeValue*
2175
2176 Element Documentation:
2177
2178 |**Name**|**Type**|**Documentation**
2179 |ID|com:NCNameIDType|
2180 |Value|SimpleValueType|Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.
2181 |TextValue|QueryTextType|TextValue is used to query for the value of a concept or component based on textual parameters. The text value can be language specific (where parallel multi-lingual values are available) and is qualified with an operator indicating how the supplied text should be matched against the sought components. If only a simple equality check is necessary, regardless of language, the Value element can be used.
2182 |NumericValue|NumericValueType|NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.
2183 |TimeValue|TimePeriodValueType|TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.
2184 |MetadataAttributeVal ue|MetadataAttributeVal ueType|
2185
2186 **MetadataflowQueryType: **MetadataflowQueryType defines the structure of a metadataflow query. The parameters for the query are contained in the MetadataflowWhere element. The References element is used to indicate how objects that reference or are referenced from the matched metadataflow should be returned.
2187
2188 Derivation:
2189 //StructuralMetadataQueryType// (restriction)
2190 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataflowQueryType
2191
2192 Content:
2193 ReturnDetails, MetadataflowWhere
2194
2195 Element Documentation:
2196
2197 |**Name**|**Type**|**Documentation**
2198 |ReturnDetails|MaintainableReturnDe tailsType|
2199 |MetadataflowWhere|MetadataflowWhereTyp e|MetadataflowWhere contains the parameters for a metadataflow query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a metadataflow based on the metadata structure definition it defines the usage of.
2200
2201 **MetadataflowWhereType: **MetadataflowWhereType contains the parameters of a metadataflow query. All supplied parameters must be matched in order for an object to satisfy the query.
2202
2203 Derivation:
2204 //AnnotableWhereType// (extension)
2205 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2206 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2207 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2208 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
2209 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureUsageWhereType// (restriction)
2210 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataflowWhereType
2211
2212 Attributes:
2213 type?
2214
2215 Content:
2216 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure?
2217
2218 Attribute Documentation:
2219
2220 |**Name**|**Type**|**Documentation**
2221 |type (fixed: Metadataflow)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
2222
2223 Element Documentation:
2224
2225 |**Name**|**Type**|**Documentation**
2226 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2227 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2228 |ID|QueryIDType|ID is used to match the id of the identified object.
2229 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2230 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2231 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2232 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2233 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2234 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2235 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2236 |Structure|com: MetadataStructureRef erenceType|MetadataStructureReference is used to indicate which metadata structure definition the metadataflow must define a usage for in order to constitute a match.
2237
2238 **MetadataStructureQueryType: **MetadataStructureQueryType defines the structure of a metadata structure definition query. The parameters for the query are contained in the MetadataStructureDefinitionWhere element. The References element is used to indicate how objects that reference or are referenced from the matched metadata structure definition should be returned.
2239
2240 Derivation:
2241 //StructuralMetadataQueryType// (restriction)
2242 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataStructureQueryType
2243
2244 Content:
2245 ReturnDetails, MetadataStructureWhere
2246
2247 Element Documentation:
2248
2249 |**Name**|**Type**|**Documentation**
2250 |ReturnDetails|MaintainableReturnDe tailsType|
2251 |MetadataStructureWhe re|MetadataStructureWhe reType|MetadataStructureWhere contains the parameters for a metadata structure definition query. All parameters must be matched for an object to satisfy the query. The query is simply a refinement of the base structure query to make the parameters specific to the metadata structure definition.
2252
2253 **//MetadataStructureWhereBaseType//: **MetadataStructureWhereBaseType is an abstract base type the forms the basis for the MetadataStructureWhereType.
2254
2255 Derivation:
2256 //AnnotableWhereType// (extension)
2257 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2258 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2259 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2260 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
2261 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureWhereType// (restriction)
2262 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MetadataStructureWhereBaseType//
2263
2264 Attributes:
2265 type?
2266
2267 Content:
2268 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*
2269
2270 Attribute Documentation:
2271
2272 |**Name**|**Type**|**Documentation**
2273 |type (fixed: MetadataStructure)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
2274
2275 Element Documentation:
2276
2277 |**Name**|**Type**|**Documentation**
2278 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2279 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2280 |ID|QueryIDType|ID is used to match the id of the identified object.
2281 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2282 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2283 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2284 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2285 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2286 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2287 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2288 |UsedConcept|com: ConceptReferenceType|UsedConcept is used to query for a structure that uses the referenced concept as the basis of one of its components.
2289 |UsedRepresentation|com: ItemSchemeReferenceT ype|UsedRepresentation is used to query for a structure that uses the referenced item scheme for the representation of one of its components.
2290
2291 **MetadataStructureWhereType: **MetadataStructureWhereType defines the parameters of a metadata structure definition query. In addition to querying based on the identification, it is also possible to search for metadata structure definitions based on information about its components.
2292
2293 Derivation:
2294 //AnnotableWhereType// (extension)
2295 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2296 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2297 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2298 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
2299 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureWhereType// (restriction)
2300 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MetadataStructureWhereBaseType// (extension)
2301 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataStructureWhereType
2302
2303 Attributes:
2304 type?
2305
2306 Content:
2307 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, MetadataTargetWhere*, TargetObjectWhere*, ReportStructureWhere*, MetadataAttributeWhere*
2308
2309 Attribute Documentation:
2310
2311 |**Name**|**Type**|**Documentation**
2312 |type (fixed: MetadataStructure)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
2313
2314 Element Documentation:
2315
2316 |**Name**|**Type**|**Documentation**
2317 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2318 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2319 |ID|QueryIDType|ID is used to match the id of the identified object.
2320 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2321 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2322 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2323 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2324 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2325 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2326 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2327 |UsedConcept|com: ConceptReferenceType|UsedConcept is used to query for a structure that uses the referenced concept as the basis of one of its components.
2328 |UsedRepresentation|com: ItemSchemeReferenceT ype|UsedRepresentation is used to query for a structure that uses the referenced item scheme for the representation of one of its components.
2329 |MetadataTargetWhere|MetadataTargetWhereT ype|MetadataTargetWhere is used to query for a metadata structure definition that contains a metadata target meeting the conditions contained in this structure. The metadata target can be queried based on its identification and/or the details of its target objects. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2330 |TargetObjectWhere|TargetObjectWhereTyp e|IdentifierComponentWhere is used to query for specific target identifiers or metadata structure definitions where a contained identifier component meets the conditions detailed. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2331 |ReportStructureWhere|ReportStructureWhere Type|ReportStructureWhere is used to query for metadata structure definitions where a given report structure meets the conditions specified. A report structure can be queried based on identification or details about its metadata attributes. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2332 |MetadataAttributeWhe re|MetadataAttributeWhe reType|MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query metadata structure definitions where a contained metadata attribute meets the conditions specified. A metadata attribute can be queried based on its identification, the concept from which it takes its semantic, and an item scheme it uses as its representation. Nested metadata attributes allow for the querying of metadata attributes explicitly at nested level, although a top level metadata attribute query will be processed by querying metadata attributes at any level. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2333
2334 **MetadataTargetWhereType: **MetadataTargetWhereType describes the structure that is used to query for metadata structure definitions containing a metadata target meeting the conditions detailed. Conditions include the identification and the details of the target objects which make up the metadata target.
2335
2336 Derivation:
2337 //AnnotableWhereType// (extension)
2338 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2339 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentListWhereType// (restriction)
2340 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataTargetWhereType
2341
2342 Content:
2343 Annotation?, ID?, TargetObjectWhere*
2344
2345 Element Documentation:
2346
2347 |**Name**|**Type**|**Documentation**
2348 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2349 |ID|QueryIDType|ID is used to match the id of the identified object.
2350 |TargetObjectWhere|TargetObjectWhereTyp e|IdentifierComponentWhere is used to query for specific target identifiers or metadata structure definitions where a contained identifier component meets the conditions detailed. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2351
2352 **//TargetObjectWhereBaseType//: **TargetObjectWhereBaseType is an abstract base type that forms the basis for the TargetObjectWhereType.
2353
2354 Derivation:
2355
2356 //AnnotableWhereType// (extension)
2357 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2358 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
2359 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //TargetObjectWhereBaseType//
2360
2361 Content:
2362 Annotation?, ID?, Enumeration?
2363
2364 Element Documentation:
2365
2366 |**Name**|**Type**|**Documentation**
2367 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2368 |ID|QueryIDType|ID is used to match the id of the identified object.
2369 |Enumeration|com: ItemSchemeReferenceT ype|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
2370
2371 **TargetObjectWhereType: **TargetObjectWhereType describes the structure of a target object query. A target object can be queried based on its identification, its type (i.e. data set target, key descriptor values target, report period target, or identifiable object target), and in the case of an identifiable object target, an item scheme which enumerates the possible values and/or the class of the target object reference.
2372
2373 Derivation:
2374 //AnnotableWhereType// (extension)
2375 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2376 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
2377 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //TargetObjectWhereBaseType// (extension)
2378 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TargetObjectWhereType
2379
2380 Attributes:
2381 type?, targetClass?
2382
2383 Content:
2384 Annotation?, ID?, Enumeration?
2385
2386 Attribute Documentation:
2387
2388 |**Name**|**Type**|**Documentation**
2389 |type|com: TargetObjectTypeCode listType|The type attribute is used to query for a target object of a given type (i.e. data set target, key descriptor values target, report period target, or identifiable object target)
2390 |targetClass|com: ObjectTypeCodelistTy pe|The targetClass attribute is used to query for an identifiable object target based on the class its target object.
2391
2392 Element Documentation:
2393
2394 |**Name**|**Type**|**Documentation**
2395 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2396 |ID|QueryIDType|ID is used to match the id of the identified object.
2397 |Enumeration|com: ItemSchemeReferenceT ype|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
2398
2399 **ReportStructureWhereType: **ReportStructureWhereType defines the parameters for matching based on the details of a report structure. This is used to query for metadata structure definitions where a given report structure meets the conditions specified. A report structure can be queried based on identification and details about its metadata attributes. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2400
2401 Derivation:
2402 //AnnotableWhereType// (extension)
2403 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2404 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentListWhereType// (restriction)
2405 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ReportStructureWhereType
2406
2407 Content:
2408 Annotation?, ID?, MetadataAttributeWhere*
2409
2410 Element Documentation:
2411
2412 |**Name**|**Type**|**Documentation**
2413 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2414 |ID|QueryIDType|ID is used to match the id of the identified object.
2415 |MetadataAttributeWhe re|MetadataAttributeWhe reType|MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query metadata structure definitions where a contained metadata attribute meets the conditions specified. A metadata attribute can be queried based on its identification, the concept from which it takes its semantic, and an item scheme it uses as its representation. Nested metadata attributes allow for the querying of metadata attributes explicitly at nested level, although a top level metadata attribute query will be processed by querying metadata attributes at any level. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2416
2417 **//MetadataAttributeWhereBaseType//: **MetadataAttributeWhereBaseType is an abstract base type that forms the basis for the MetadataAttributeWhereType.
2418
2419 Derivation:
2420 //AnnotableWhereType// (extension)
2421 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2422 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
2423 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MetadataAttributeWhereBaseType//
2424
2425 Content:
2426 Annotation?, ID?, Enumeration?
2427
2428 Element Documentation:
2429
2430 |**Name**|**Type**|**Documentation**
2431 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2432 |ID|QueryIDType|ID is used to match the id of the identified object.
2433 |Enumeration|com: CodelistReferenceTyp e|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
2434
2435 **MetadataAttributeWhereType: **MetadataAttributeWhereType describes the parameters for a metadata attribute. A metadata attribute can be queried based on its identification, the concept from which it takes its semantic, and an item scheme it uses as its representation. Nested metadata attributes allow for the querying of metadata attributes explicitly at nested level, although a top level metadata attribute query will be processed by querying metadata attributes at any level. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2436
2437 Derivation:
2438 //AnnotableWhereType// (extension)
2439 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2440 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ComponentWhereType// (restriction)
2441 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MetadataAttributeWhereBaseType// (extension)
2442 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MetadataAttributeWhereType
2443
2444 Content:
2445 Annotation?, ID?, Enumeration?, MetadataAttributeWhere*
2446
2447 Element Documentation:
2448
2449 |**Name**|**Type**|**Documentation**
2450 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2451 |ID|QueryIDType|ID is used to match the id of the identified object.
2452 |Enumeration|com: CodelistReferenceTyp e|Enumeration is used to query for a structure component based on the item scheme that is used as the enumeration for its representation. This enumeration may be explicit defined by the component (i.e. its local representation), or inherited from the concept from which the component takes its semantic (i.e. the concept core representation).
2453 |MetadataAttributeWhe re|MetadataAttributeWhe reType|MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query metadata structure definitions where a contained metadata attribute meets the conditions specified. A metadata attribute can be queried based on its identification, the concept from which it takes its semantic, and an item scheme it uses as its representation. Nested metadata attributes allow for the querying of metadata attributes explicitly at nested level, although a top level metadata attribute query will be processed by querying metadata attributes at any level. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.
2454
2455 **OrganisationSchemeQueryType: **OrganisationSchemeQueryType defines the structure of an organisation scheme query. The parameters for the query are contained in the OrganisationSchemeWhere element. The References element is used to indicate how objects that reference the matched organisation scheme should be returned.
2456
2457 Derivation:
2458 //StructuralMetadataQueryType// (restriction)
2459 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] OrganisationSchemeQueryType
2460
2461 Content:
2462 ReturnDetails, OrganisationSchemeWhere
2463
2464 Element Documentation:
2465
2466 |**Name**|**Type**|**Documentation**
2467 |ReturnDetails|StructureReturnDetai lsType|
2468 |OrganisationSchemeWh ere|OrganisationSchemeWh ereType|OrganisationSchemeWhere defines the parameters for an organisation scheme query, regardless of the specific type of organisation scheme being sought. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for an organisation scheme based on the details of its organisations. In any case, the organisation scheme will be returned according the indicated return detail.
2469
2470 **OrganisationSchemeWhereType: **OrganisationSchemeWhereType contains the parameters of an organisation scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
2471
2472 Derivation:
2473 //AnnotableWhereType// (extension)
2474 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2475 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2476 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2477 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
2478 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (restriction)
2479 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] OrganisationSchemeWhereType
2480
2481 Attributes:
2482 type?
2483
2484 Content:
2485 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, OrganisationWhere*
2486
2487 Attribute Documentation:
2488
2489 |**Name**|**Type**|**Documentation**
2490 |type (default: OrganisationScheme)|OrganisationSchemeTy peCodeType|The type attribute indicates the type of organisation scheme which is being queried for, with the default being any organisation scheme. Note that agency, data consumer, and data provider scheme all have fixed identifiers and versions, so specifying these types with parameters for the identifier and/or version which do not match these fixed values will never return a result.
2491
2492 Element Documentation:
2493
2494 |**Name**|**Type**|**Documentation**
2495 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2496 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2497 |ID|QueryIDType|ID is used to match the id of the identified object.
2498 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2499 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2500 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2501 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2502 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2503 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2504 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2505 |OrganisationWhere|OrganisationWhereTyp e|OrganisationWhere is used to query for organisations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
2506
2507 **OrganisationWhereType: **OrganisationWhereType defines a set of parameters for matching an organisation. In addition to the base parameters for any item, there is an additional parameter for matching an organisation based on the roles it serves. All supplied parameters must be matched in order for an object to satisfy the query.
2508
2509 Derivation:
2510 //AnnotableWhereType// (extension)
2511 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2512 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2513 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
2514 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] OrganisationWhereType
2515
2516 Content:
2517 Annotation?, ID?, Name?, Description?, Parent?
2518
2519 Element Documentation:
2520
2521 |**Name**|**Type**|**Documentation**
2522 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2523 |ID|QueryIDType|ID is used to match the id of the identified object.
2524 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2525 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2526 |Parent|com: LocalOrganisationUni tReferenceType|Parent is only applicable when searching for organisation units, and is used to match organisations which have a parent organisation unit which is referenced here.
2527
2528 **ProcessQueryType: **ProcessQueryType defines the structure of a process query. The parameters for the query are contained in the ProcessWhere element. The References element is used to indicate how objects that are referenced from the matched process scheme should be returned.
2529
2530 Derivation:
2531 //StructuralMetadataQueryType// (restriction)
2532 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ProcessQueryType
2533
2534 Content:
2535 ReturnDetails, ProcessWhere
2536
2537 Element Documentation:
2538
2539 |**Name**|**Type**|**Documentation**
2540 |ReturnDetails|MaintainableReturnDe tailsType|
2541 |ProcessWhere|ProcessWhereType|ProcessWhere contains the parameters for a process query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the process steps defined within the process. In any case, the entire process will be returned according the indicated return detail.
2542
2543 **//ProcessWhereBaseType//: **ProcessWhereBaseType is an abstract base type which forms the basis for the ProcessWhereType.
2544
2545 Derivation:
2546 //AnnotableWhereType// (extension)
2547 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2548 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2549 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2550 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
2551 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ProcessWhereBaseType//
2552
2553 Attributes:
2554 type?
2555
2556 Content:
2557 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
2558
2559 Attribute Documentation:
2560
2561 |**Name**|**Type**|**Documentation**
2562 |type (fixed: Process)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
2563
2564 Element Documentation:
2565
2566 |**Name**|**Type**|**Documentation**
2567 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2568 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2569 |ID|QueryIDType|ID is used to match the id of the identified object.
2570 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2571 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2572 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2573 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2574 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2575 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2576 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2577
2578 **ProcessWhereType: **ProcessWhereType defines the parameters of a process query. All supplied parameters must be matched in order for an object to satisfy the query.
2579
2580 Derivation:
2581 //AnnotableWhereType// (extension)
2582 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2583 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2584 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2585 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
2586 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ProcessWhereBaseType// (extension)
2587 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ProcessWhereType
2588
2589 Attributes:
2590 type?
2591
2592 Content:
2593 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ProcessStepWhere*
2594
2595 Attribute Documentation:
2596
2597 |**Name**|**Type**|**Documentation**
2598 |type (fixed: Process)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
2599
2600 Element Documentation:
2601
2602 |**Name**|**Type**|**Documentation**
2603 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2604 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2605 |ID|QueryIDType|ID is used to match the id of the identified object.
2606 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2607 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2608 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2609 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2610 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2611 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2612 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2613 |ProcessStepWhere|ProcessStepWhereType|ProcessStepWhere is used to query for process steps matching the parameters supplied. It allows for nested process step queries so that hierarchical steps can be queried explicitly by their nested level, although a top level step will always result in a search for process steps at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
2614
2615 **ProcessStepWhereType: **ProcessStepWhereType defines a set of parameters for matching a category. All supplied parameters must be matched in order for an object to satisfy the query. In addition to the base item parameters, there are also parameters for matching based on the objects which serve as the input or output to the process step.
2616
2617 Derivation:
2618 //AnnotableWhereType// (extension)
2619 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2620 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ProcessStepWhereType
2621
2622 Content:
2623 Annotation?, URN?, ID?, InputOrOutputObject*, ProcessStepWhere*
2624
2625 Element Documentation:
2626
2627 |**Name**|**Type**|**Documentation**
2628 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2629 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2630 |ID|QueryIDType|ID is used to match the id of the identified object.
2631 |InputOrOutputObject|InputOrOutputObjectT ype|InputOrOutputObject is a parameter for matching a process step based on the referenced object, and whether it is an input or an output to the step.
2632 |ProcessStepWhere|ProcessStepWhereType|ProcessStepWhere is used to query for process steps within a the particular process step. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
2633
2634 **InputOrOutputObjectType: **InputOrOutputObjectType describes the structure of input or output condition for a process step query. It contains reference to an object, as will as an attribute indicates whether the object should be an input, output, or either of the two to the step.
2635
2636 Attributes:
2637 type?
2638
2639 Content:
2640 ObjectReference
2641
2642 Attribute Documentation:
2643
2644 |**Name**|**Type**|**Documentation**
2645 |type (default: Any)|InputOutputTypeCodeT ype|The type attribute is used to indicate whether the referenced object should be an input, output, or either of the two to the process step. The default for this is Any.
2646
2647 Element Documentation:
2648
2649 |**Name**|**Type**|**Documentation**
2650 |ObjectReference|com: ObjectReferenceType|ObjectReference is used to query for a process containing process steps where the referenced object is input or output to the process step.
2651
2652 **ProvisionAgreementQueryType: **ProvisionAgreementQueryType defines the structure of a provision agreement query. The parameters for the query are contained in the ProvisionAgreementWhere element. The References element is used to indicate how objects that reference or are referenced from the matched provision agreement should be returned.
2653
2654 Derivation:
2655 //StructuralMetadataQueryType// (restriction)
2656 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ProvisionAgreementQueryType
2657
2658 Content:
2659 ReturnDetails, ProvisionAgreementWhere
2660
2661 Element Documentation:
2662
2663 |**Name**|**Type**|**Documentation**
2664 |ReturnDetails|MaintainableReturnDe tailsType|
2665 |ProvisionAgreementWh ere|ProvisionAgreementWh ereType|ProvisionAgreementWhere contains the parameters for a provision agreement query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a provision agreement based on the data provider and the structure usage it pairs.
2666
2667 **//ProvisionAgreementWhereBaseType//: **ProvisionAgreementWhereBaseType is an abstract base type which forms the basis for the ProvisionAgreementWhereType.
2668
2669 Derivation:
2670 //AnnotableWhereType// (extension)
2671 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2672 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2673 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2674 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
2675 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ProvisionAgreementWhereBaseType//
2676
2677 Attributes:
2678 type?
2679
2680 Content:
2681 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
2682
2683 Attribute Documentation:
2684
2685 |**Name**|**Type**|**Documentation**
2686 |type (fixed: ProvisionAgreement)|com: MaintainableTypeCode listType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
2687
2688 Element Documentation:
2689
2690 |**Name**|**Type**|**Documentation**
2691 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2692 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2693 |ID|QueryIDType|ID is used to match the id of the identified object.
2694 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2695 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2696 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2697 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2698 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2699 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2700 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2701
2702 **ProvisionAgreementWhereType: **ProvisionAgreementWhereType defines the parameters of a provision agreement query. All supplied parameters must be matched in order for an object to satisfy the query.
2703
2704 Derivation:
2705 //AnnotableWhereType// (extension)
2706 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2707 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2708 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2709 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
2710 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ProvisionAgreementWhereBaseType// (extension)
2711 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ProvisionAgreementWhereType
2712
2713 Attributes:
2714 type?
2715
2716 Content:
2717 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, StructureUsage?, DataProvider?
2718
2719 Attribute Documentation:
2720
2721 |**Name**|**Type**|**Documentation**
2722 |type (fixed: ProvisionAgreement)|com: MaintainableTypeCode listType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
2723
2724 Element Documentation:
2725
2726 |**Name**|**Type**|**Documentation**
2727 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2728 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2729 |ID|QueryIDType|ID is used to match the id of the identified object.
2730 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2731 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2732 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2733 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2734 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2735 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2736 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2737 |StructureUsage|com: StructureUsageRefere nceType|StructureUsage is used to indicate which structure usage the provision agreement must reference in order to constitute a match.
2738 |DataProvider|com: DataProviderReferenc eType|DataProvider is used to indicate which data provider the provision agreement must reference in order to constitute a match.
2739
2740 **ReportingTaxonomyQueryType: **ReportingTaxonomyQueryType defines the structure of a reporting taxonomy query. The parameters for the query are contained in the ReportingTaxonomyWhere element. The References element is used to indicate how objects that are referenced from the reporting taxonomy should be returned.
2741
2742 Derivation:
2743 //StructuralMetadataQueryType// (restriction)
2744 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ReportingTaxonomyQueryType
2745
2746 Content:
2747 ReturnDetails, ReportingTaxonomyWhere
2748
2749 Element Documentation:
2750
2751 |**Name**|**Type**|**Documentation**
2752 |ReturnDetails|StructureReturnDetai lsType|
2753 |ReportingTaxonomyWhe re|ReportingTaxonomyWhe reType|ReportingTaxonomyWhere contains the parameters for a reporting taxonomy query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a reporting taxonomy based on the details of its reporting categories. In any case, the reporting taxonomy will be returned according the indicated return detail.
2754
2755 **ReportingTaxonomyWhereType: **ReportingTaxonomyWhereType defines the parameters of a reporting taxonomy query. All supplied parameters must be matched in order for an object to satisfy the query. In addition to querying based on the base maintainable parameters, it is also possible to search for taxonomies that contain particular reporting categories, and on the root level structure definitions of the taxonomy.
2756
2757 Derivation:
2758 //AnnotableWhereType// (extension)
2759 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2760 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2761 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2762 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
2763 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (restriction)
2764 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ReportingTaxonomyWhereType
2765
2766 Attributes:
2767 type?
2768
2769 Content:
2770 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ReportingCategoryWhere*
2771
2772 Attribute Documentation:
2773
2774 |**Name**|**Type**|**Documentation**
2775 |type (fixed: ReportingTaxonomy)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
2776
2777 Element Documentation:
2778
2779 |**Name**|**Type**|**Documentation**
2780 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2781 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2782 |ID|QueryIDType|ID is used to match the id of the identified object.
2783 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2784 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2785 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2786 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2787 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2788 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2789 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2790 |ReportingCategoryWhe re|ReportingCategoryWhe reType|ReportingCategoryWhere is used to query for reporting categories matching the parameters supplied. It allows for nested reporting category queries so that hierarchical reporting categories can be queried explicitly by their nested level, although a top level reporting category will always result in a search for reporting categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
2791
2792 **//ReportingCategoryWhereBaseType//: **ReportingCategoryWhereBaseType is an abstract base type that forms the basis for the ReportingCategoryQueryType.
2793
2794 Derivation:
2795 //AnnotableWhereType// (extension)
2796 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2797 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2798 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
2799 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ReportingCategoryWhereBaseType//
2800
2801 Content:
2802 Annotation?, ID?, Name?, Description?, ReportingCategoryWhere*
2803
2804 Element Documentation:
2805
2806 |**Name**|**Type**|**Documentation**
2807 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2808 |ID|QueryIDType|ID is used to match the id of the identified object.
2809 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2810 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2811 |ReportingCategoryWhe re|ReportingCategoryWhe reType|ReportingCategoryWhere is used to query for reporting categories matching the parameters supplied. It allows for nested reporting category queries so that hierarchical reporting categories can be queried explicitly by their nested level, although a top level reporting category will always result in a search for reporting categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
2812
2813 **ReportingCategoryWhereType: **ReportingCategoryWhereType contains a set of parameters for matching a reporting category. All supplied parameters must be matched in order for an object to satisfy the query.
2814
2815 Derivation:
2816 //AnnotableWhereType// (extension)
2817 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2818 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2819 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
2820 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ReportingCategoryWhereBaseType// (extension)
2821 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] ReportingCategoryWhereType
2822
2823 Content:
2824 Annotation?, ID?, Name?, Description?, ReportingCategoryWhere*, (ProvisioningMetadata* | StructuralMetadata*)
2825
2826 Element Documentation:
2827
2828 |**Name**|**Type**|**Documentation**
2829 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2830 |ID|QueryIDType|ID is used to match the id of the identified object.
2831 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2832 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2833 |ReportingCategoryWhe re|ReportingCategoryWhe reType|ReportingCategoryWhere is used to query for reporting categories matching the parameters supplied. It allows for nested reporting category queries so that hierarchical reporting categories can be queried explicitly by their nested level, although a top level reporting category will always result in a search for reporting categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
2834 |ProvisioningMetadata|com: StructureUsageRefere nceType|ProvisioningMetadata is used to query for a reporting category where the structure usages referenced are referenced by the reporting category.
2835 |StructuralMetadata|com: StructureReferenceTy pe|StructuralMetadata is used to query for a reporting category where the structures referenced are referenced by the reporting category.
2836
2837 **DataSchemaQueryType: **DataSchemaQueryType defines the structure of a query for a structured data schema. This query consists of a single data structure which provides the full details of what type of structured data schema should be returned.
2838
2839 Content:
2840 DataStructure
2841
2842 Element Documentation:
2843
2844 |**Name**|**Type**|**Documentation**
2845 |DataStructure|DataStructureRequest Type|DataStructure references a data structure either explicitly or through a usage (dataflow) or agreement based on the flow (provision agreement). An observation dimension must be specifies as well as indicators for using explicit measures, deriving the type from the time series specific data set, and processing constraints. The explicit measure option is only applicable if the observation dimension is the measure dimension; otherwise the value provided will be ignored. The time series option is only applicable if the observation dimension is the time dimension; otherwise the value provided will be ignored. Constraints will only be applied in the returned schemas if specifically requested. This means that even if the request specifies a provision agreement, the returned schema will not take into account the constraints on that agreement unless the request explicitly requests this.
2846
2847 **MetadataSchemaQueryType: **MetadataSchemaQueryType defines the structure of a query for a structured metadata schema. This query consists of a single metadata structure which simply provides a reference to a metadata structure.
2848
2849 Content:
2850 MetadataStructure
2851
2852 Element Documentation:
2853
2854 |**Name**|**Type**|**Documentation**
2855 |MetadataStructure|com: GenericMetadataStruc tureType|MetadataStructure references a metadata structure either explicitly or through it usage (metadataflow) or an application of that usage (provision agreement).
2856
2857 **DataStructureRequestType: **DataStructureRequestType extends the base DataStructureRequestType to add additional parameters that are necessary when querying for a schema.
2858
2859 Derivation:
2860 //com:PayloadStructureType// (restriction)
2861 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //com:DataStructureType// (restriction)
2862 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] com:DataStructureRequestType (extension)
2863 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] DataStructureRequestType
2864
2865 Attributes:
2866 structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?, timeSeries?, processConstraints?
2867
2868 Content:
2869 (com:ProvisionAgrement | com:StructureUsage | com:Structure)
2870
2871 Attribute Documentation:
2872
2873 |**Name**|**Type**|**Documentation**
2874 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
2875 |dimensionAtObservation|com: ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
2876 |explicitMeasures (default: false)|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
2877 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2878 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2879 |timeSeries (default: false)|xs:boolean|The timeSeries attribute indicates that the requested schema should derived from the time series specific data set. If the observation dimension is anything but the time dimension, this field will be ignored.
2880 |processConstraints (default: false)|xs:boolean|The processConstraints attribute indicates that constraints should be processed when returning the schema. If this value is false, then the schema will be based on the data structure deflation, regardless of whether the reference was specified as a provision agreement, dataflow, or data structure. If this is true, then the constraints at the requested level will be processed and the returned schema will take these constraints into account (i.e. the appropriate code lists will be sub-setted
2881
2882 Element Documentation:
2883
2884 |**Name**|**Type**|**Documentation**
2885 |com: ProvisionAgrement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
2886 |com:StructureUsage|com: DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
2887 |com:Structure|com: DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
2888
2889 **StructureSetQueryType: **StructureSetQueryType defines the structure of a structure set query. The parameters for the query are contained in the StructureSetWhere element. The References element is used to indicate how objects that are referenced from the structure set should be returned.
2890
2891 Derivation:
2892 //StructuralMetadataQueryType// (restriction)
2893 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSetQueryType
2894
2895 Content:
2896 ReturnDetails, StructureSetWhere
2897
2898 Element Documentation:
2899
2900 |**Name**|**Type**|**Documentation**
2901 |ReturnDetails|MaintainableReturnDe tailsType|
2902 |StructureSetWhere|StructureSetWhereTyp e|StructureSetWhere contains the parameters for a structure query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search based on the structures that are related by the set or the objects which are mapped by the set's maps. In any case, the structure set will be returned according the indicated return detail.
2903
2904 **//StructureSetWhereBaseType//: **StructureSetWhereBaseType is an abstract base type which forms the basis for the StructureSetWhereType.
2905
2906 Derivation:
2907 //AnnotableWhereType// (extension)
2908 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2909 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2910 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2911 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
2912 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureSetWhereBaseType//
2913
2914 Attributes:
2915 type?
2916
2917 Content:
2918 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
2919
2920 Attribute Documentation:
2921
2922 |**Name**|**Type**|**Documentation**
2923 |type (fixed: StructureSet)|com: MaintainableTypeCode listType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
2924
2925 Element Documentation:
2926
2927 |**Name**|**Type**|**Documentation**
2928 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2929 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2930 |ID|QueryIDType|ID is used to match the id of the identified object.
2931 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2932 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2933 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2934 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2935 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2936 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2937 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2938
2939 **StructureSetWhereType: **StructureSetWhereType defines the parameters of a structure set query. All supplied parameters must be matched in order for an object to satisfy the query. In addition to querying based on the base maintainable parameters, it is also possible to search based on the structures that are related by the set or the objects which are mapped by the set's maps.
2940
2941 Derivation:
2942 //AnnotableWhereType// (extension)
2943 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
2944 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
2945 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
2946 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
2947 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //StructureSetWhereBaseType// (extension)
2948 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSetWhereType
2949
2950 Attributes:
2951 type?
2952
2953 Content:
2954 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, RelatedStructures*, MappedObject*
2955
2956 Attribute Documentation:
2957
2958 |**Name**|**Type**|**Documentation**
2959 |type (fixed: StructureSet)|com: MaintainableTypeCode listType|The type attribute indicates the type of constraint that is being queried for, with a default of Any, meaning both content and attachment constraints will be searched.
2960 Element Documentation:
2961
2962 |**Name**|**Type**|**Documentation**
2963 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
2964 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
2965 |ID|QueryIDType|ID is used to match the id of the identified object.
2966 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2967 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
2968 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
2969 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
2970 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
2971 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
2972 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
2973 |RelatedStructures|com: StructureOrUsageRefe renceType|RelatedStructure is used to query for structure sets where the referenced key families, metadata structure definitions, dataflows, and metadataflows are related to another by the structure set.
2974 |MappedObject|MappedObjectType|MappedObject is used to query for structure sets where the reference object is mapped in one of the maps defined by the structure set. The referenced object can be specified as being either a source, a target, or either in the queried map.
2975
2976 **MappedObjectType: **MappedObjectType defines a structure for referencing an object and indicating whether it is the source, target, or either for the purposes of query for structure set containing the referenced object in one of the maps it defines.
2977
2978 Derivation:
2979 //com:ReferenceType// (restriction)
2980 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //com:MaintainableReferenceBaseType// (restriction)
2981 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] com:MaintainableReferenceType (restriction)
2982 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MappedObjectReferenceType (extension)
2983 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MappedObjectType
2984
2985 Attributes:
2986 type?
2987
2988 Content:
2989 ( (Ref, URN?) | URN)
2990
2991 Attribute Documentation:
2992
2993 |**Name**|**Type**|**Documentation**
2994 |type (default: Any)|SourceTargetType|The type attribute indicates whether the referenced object should be queried as the source, target, or both of a map.
2995
2996 Element Documentation:
2997
2998 |**Name**|**Type**|**Documentation**
2999 |Ref|MappedObjectRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3000 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3001 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3002
3003 **MappedObjectReferenceType: **MappedObjectReferenceType is a type for referencing any mappable object. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
3004
3005 Derivation:
3006 //com:ReferenceType// (restriction)
3007 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //com:MaintainableReferenceBaseType// (restriction)
3008 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] com:MaintainableReferenceType (restriction)
3009 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MappedObjectReferenceType
3010
3011 Content:
3012 ( (Ref, URN?) | URN)
3013
3014 Element Documentation:
3015
3016 |**Name**|**Type**|**Documentation**
3017 |Ref|MappedObjectRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3018 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3019 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3020
3021 **MappedObjectRefType: **MappedObjectRefType defines a set of reference fields for any type of mappable object.
3022
3023 Derivation:
3024 //com:RefBaseType// (restriction)
3025 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //com:MaintainableRefBaseType// (restriction)
3026 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] com:MaintainableRefType (restriction)
3027 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MappedObjectRefType
3028
3029 Attributes:
3030 agencyID, id, version?, local?, class, package
3031
3032 Content:
3033 {Empty}
3034
3035 Attribute Documentation:
3036
3037 |**Name**|**Type**|**Documentation**
3038 |agencyID|com: NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3039 |id|com:IDType|The id attribute identifies the object being referenced, and is therefore always required.
3040 |version (default: 1.0)|com:VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3041 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3042 |class|MappedObjectTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3043 |package|com: PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3044
3045 **StructuresQueryType: **StructuresQueryType defines the structure of a structures query. The parameters for the query are contained in the StructuresWhere element. The References element, typically used to indicate which objects should be returned, is fixed so that all object matching the parameters are returned..
3046
3047 Derivation:
3048 //StructuralMetadataQueryType// (restriction)
3049 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructuresQueryType
3050
3051 Content:
3052 ReturnDetails, StructuresWhere
3053
3054 Element Documentation:
3055
3056 |**Name**|**Type**|**Documentation**
3057 |ReturnDetails|MaintainableReturnDe tailsType|
3058 |StructuresWhere|StructuresWhereType|StructuresWhere defines the parameters for a structures query. All parameters must be matched for an object to satisfy the query. Only the basic maintainable parameters are available.
3059
3060 **StructuresWhereType: **StructuresWhereType contains a set of parameters for a structures query. All supplied parameters must be matched in order for an object to satisfy the query.
3061
3062 Derivation:
3063 //AnnotableWhereType// (extension)
3064 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3065 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3066 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3067 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (restriction)
3068 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructuresWhereType
3069
3070 Attributes:
3071 type?
3072
3073 Content:
3074 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?
3075
3076 Attribute Documentation:
3077
3078 |**Name**|**Type**|**Documentation**
3079 |type (fixed: Any)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3080
3081 Element Documentation:
3082
3083 |**Name**|**Type**|**Documentation**
3084 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3085 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3086 |ID|QueryIDType|ID is used to match the id of the identified object.
3087 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3088 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3089 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3090 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3091 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3092 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3093 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3094
3095 **//DefinitionSchemeWhereType//: **DefinitionSchemeWhereType is an abstract base type that extends and item scheme query to add the ability to query based on the VTL version.
3096
3097 Derivation:
3098 //AnnotableWhereType// (extension)
3099 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3100 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3101 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3102 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3103 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (extension)
3104 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DefinitionSchemeWhereType//
3105
3106 Attributes:
3107 type?
3108
3109 Content:
3110 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, //ItemWhere*//, VtlVersion?
3111
3112 Attribute Documentation:
3113
3114 |**Name**|**Type**|**Documentation**
3115 |type|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3116
3117 Element Documentation:
3118
3119 |**Name**|**Type**|**Documentation**
3120 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3121 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3122 |ID|QueryIDType|ID is used to match the id of the identified object.
3123 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3124 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3125 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3126 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3127 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3128 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3129 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3130 |//ItemWhere//|//ItemWhereType//|ItemWhere is an abstract substitution head to query for an item within a parent item where or an item scheme query. An item where query is implicitly an and-query - that is the conditions within the item where must all be met in order to return a match. If this is nested within another item where, the meaning is that the conditions specified must be matched within the hierarchy provided.
3131 |VtlVersion|com:VersionQueryType|Allows querying based on the VTL version number.
3132
3133 **TransformationSchemeQueryType: **TransformationSchemeQueryType defines the structure of a transformation scheme query. The parameters for the query are contained in the TransformationSchemeWhere element. The References element is used to indicate how objects that are referenced from the matched transformation scheme should be returned.
3134
3135 Derivation:
3136 //StructuralMetadataQueryType// (restriction)
3137 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TransformationSchemeQueryType
3138
3139 Content:
3140 ReturnDetails, TransformationSchemeWhere
3141
3142 Element Documentation:
3143
3144 |**Name**|**Type**|**Documentation**
3145 |ReturnDetails|MaintainableReturnDe tailsType|
3146 |TransformationScheme Where|TransformationScheme WhereType|TransformationSchemeWhere contains the parameters for a transformation scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the transformations defined within the scheme.
3147
3148 **//TransformationSchemeWhereBaseType//: **TransformationSchemeWhereBaseType is an abstract base type which forms the basis for the TransformationSchemeWhereType.
3149
3150 Derivation:
3151 //AnnotableWhereType// (extension)
3152 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3153 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3154 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3155 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3156 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (extension)
3157 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DefinitionSchemeWhereType// (restriction)
3158 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //TransformationSchemeWhereBaseType//
3159
3160 Attributes:
3161 type?
3162
3163 Content:
3164 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, TransformationWhere*, VtlVersion?
3165
3166 Attribute Documentation:
3167
3168 |**Name**|**Type**|**Documentation**
3169 |type (fixed: TransformationScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3170
3171 Element Documentation:
3172
3173 |**Name**|**Type**|**Documentation**
3174 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3175 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3176 |ID|QueryIDType|ID is used to match the id of the identified object.
3177 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3178 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3179 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3180 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3181 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3182 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3183 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3184 |TransformationWhere|TransformationWhereT ype|TransformationWhere is used to query for transformations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
3185 |VtlVersion|com:VersionQueryType|Allows querying based on the VTL version number.
3186
3187 **TransformationSchemeWhereType: **TransformationSchemeWhereType defines the parameters of a transformation scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
3188
3189 Derivation:
3190 //AnnotableWhereType// (extension)
3191 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3192 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3193 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3194 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3195 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (extension)
3196 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DefinitionSchemeWhereType// (restriction)
3197 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //TransformationSchemeWhereBaseType// (extension)
3198 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TransformationSchemeWhereType
3199
3200 Attributes:
3201 type?
3202
3203 Content:
3204 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, TransformationWhere*, VtlVersion?, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme?, UserDefinedOperatorScheme?
3205
3206 Attribute Documentation:
3207
3208 |**Name**|**Type**|**Documentation**
3209 |type (fixed: TransformationScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3210
3211 Element Documentation:
3212
3213 |**Name**|**Type**|**Documentation**
3214 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3215 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3216 |ID|QueryIDType|ID is used to match the id of the identified object.
3217 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3218 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3219 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3220 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3221 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3222 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3223 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3224 |TransformationWhere|TransformationWhereT ype|TransformationWhere is used to query for transformations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
3225 |VtlVersion|com:VersionQueryType|Allows querying based on the VTL version number.
3226 |VtlMappingScheme|com: VtlMappingSchemeRefe renceType|VtlMappingScheme is used to query for a transformation scheme based on the VTL mapping scheme that is used in the transformations.
3227 |NamePersonalisationS cheme|com: NamePersonalisationS chemeReferenceType|NamePersonalisationScheme is used to query for a transformation scheme based on the name personalisation scheme that is used in the transformations.
3228 |CustomTypeScheme|com: CustomTypeSchemeRefe renceType|CustomTypeScheme is used to query for a transformation scheme based on the custom type scheme that is used in the transformations.
3229 |RulesetScheme|com: RulesetSchemeReferen ceType|RulesetScheme is used to query for a transformation scheme based on the ruleset scheme that is used in the transformations.
3230 |UserDefinedOperatorS cheme|com: UserDefinedOperatorS chemeReferenceType|UserDefinedOperatorScheme is used to query for a transformation scheme based on the user defined operator scheme that is used in the transformations.
3231
3232 **//TransformationWhereBaseType//: **TransformationWhereBaseType is an abstract base type that forms the basis for the TransformationWhereType.
3233
3234 Derivation:
3235 //AnnotableWhereType// (extension)
3236 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3237 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3238 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
3239 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //TransformationWhereBaseType//
3240
3241 Content:
3242 Annotation?, ID?, Name?, Description?
3243
3244 Element Documentation:
3245
3246 |**Name**|**Type**|**Documentation**
3247 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3248 |ID|QueryIDType|ID is used to match the id of the identified object.
3249 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3250 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3251
3252 **TransformationWhereType: **TransformationWhereType defines a set of parameters for matching a transformation. All supplied parameters must be matched in order for an object to satisfy the query. In addition to the base parameters for an item, a transformation can be queried based on identifiable artefacts that are used in the expression.
3253
3254 Derivation:
3255 //AnnotableWhereType// (extension)
3256 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3257 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3258 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
3259 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //TransformationWhereBaseType// (extension)
3260 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] TransformationWhereType
3261
3262 Content:
3263 Annotation?, ID?, Name?, Description?, IdentifiableArtefact*
3264
3265 Element Documentation:
3266
3267 |**Name**|**Type**|**Documentation**
3268 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3269 |ID|QueryIDType|ID is used to match the id of the identified object.
3270 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3271 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3272 |IdentifiableArtefact|com: ObjectReferenceType|IdentifiableArtefact allows a transformation to be queried based on the identifiable artefact it uses in its expression.
3273
3274 **VtlMappingSchemeQueryType: **VtlMappingSchemeQueryType defines the structure of a VTL mapping scheme query. The parameters for the query are contained in the VtlMappingSchemeWhere element. The References element is used to indicate how objects that are referenced from the matched VTL mapping scheme should be returned.
3275
3276 Derivation:
3277 //StructuralMetadataQueryType// (restriction)
3278 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] VtlMappingSchemeQueryType
3279
3280 Content:
3281 ReturnDetails, VtlMappingSchemeWhere
3282
3283 Element Documentation:
3284
3285 |**Name**|**Type**|**Documentation**
3286 |ReturnDetails|MaintainableReturnDe tailsType|
3287 |VtlMappingSchemeWher e|VtlMappingSchemeWher eType|VtlMappingSchemeWhere contains the parameters for a VTL mapping scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the VTL mappings defined within the scheme.
3288
3289 **VtlMappingSchemeWhereType: **VtlMappingSchemeWhereType defines the parameters of a VTL mapping scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
3290
3291 Derivation:
3292 //AnnotableWhereType// (extension)
3293 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3294 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3295 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3296 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3297 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (restriction)
3298 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] VtlMappingSchemeWhereType
3299
3300 Attributes:
3301 type?
3302
3303 Content:
3304 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, VtlMappingWhere*
3305
3306 Attribute Documentation:
3307
3308 |**Name**|**Type**|**Documentation**
3309 |type (fixed: VtlMappingScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3310
3311 Element Documentation:
3312
3313 |**Name**|**Type**|**Documentation**
3314 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3315 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3316 |ID|QueryIDType|ID is used to match the id of the identified object.
3317 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3318 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3319 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3320 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3321 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3322 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3323 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3324 |VtlMappingWhere|VtlMappingWhereType|VtlMappingWhere is used to query for VTL mappings matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
3325
3326 **VtlMappingWhereType: **VtlMappingWhereType defines a set of parameters for matching a VTL mapping. All supplied parameters must be matched in order for an object to satisfy the query.
3327
3328 Derivation:
3329 //AnnotableWhereType// (extension)
3330 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3331 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3332 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
3333 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] VtlMappingWhereType
3334
3335 Content:
3336 Annotation?, ID?, Name?, Description?
3337
3338 Element Documentation:
3339
3340 |**Name**|**Type**|**Documentation**
3341 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3342 |ID|QueryIDType|ID is used to match the id of the identified object.
3343 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3344 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3345
3346 **NamePersonalisationSchemeQueryType: **NamePersonalisationSchemeQueryType defines the structure of a name personalisation scheme query. The parameters for the query are contained in the NamePersonalisationSchemeWhere element. The References element is used to indicate how objects that are referenced from the matched name personalisation scheme should be returned.
3347
3348 Derivation:
3349 //StructuralMetadataQueryType// (restriction)
3350 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] NamePersonalisationSchemeQueryType
3351
3352 Content:
3353 ReturnDetails, NamePersonalisationSchemeWhere
3354
3355 Element Documentation:
3356
3357 |**Name**|**Type**|**Documentation**
3358 |ReturnDetails|MaintainableReturnDe tailsType|
3359 |NamePersonalisationS chemeWhere|NamePersonalisationS chemeWhereType|NamePersonalisationSchemeWhere contains the parameters for a name personalisation scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the name personalisations defined within the scheme.
3360
3361 **NamePersonalisationSchemeWhereType: **NamePersonalisationSchemeWhereType defines the parameters of a name personalisation scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
3362
3363 Derivation:
3364 //AnnotableWhereType// (extension)
3365 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3366 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3367 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3368 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3369 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (extension)
3370 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DefinitionSchemeWhereType// (restriction)
3371 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] NamePersonalisationSchemeWhereType
3372
3373 Attributes:
3374 type?
3375
3376 Content:
3377 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, NamePersonalisationWhere*, VtlVersion?
3378
3379 Attribute Documentation:
3380
3381 |**Name**|**Type**|**Documentation**
3382 |type (fixed: NamePersonalisationScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3383
3384 Element Documentation:
3385
3386 |**Name**|**Type**|**Documentation**
3387 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3388 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3389 |ID|QueryIDType|ID is used to match the id of the identified object.
3390 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3391 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3392 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3393 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3394 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3395 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3396 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3397 |NamePersonalisationW here|NamePersonalisationW hereType|NamePersonalisationWhere is used to query for name personalisations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
3398 |VtlVersion|com:VersionQueryType|Allows querying based on the VTL version number.
3399
3400 **NamePersonalisationWhereType: **NamePersonalisationWhereType defines a set of parameters for matching a name personalisation. All supplied parameters must be matched in order for an object to satisfy the query.
3401
3402 Derivation:
3403 //AnnotableWhereType// (extension)
3404 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3405 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3406 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
3407 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] NamePersonalisationWhereType
3408
3409 Content:
3410 Annotation?, ID?, Name?, Description?
3411
3412 Element Documentation:
3413
3414 |**Name**|**Type**|**Documentation**
3415 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3416 |ID|QueryIDType|ID is used to match the id of the identified object.
3417 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3418 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3419
3420 **RulesetSchemeQueryType: **RulesetSchemeQueryType defines the structure of a ruleset scheme query. The parameters for the query are contained in the RuleSetSchemeWhere element. The References element is used to indicate how objects that are referenced from the matched ruleset scheme should be returned.
3421
3422 Derivation:
3423 //StructuralMetadataQueryType// (restriction)
3424 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RulesetSchemeQueryType
3425
3426 Content:
3427 ReturnDetails, RulesetSchemeWhere
3428
3429 Element Documentation:
3430
3431 |**Name**|**Type**|**Documentation**
3432 |ReturnDetails|MaintainableReturnDe tailsType|
3433 |RulesetSchemeWhere|RulesetSchemeWhereTy pe|RulesetSchemeWhere contains the parameters for a ruleset scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the rulesets defined within the scheme.
3434
3435 **RulesetSchemeWhereType: **RulesetSchemeWhereType defines the parameters of a ruleset scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
3436
3437 Derivation:
3438 //AnnotableWhereType// (extension)
3439 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3440 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3441 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3442 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3443 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (extension)
3444 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DefinitionSchemeWhereType// (restriction)
3445 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RulesetSchemeWhereType
3446
3447 Attributes:
3448 type?
3449
3450 Content:
3451 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, RulesetWhere*, VtlVersion?
3452
3453 Attribute Documentation:
3454
3455 |**Name**|**Type**|**Documentation**
3456 |type (fixed: RulesetScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3457
3458 Element Documentation:
3459
3460 |**Name**|**Type**|**Documentation**
3461 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3462 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3463 |ID|QueryIDType|ID is used to match the id of the identified object.
3464 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3465 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3466 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3467 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3468 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3469 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3470 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3471 |RulesetWhere|RulesetWhereType|RulesetWhere is used to query for rulesets matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
3472 |VtlVersion|com:VersionQueryType|Allows querying based on the VTL version number.
3473
3474 **RulesetWhereType: **RulesetWhereType defines a set of parameters for matching a ruleset. All supplied parameters must be matched in order for an object to satisfy the query.
3475
3476 Derivation:
3477 //AnnotableWhereType// (extension)
3478 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3479 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3480 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
3481 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RulesetWhereType
3482
3483 Content:
3484 Annotation?, ID?, Name?, Description?
3485
3486 Element Documentation:
3487
3488 |**Name**|**Type**|**Documentation**
3489 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3490 |ID|QueryIDType|ID is used to match the id of the identified object.
3491 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3492 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3493
3494 **UserDefinedOperatorSchemeQueryType: **UserDefinedOperatorSchemeQueryType defines the structure of a user defined operator scheme query. The parameters for the query are contained in the UserDefinedOperatorSchemeWhere element. The References element is used to indicate how objects that are referenced from the matched user defined operator scheme should be returned.
3495
3496 Derivation:
3497 //StructuralMetadataQueryType// (restriction)
3498 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] UserDefinedOperatorSchemeQueryType
3499
3500 Content:
3501 ReturnDetails, UserDefinedOperatorSchemeWhere
3502
3503 Element Documentation:
3504
3505 |**Name**|**Type**|**Documentation**
3506 |ReturnDetails|MaintainableReturnDe tailsType|
3507 |UserDefinedOperatorS chemeWhere|UserDefinedOperatorS chemeWhereType|UserDefinedOperatorSchemeWhere contains the parameters for a user defined operator scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the user defined operators defined within the scheme.
3508
3509 **UserDefinedOperatorSchemeWhereType: **UserDefinedOperatorSchemeWhereType defines the parameters of a user defined operator scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
3510
3511 Derivation:
3512 //AnnotableWhereType// (extension)
3513 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3514 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3515 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3516 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3517 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (extension)
3518 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DefinitionSchemeWhereType// (restriction)
3519 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] UserDefinedOperatorSchemeWhereType
3520
3521 Attributes:
3522 type?
3523
3524 Content:
3525 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UserDefinedOperatorWhere*, VtlVersion?
3526
3527 Attribute Documentation:
3528
3529 |**Name**|**Type**|**Documentation**
3530 |type (fixed: UserDefinedOperatorScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3531
3532 Element Documentation:
3533
3534 |**Name**|**Type**|**Documentation**
3535 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3536 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3537 |ID|QueryIDType|ID is used to match the id of the identified object.
3538 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3539 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3540 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3541 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3542 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3543 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3544 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3545 |UserDefinedOperatorW here|UserDefinedOperatorW hereType|UserDefinedOperatorWhere is used to query for user defined operators matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
3546 |VtlVersion|com:VersionQueryType|Allows querying based on the VTL version number.
3547
3548 **UserDefinedOperatorWhereType: **UserDefinedOperatorWhereType defines a set of parameters for matching a user defined operator. All supplied parameters must be matched in order for an object to satisfy the query.
3549
3550 Derivation:
3551 //AnnotableWhereType// (extension)
3552 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3553 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3554 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
3555 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] UserDefinedOperatorWhereType
3556
3557 Content:
3558 Annotation?, ID?, Name?, Description?
3559
3560 Element Documentation:
3561
3562 |**Name**|**Type**|**Documentation**
3563 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3564 |ID|QueryIDType|ID is used to match the id of the identified object.
3565 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3566 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3567
3568 **CustomTypeSchemeQueryType: **CustomTypeSchemeQueryType defines the structure of a custom type scheme query. The parameters for the query are contained in the CustomTypeSchemeWhere element. The References element is used to indicate how objects that are referenced from the matched custom type scheme should be returned.
3569
3570 Derivation:
3571 //StructuralMetadataQueryType// (restriction)
3572 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CustomTypeSchemeQueryType
3573
3574 Content:
3575 ReturnDetails, CustomTypeSchemeWhere
3576
3577 Element Documentation:
3578
3579 |**Name**|**Type**|**Documentation**
3580 |ReturnDetails|MaintainableReturnDe tailsType|
3581 |CustomTypeSchemeWher e|CustomTypeSchemeWher eType|CustomTypeSchemeWhere contains the parameters for a custom type scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the custom types defined within the scheme.
3582
3583 **CustomTypeSchemeWhereType: **CustomTypeSchemeWhereType defines the parameters of a custom type scheme query. All supplied parameters must be matched in order for an object to satisfy the query.
3584
3585 Derivation:
3586 //AnnotableWhereType// (extension)
3587 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3588 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3589 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //VersionableWhereType// (extension)
3590 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //MaintainableWhereType// (extension)
3591 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemSchemeWhereType// (extension)
3592 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //DefinitionSchemeWhereType// (restriction)
3593 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CustomTypeSchemeWhereType
3594
3595 Attributes:
3596 type?
3597
3598 Content:
3599 Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CustomTypeWhere*, VtlVersion?
3600
3601 Attribute Documentation:
3602
3603 |**Name**|**Type**|**Documentation**
3604 |type (fixed: CustomTypeScheme)|com: MaintainableTypeCode listType|The type attribute optionally defines the type of object being queried. For queries for distinct types of objects, a fixed value should be specified in the derived queries. For queries that serve to query for like types of objects, this should be required.
3605
3606 Element Documentation:
3607
3608 |**Name**|**Type**|**Documentation**
3609 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3610 |URN|xs:anyURI|URN is used to match the urn of any SDMX object.
3611 |ID|QueryIDType|ID is used to match the id of the identified object.
3612 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3613 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3614 |Version|com:VersionQueryType|Version is used to match the version of the versioned object. The version can be specified as either an explicit version number, or a late bound query where the latest version of an object will be returned.
3615 |VersionTo|com: TimeRangeValueType|VersionTo is used to specify a range which the start date of the validity period of version should fall within to create a successful match.
3616 |VersionFrom|com: TimeRangeValueType|VersionFrom is used to specify a range which the end date of the validity period of version should fall within to create a successful match.
3617 |VersionActive|xs:boolean|VersionActive is used to request object with active or inactive versions, base on the version validity dates. A value of true indicates that only objects where the current date is within the validity period of the version will be matched.
3618 |AgencyID|QueryNestedIDType|AgencyID is used to match the agency id of the maintained object.
3619 |CustomTypeWhere|CustomTypeWhereType|CustomTypeWhere is used to query for custom types matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.
3620 |VtlVersion|com:VersionQueryType|Allows querying based on the VTL version number.
3621
3622 **CustomTypeWhereType: **CustomTypeWhereType defines a set of parameters for matching a custom type. All supplied parameters must be matched in order for an object to satisfy the query.
3623
3624 Derivation:
3625 //AnnotableWhereType// (extension)
3626 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //IdentifiableWhereType// (extension)
3627 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //NameableWhereType// (extension)
3628 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] //ItemWhereType// (restriction)
3629 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CustomTypeWhereType
3630
3631 Content:
3632 Annotation?, ID?, Name?, Description?
3633
3634 Element Documentation:
3635
3636 |**Name**|**Type**|**Documentation**
3637 |Annotation|AnnotationWhereType|Annotation is a parameter for matching the details of an annotatable object's annotations. It allows for querying based on the details of an annotation.
3638 |ID|QueryIDType|ID is used to match the id of the identified object.
3639 |Name|QueryTextType|Name is used to match the name of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each name search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3640 |Description|QueryTextType|Description is used to match the description of the identified object. It may occur multiple times for its usage within an or-query or for multi-lingual searches, however if multiple values are supplied in an and-query (explicit or implicit), each description search will have to be found in order to constitute a match. The value here can either be an explicit value (exact match) or a regular expression pattern on which to match.
3641
3642 === 2.1.4 Simple Types ===
3643
3644 **StructureReturnDetailType: **StructureReturnDetailType contains a set of enumerations that indicate how much detail should be returned for an object.
3645
3646 Derived by restriction of xs:string .
3647
3648 Enumerations:
3649
3650 |**Value**|**Documentation**
3651 |Stub|Only the identification information and name should be returned.
3652 |CompleteStub|Identification information, name, description, and annotations should be returned.
3653 |Full|The entire detail of the object should be returned.
3654 |MatchedItems|For an item scheme, only the items matching the item where parameters will be returned. In the case that items are hierarchical, the entire hierarchy leading to the matched item will have to be returned.
3655 |CascadedMatchedItems|For an item scheme, only the items matching the item where parameters, and their hierarchical child items will be returned. In the case that items are hierarchical, the entire hierarchy leading to the matched item will have to be returned.
3656
3657 **MaintainableReturnDetailType: **MaintainableReturnDetailType contains a sub set of the enumerations defined in the ReturnDetailType. Enumerations relating specifically to item schemes are not included
3658
3659 Derived by restriction of StructureReturnDetailType .
3660
3661 Enumerations:
3662
3663 |**Value**|**Documentation**
3664 |Stub|Only the identification information and name should be returned.
3665 |CompleteStub|Identification information, name, description, and annotations should be returned.
3666 |Full|The entire detail of the object should be returned.
3667
3668 **ReportingYearStartDayQueryType: **ReportingYearStartDayQueryType is a simple type for specifying the reporting year start day in a time query parameter. An explicit value or "Any" can be provided.
3669
3670 Union of:
3671 AnyQueryType, xs:gMonthDay.
3672
3673 **AnyQueryType: **AnyQueryType is a single enumeration of the value "Any" which is meant to be used in union with other simple types when a query allows for any of the possible values.
3674
3675 Derived by restriction of xs:string.
3676
3677 Enumerations:
3678
3679 |**Value**|**Documentation**
3680 |Any|
3681
3682 **ConstraintTypeCodelistType: **ConstraintTypeCodelistType defines a list of types for a constraint for the purpose of querying.
3683
3684 Derived by restriction of com:MaintainableTypeCodelistType .
3685
3686 Enumerations:
3687
3688 |**Value**|**Documentation**
3689 |Constraint|
3690 |AttachmentConstraint|
3691 |ContentConstraint|
3692
3693 **DataReturnDetailType: **DataReturnDetailType contains a set of enumerations that indicate how much detail should be returned for a data set.
3694
3695 Derived by restriction of xs:string .
3696
3697 Enumerations:
3698
3699 |**Value**|**Documentation**
3700 |Full|The entire data set (including all data, documentation, and annotations) will be returned.
3701 |DataOnly|Only the observed values and their keys will be returned. Annotations and documentation (i.e. Attributes) and therefore Groups, will be excluded.
3702 |SeriesKeyOnly|Only the series elements and the values for the dimensions will be returned. Annotations, documentation, and observations will be excluded.
3703 |NoData|Returns all documentation at the DataSet, Group, and Series level without any Observations (therefore, Observation level documentation is not returned). Annotations are not returned.
3704
3705 **ObservationActionCodeType: **ObservationActionCodeType enumerates the type of observations to be returned.
3706
3707 Derived by restriction of xs:string .
3708
3709 Enumerations:
3710
3711 |**Value**|**Documentation**
3712 |Active|Active observations, regardless of when they were added or updated will be returned.
3713 |Added|Only newly added observations will be returned.
3714 |Updated|Only updated observations will be returned.
3715 |Deleted|Only deleted observations will be returned.
3716
3717 **OrganisationSchemeTypeCodeType: **OrganisationSchemeTypeCodeType enumerates the possible types of organisation schemes that can be queried for.
3718
3719 Derived by restriction of com:MaintainableTypeCodelistType .
3720
3721 Enumerations:
3722
3723 |**Value**|**Documentation**
3724 |OrganisationScheme|
3725 |AgencyScheme|
3726 |DataConsumerScheme|
3727 |DataProviderScheme|
3728 |OrganisationUnitScheme|
3729
3730 **InputOutputTypeCodeType: **InputOutputTypeCodeType enumerates the role an object plays in a process step.
3731
3732 Derived by restriction of xs:string .
3733
3734 Enumerations:
3735
3736 |**Value**|**Documentation**
3737 |Input|Input - referenced object is an input to the process step.
3738 |Output|Output - referenced object is an output to the process step.
3739 |Any|Any - referenced object is either an input or an output to the process step.
3740
3741 **MappedObjectTypeCodelistType: **MappedObjectTypeCodelistType is a restriction of the MaintainableTypeCodelistType which contains only the object types which can be mapped in a structure set.
3742
3743 Derived by restriction of com:ConcreteMaintainableTypeCodelistType .
3744
3745 Enumerations:
3746
3747 |**Value**|**Documentation**
3748 |AgencyScheme|
3749 |CategoryScheme|
3750 |Codelist|
3751 |ConceptScheme|
3752 |Dataflow|
3753 |DataConsumerScheme|
3754 |DataProviderScheme|
3755 |DataStructure|
3756 |HierarchicalCodelist|
3757 |Metadataflow|
3758 |MetadataStructure|
3759 |OrganisationUnitScheme|
3760 |ReportingTaxonomy|
3761
3762 **SourceTargetType: **SourceTargetType is an enumeration to indicate whether an object is the source, target, or either of the two options.
3763
3764 Derived by restriction of xs:string .
3765
3766 Enumerations:
3767
3768 |**Value**|**Documentation**
3769 |Any|
3770 |Source|
3771 |Target|