Skip to Content

Wiki source code of Part V. Query

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