Skip to Content

Wiki source code of Part V. Query

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