Wiki source code of Part V. Query Namespace
Last modified by Artur on 2025/09/10 11:19
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | = 1. Introduction = | ||
| 6 | |||
| 7 | The query constructs in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>doc:sdmx:Glossary.Structural metadata.WebHome]], the queries derive from types as they do in the information model. Because a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] and a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] 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>>doc:sdmx:Glossary.Code list.WebHome]] to be explicit as to the fact that the only acceptable input to this query is a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Structural metadata.WebHome]] 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>>doc:sdmx:Glossary.Item scheme.WebHome]] 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>>doc:sdmx:Glossary.Hierarchy.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]] list within a structure. A [[component>>doc:sdmx:Glossary.Component.WebHome]] list where query is implicitly an and-query - that is the conditions within the [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]] within a [[component>>doc:sdmx:Glossary.Component.WebHome]] list or a structure. A [[component>>doc:sdmx:Glossary.Component.WebHome]] where query is implicitly an and-query - that is the conditions within the [[component>>doc:sdmx:Glossary.Component.WebHome]] 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 (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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 (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]]. 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 (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]]. This should be used for (% style="color:#e74c3c" %)concepts(%%) or [[components>>doc:sdmx:Glossary.Component.WebHome]] based on a simple value (e.g. a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Category.WebHome]] the object is categorized against. | ||
| 61 | |||
| 62 | Substitution For: //StructuralMetadataWhere// | ||
| 63 | |||
| 64 | **CategorySchemeWhere (CategorySchemeWhereType): **CategorySchemeWhere contains the parameters for a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] 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>>doc:sdmx:Glossary.Category scheme.WebHome]] based on the details of its [[categories>>doc:sdmx:Glossary.Category.WebHome]]. In any case, the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] will be returned according the indicated return detail. | ||
| 65 | |||
| 66 | Substitution For: //StructuralMetadataWhere// | ||
| 67 | |||
| 68 | **CategoryWhere (CategoryWhereType): **CategoryWhere is used to query for [[categories>>doc:sdmx:Glossary.Category.WebHome]] matching the parameters supplied. It allows for nested [[category>>doc:sdmx:Glossary.Category.WebHome]] queries so that hierarchical [[categories>>doc:sdmx:Glossary.Category.WebHome]] can be queried explicitly by their nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) [[category>>doc:sdmx:Glossary.Category.WebHome]] will always result in a search for [[categories>>doc:sdmx:Glossary.Category.WebHome]] at any (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]]. In any case, the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] will be returned according the indicated return detail. | ||
| 73 | |||
| 74 | Substitution For: //StructuralMetadataWhere// | ||
| 75 | |||
| 76 | **CodeWhere (CodeWhereType): **CodeWhere is used to query for [[codes>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Concept scheme.WebHome]] 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>>doc:sdmx:Glossary.Concept scheme.WebHome]] based on the details of its (% style="color:#e74c3c" %)concepts(%%). In any case, the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] will be returned according the indicated return detail. | ||
| 81 | |||
| 82 | Substitution For: //StructuralMetadataWhere// | ||
| 83 | |||
| 84 | **ConceptWhere (ConceptWhereType): **ConceptWhere is used to query for (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)constraint(%%) based on the objects it applies to. | ||
| 89 | |||
| 90 | Substitution For: //StructuralMetadataWhere// | ||
| 91 | |||
| 92 | **DataflowWhere (DataflowWhereType): **DataflowWhere defines the parameters for a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] 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>>doc:sdmx:Glossary.Dataflow.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 97 | |||
| 98 | Substitution For: //StructuralMetadataWhere// | ||
| 99 | |||
| 100 | **GroupWhere (GroupWhereType): **GroupWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] meeting the conditions contained in this structure. The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, its [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]], the role it plays, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] meeting the conditions contained in this structure. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, the role it plays, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] meeting the conditions contained in this structure. The time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be queried based on its identification and the (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] meeting the conditions contained in this structure. The primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] meeting the conditions contained in this structure. The cross-sectional [[measure>>doc:sdmx:Glossary.Measure.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. 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>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Code list.WebHome]] based on the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] it arranges into hierarchies. | ||
| 129 | |||
| 130 | Substitution For: //StructuralMetadataWhere// | ||
| 131 | |||
| 132 | **MetadataflowWhere (MetadataflowWhereType): **MetadataflowWhere contains the parameters for a [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] 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>>doc:sdmx:Glossary.Metadataflow.WebHome]] based on the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] it defines the usage of. | ||
| 133 | |||
| 134 | Substitution For: //StructuralMetadataWhere// | ||
| 135 | |||
| 136 | **MetadataStructureWhere (MetadataStructureWhereType): **MetadataStructureWhere contains the parameters for a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] 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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. | ||
| 137 | |||
| 138 | Substitution For: //StructuralMetadataWhere// | ||
| 139 | |||
| 140 | **MetadataTargetWhere (MetadataTargetWhereType): **MetadataTargetWhere is used to query for a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] 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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a contained identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a given report structure meets the conditions specified. A report structure can be queried based on identification or details about its metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. 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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a contained metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] meets the conditions specified. A metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] it uses as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. Nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] allow for the querying of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] explicitly at nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] query will be processed by querying metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at any (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Provision agreement.WebHome]] 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>>doc:sdmx:Glossary.Provision agreement.WebHome]] based on the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] 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>>doc:sdmx:Glossary.Reporting category.WebHome]]. 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>>doc:sdmx:Glossary.Reporting category.WebHome]] matching the parameters supplied. It allows for nested reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] queries so that hierarchical [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] can be queried explicitly by their nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] will always result in a search for [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] at any (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)mapped(%%) by the set's (% style="color:#e74c3c" %)maps(%%). In any case, the [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]] 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>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] 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>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mappings defined within the scheme. | ||
| 197 | |||
| 198 | Substitution For: //StructuralMetadataWhere// | ||
| 199 | |||
| 200 | **VtlMappingWhere (VtlMappingWhereType): **VtlMappingWhere is used to query for [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 241 | defaultLimit?, detail? | ||
| 242 | |||
| 243 | Content: | ||
| 244 | {Empty} | ||
| 245 | |||
| 246 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 247 | |||
| 248 | (% style="width:1009.29px" %) | ||
| 249 | |(% style="width:120px" %)**Name**|(% style="width:122px" %)**Type**|(% style="width:765px" %)**Documentation** | ||
| 250 | |(% style="width:120px" %)defaultLimit|(% style="width:122px" %)xs:integer|(% style="width:765px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 251 | |(% style="width:120px" %)detail|(% style="width:122px" %)xs:string|(% style="width:765px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Structural metadata.WebHome]] 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 | (% style="width:1082.29px" %) | ||
| 261 | |**Name**|**Type**|(% style="width:675px" %)**Documentation** | ||
| 262 | |ReturnDetails|StructureReturnDetailsType|(% style="width:675px" %) | ||
| 263 | |//StructuralMetadataWhere//|//MaintainableWhereType//|(% style="width:675px" %)StructuralMetadataWhere is an abstract substitution head that forms the basis of any [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] 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. | ||
| 264 | |||
| 265 | **//StructureReturnDetailsBaseType//: **StructureReturnDetailsBaseType is an abstract base type which forms the basis of StructureReturnDetailsType. | ||
| 266 | |||
| 267 | Derivation: | ||
| 268 | |||
| 269 | * //ReturnDetailsBaseType// (restriction) | ||
| 270 | ** //StructureReturnDetailsBaseType// | ||
| 271 | |||
| 272 | Attributes: | ||
| 273 | defaultLimit?, detail? | ||
| 274 | |||
| 275 | Content: | ||
| 276 | {Empty} | ||
| 277 | |||
| 278 | Attribute Documentation: | ||
| 279 | |||
| 280 | (% style="width:1066.29px" %) | ||
| 281 | |**Name**|**Type**|(% style="width:765px" %)**Documentation** | ||
| 282 | |defaultLimit|xs:integer|(% style="width:765px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 283 | |detail (default: Full)|StructureReturnDetailType|(% style="width:765px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Annotation.WebHome]] 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 (% style="color:#e74c3c" %)level(%%) of detail returned for referenced objects. | ||
| 284 | |||
| 285 | **StructureReturnDetailsType: **StructureReturnDetailsType defines the structure of the return details for any [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] query. | ||
| 286 | |||
| 287 | Derivation: | ||
| 288 | |||
| 289 | * //ReturnDetailsBaseType// (restriction) | ||
| 290 | ** //StructureReturnDetailsBaseType// (extension) | ||
| 291 | *** StructureReturnDetailsType | ||
| 292 | |||
| 293 | Attributes: | ||
| 294 | defaultLimit?, detail?, returnMatchedArtefact? | ||
| 295 | |||
| 296 | Content: | ||
| 297 | References | ||
| 298 | |||
| 299 | Attribute Documentation: | ||
| 300 | |||
| 301 | (% style="width:1087.29px" %) | ||
| 302 | |**Name**|**Type**|(% style="width:698px" %)**Documentation** | ||
| 303 | |defaultLimit|xs:integer|(% style="width:698px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 304 | |detail (default: Full)|StructureReturnDetailType|(% style="width:698px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Annotation.WebHome]] 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 (% style="color:#e74c3c" %)level(%%) of detail returned for referenced objects. | ||
| 305 | |returnMatchedArtefact (default: true)|xs:boolean|(% style="width:698px" %)The returnMatchedArtefact [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 306 | |||
| 307 | Element Documentation: | ||
| 308 | |||
| 309 | (% style="width:1083.29px" %) | ||
| 310 | |**Name**|(% style="width:154px" %)**Type**|(% style="width:752px" %)**Documentation** | ||
| 311 | |References|(% style="width:154px" %)ReferencesType|(% style="width:752px" %)References is used to communicate how objects that reference or are referenced by the object(s) being queried should be returned. | ||
| 312 | |||
| 313 | **MaintainableReturnDetailsType: **MaintainableReturnDetailsType defines the structure for the return details of a non-[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] maintainable object. It eliminates the detail options that are specific to searching an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] | ||
| 314 | |||
| 315 | Derivation: | ||
| 316 | |||
| 317 | * //ReturnDetailsBaseType// (restriction) | ||
| 318 | ** //StructureReturnDetailsBaseType// (extension) | ||
| 319 | *** StructureReturnDetailsType (restriction) | ||
| 320 | **** MaintainableReturnDetailsType | ||
| 321 | |||
| 322 | Attributes: | ||
| 323 | defaultLimit?, detail?, returnMatchedArtefact? | ||
| 324 | |||
| 325 | Content: | ||
| 326 | References | ||
| 327 | |||
| 328 | Attribute Documentation: | ||
| 329 | |||
| 330 | (% style="width:1067.29px" %) | ||
| 331 | |**Name**|**Type**|(% style="width:664px" %)**Documentation** | ||
| 332 | |defaultLimit|xs:integer|(% style="width:664px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 333 | |detail (default: Full)|MaintainableReturnDetailType|(% style="width:664px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Annotation.WebHome]] 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 (% style="color:#e74c3c" %)level(%%) of detail returned for referenced objects. | ||
| 334 | |returnMatchedArtefact (default: true)|xs:boolean|(% style="width:664px" %)The returnMatchedArtefact [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 335 | |||
| 336 | Element Documentation: | ||
| 337 | |||
| 338 | (% style="width:1061.29px" %) | ||
| 339 | |**Name**|**Type**|(% style="width:650px" %)**Documentation** | ||
| 340 | |References|ReferencesType|(% style="width:650px" %)References is used to communicate how objects that reference or are referenced by the object(s) being queried should be returned. | ||
| 341 | |||
| 342 | **ReferencesType: **ReferencesType defines the structure for indicating which referenced objects should be returned in a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] 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. | ||
| 343 | |||
| 344 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 345 | processConstraints?, detail? | ||
| 346 | |||
| 347 | Content: | ||
| 348 | (None | All | Parents | ParentsAndSiblings | Children | Descendants | SpecificObjects) | ||
| 349 | |||
| 350 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 351 | |||
| 352 | (% style="width:1084.29px" %) | ||
| 353 | |**Name**|**Type**|(% style="width:644px" %)**Documentation** | ||
| 354 | |processConstraints (default: false)|xs:boolean|(% style="width:644px" %)The processConstraints [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to request that the query process any relevant (% style="color:#e74c3c" %)constraints(%%) for the match object(s) in order to return only the applicable portion of any referenced [[codelists>>doc:sdmx:Glossary.Code list.WebHome]]. A value of "true" indicates that (% style="color:#e74c3c" %)constraints(%%) should be processed. | ||
| 355 | |detail (default: Full)|MaintainableReturnDetailType|(% style="width:644px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Annotation.WebHome]] 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. | ||
| 356 | |||
| 357 | Element Documentation: | ||
| 358 | |||
| 359 | (% style="width:1081.29px" %) | ||
| 360 | |**Name**|**Type**|(% style="width:641px" %)**Documentation** | ||
| 361 | |None|com:EmptyType|(% style="width:641px" %)None indicates that no reference objects should be returned. | ||
| 362 | |All|com:EmptyType|(% style="width:641px" %)All is a convenience to indicate that the sets indicated by the ParentsAndSiblings and Descendants should be returned. | ||
| 363 | |Parents|com:EmptyType|(% style="width:641px" %)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. | ||
| 364 | |ParentsAndSiblings|com:EmptyType|(% style="width:641px" %)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. | ||
| 365 | |Children|com:EmptyType|(% style="width:641px" %)Children is a convenience to indicate that all object referred to by the matched object should be returned. | ||
| 366 | |Descendants|com:EmptyType|(% style="width:641px" %)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. | ||
| 367 | |SpecificObjects|com: MaintainableObjectTypeListType|(% style="width:641px" %)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. | ||
| 368 | |||
| 369 | **//AnnotableWhereType//: **AnnotableWhereType is an abstract base type for querying an annotable [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. | ||
| 370 | |||
| 371 | Content: | ||
| 372 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]? | ||
| 373 | |||
| 374 | Element Documentation: | ||
| 375 | |||
| 376 | (% style="width:989.294px" %) | ||
| 377 | |**Name**|**Type**|(% style="width:570px" %)**Documentation** | ||
| 378 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:570px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 379 | |||
| 380 | **AnnotationWhereType: **AnnotationWhereType defines the structure for querying the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 381 | |||
| 382 | Content: | ||
| 383 | Type?, [[Title>>doc:sdmx:Glossary.Title.WebHome]]?, Text? | ||
| 384 | |||
| 385 | Element Documentation: | ||
| 386 | |||
| 387 | (% style="width:982.294px" %) | ||
| 388 | |(% style="width:106px" %)**Name**|(% style="width:240px" %)**Type**|(% style="width:634px" %)**Documentation** | ||
| 389 | |(% style="width:106px" %)Type|(% style="width:240px" %)QueryStringType|(% style="width:634px" %)Type is a parameter for matching the type field of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 390 | |(% style="width:106px" %)[[Title>>doc:sdmx:Glossary.Title.WebHome]]|(% style="width:240px" %)QueryStringType|(% style="width:634px" %)[[Title>>doc:sdmx:Glossary.Title.WebHome]] is a parameter for matching the [[title>>doc:sdmx:Glossary.Title.WebHome]] field of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 391 | |(% style="width:106px" %)Text|(% style="width:240px" %)QueryTextType|(% style="width:634px" %)Text is a parameter for matching the text field of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 392 | |||
| 393 | **//IdentifiableWhereType//: **IdentifiableWhereType is an abstract base type that serves as the basis for any query for an identifiable object. | ||
| 394 | |||
| 395 | Derivation: | ||
| 396 | |||
| 397 | * //AnnotableWhereType// (extension) | ||
| 398 | ** //IdentifiableWhereType// | ||
| 399 | |||
| 400 | Content: | ||
| 401 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID? | ||
| 402 | |||
| 403 | Element Documentation: | ||
| 404 | |||
| 405 | (% style="width:1053.29px" %) | ||
| 406 | |**Name**|(% style="width:188px" %)**Type**|(% style="width:716px" %)**Documentation** | ||
| 407 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|(% style="width:188px" %)AnnotationWhereType|(% style="width:716px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 408 | |URN|(% style="width:188px" %)xs:anyURI|(% style="width:716px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 409 | |ID|(% style="width:188px" %)QueryIDType|(% style="width:716px" %)ID is used to match the id of the identified object. | ||
| 410 | |||
| 411 | **//NameableWhereType//: **NameableWhereType is an abstract base type that serves as the basis for any query for a nameable object. | ||
| 412 | |||
| 413 | Derivation: | ||
| 414 | |||
| 415 | * //AnnotableWhereType// (extension) | ||
| 416 | ** //IdentifiableWhereType// (extension) | ||
| 417 | *** //NameableWhereType// | ||
| 418 | |||
| 419 | Content: | ||
| 420 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description? | ||
| 421 | |||
| 422 | Element Documentation: | ||
| 423 | |||
| 424 | (% style="width:1046.29px" %) | ||
| 425 | |**Name**|**Type**|(% style="width:770px" %)**Documentation** | ||
| 426 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:770px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 427 | |URN|xs:anyURI|(% style="width:770px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 428 | |ID|QueryIDType|(% style="width:770px" %)ID is used to match the id of the identified object. | ||
| 429 | |Name|QueryTextType|(% style="width:770px" %)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. | ||
| 430 | |Description|QueryTextType|(% style="width:770px" %)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. | ||
| 431 | |||
| 432 | **//VersionableWhereType//: **VersionableQueryType is an abstract base type that serves as the basis for any query for a versionable object. | ||
| 433 | |||
| 434 | Derivation: | ||
| 435 | |||
| 436 | * //AnnotableWhereType// (extension) | ||
| 437 | ** //IdentifiableWhereType// (extension) | ||
| 438 | *** //NameableWhereType// (extension) | ||
| 439 | **** //VersionableWhereType// | ||
| 440 | |||
| 441 | Content: | ||
| 442 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive? | ||
| 443 | |||
| 444 | Element Documentation: | ||
| 445 | |||
| 446 | (% style="width:1059.29px" %) | ||
| 447 | |**Name**|**Type**|(% style="width:742px" %)**Documentation** | ||
| 448 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:742px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 449 | |URN|xs:anyURI|(% style="width:742px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 450 | |ID|QueryIDType|(% style="width:742px" %)ID is used to match the id of the identified object. | ||
| 451 | |Name|QueryTextType|(% style="width:742px" %)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. | ||
| 452 | |Description|QueryTextType|(% style="width:742px" %)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. | ||
| 453 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:742px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 454 | |VersionTo|com: TimeRangeValueType|(% style="width:742px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 455 | |VersionFrom|com: TimeRangeValueType|(% style="width:742px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 456 | |VersionActive|xs:boolean|(% style="width:742px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 457 | |||
| 458 | **//MaintainableWhereType//: **MaintainableQueryType is an abstract base type that serves as the basis for any query for a maintainable object. | ||
| 459 | |||
| 460 | Derivation: | ||
| 461 | |||
| 462 | * //AnnotableWhereType// (extension) | ||
| 463 | ** //IdentifiableWhereType// (extension) | ||
| 464 | *** //NameableWhereType// (extension) | ||
| 465 | **** //VersionableWhereType// (extension) | ||
| 466 | ***** //MaintainableWhereType// | ||
| 467 | |||
| 468 | Attributes: | ||
| 469 | type? | ||
| 470 | |||
| 471 | Content: | ||
| 472 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 473 | |||
| 474 | Attribute Documentation: | ||
| 475 | |||
| 476 | (% style="width:1049.29px" %) | ||
| 477 | |(% style="width:116px" %)**Name**|(% style="width:221px" %)**Type**|(% style="width:695px" %)**Documentation** | ||
| 478 | |(% style="width:116px" %)type|(% style="width:221px" %)com: MaintainableTypeCodelistType|(% style="width:695px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 479 | |||
| 480 | Element Documentation: | ||
| 481 | |||
| 482 | (% style="width:1054.29px" %) | ||
| 483 | |**Name**|**Type**|(% style="width:737px" %)**Documentation** | ||
| 484 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:737px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 485 | |URN|xs:anyURI|(% style="width:737px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 486 | |ID|QueryIDType|(% style="width:737px" %)ID is used to match the id of the identified object. | ||
| 487 | |Name|QueryTextType|(% style="width:737px" %)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. | ||
| 488 | |Description|QueryTextType|(% style="width:737px" %)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. | ||
| 489 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:737px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 490 | |VersionTo|com: TimeRangeValueType|(% style="width:737px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 491 | |VersionFrom|com: TimeRangeValueType|(% style="width:737px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 492 | |VersionActive|xs:boolean|(% style="width:737px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 493 | |AgencyID|QueryNestedIDType|(% style="width:737px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 494 | |||
| 495 | **//ItemSchemeWhereType//: **ItemSchemeQueryType is an abstract base type that serves as the basis for any query for an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. | ||
| 496 | |||
| 497 | Derivation: | ||
| 498 | |||
| 499 | * //AnnotableWhereType// (extension) | ||
| 500 | ** //IdentifiableWhereType// (extension) | ||
| 501 | *** //NameableWhereType// (extension) | ||
| 502 | **** //VersionableWhereType// (extension) | ||
| 503 | ***** //MaintainableWhereType// (extension) | ||
| 504 | ****** //ItemSchemeWhereType// | ||
| 505 | |||
| 506 | Attributes: | ||
| 507 | type? | ||
| 508 | |||
| 509 | Content: | ||
| 510 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, //ItemWhere*// | ||
| 511 | |||
| 512 | Attribute Documentation: | ||
| 513 | |||
| 514 | (% style="width:1011.29px" %) | ||
| 515 | |**Name**|**Type**|(% style="width:673px" %)**Documentation** | ||
| 516 | |type|com: MaintainableTypeCodelistType|(% style="width:673px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 517 | |||
| 518 | Element Documentation: | ||
| 519 | |||
| 520 | (% style="width:1010.29px" %) | ||
| 521 | |**Name**|**Type**|(% style="width:693px" %)**Documentation** | ||
| 522 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:693px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 523 | |URN|xs:anyURI|(% style="width:693px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 524 | |ID|QueryIDType|(% style="width:693px" %)ID is used to match the id of the identified object. | ||
| 525 | |Name|QueryTextType|(% style="width:693px" %)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. | ||
| 526 | |Description|QueryTextType|(% style="width:693px" %)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. | ||
| 527 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:693px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 528 | |VersionTo|com: TimeRangeValueType|(% style="width:693px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 529 | |VersionFrom|com: TimeRangeValueType|(% style="width:693px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 530 | |VersionActive|xs:boolean|(% style="width:693px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 531 | |AgencyID|QueryNestedIDType|(% style="width:693px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 532 | |//ItemWhere//|//ItemWhereType//|(% style="width:693px" %)ItemWhere is an abstract substitution head to query for an item within a parent item where or an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] 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>>doc:sdmx:Glossary.Hierarchy.WebHome]] provided. | ||
| 533 | |||
| 534 | **//ItemWhereType//: **ItemQueryType is an abstract base type that serves as the basis for a query for an item within an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] 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. | ||
| 535 | |||
| 536 | Derivation: | ||
| 537 | |||
| 538 | * //AnnotableWhereType// (extension) | ||
| 539 | ** //IdentifiableWhereType// (extension) | ||
| 540 | *** //NameableWhereType// (extension) | ||
| 541 | **** //ItemWhereType// | ||
| 542 | |||
| 543 | Content: | ||
| 544 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (Parent | //ItemWhere+//)? | ||
| 545 | |||
| 546 | Element Documentation: | ||
| 547 | |||
| 548 | (% style="width:1081.29px" %) | ||
| 549 | |**Name**|**Type**|(% style="width:764px" %)**Documentation** | ||
| 550 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:764px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 551 | |URN|xs:anyURI|(% style="width:764px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 552 | |ID|QueryIDType|(% style="width:764px" %)ID is used to match the id of the identified object. | ||
| 553 | |Name|QueryTextType|(% style="width:764px" %)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. | ||
| 554 | |Description|QueryTextType|(% style="width:764px" %)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. | ||
| 555 | |Parent|//com: LocalItemReferenceType//|(% style="width:764px" %)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>>doc:sdmx:Glossary.Hierarchy.WebHome]]. If child items are sought for an item that is contained in a nested [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] (e.g. a [[category>>doc:sdmx:Glossary.Category.WebHome]]) on can query directly for the parent [[category>>doc:sdmx:Glossary.Category.WebHome]] and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details. | ||
| 556 | |//ItemWhere//|//ItemWhereType//|(% style="width:764px" %)ItemWhere is an abstract substitution head to query for an item within a parent item where or an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] 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>>doc:sdmx:Glossary.Hierarchy.WebHome]] provided. | ||
| 557 | |||
| 558 | **//StructureWhereType//: **StructureWhereType is an abstract base type that serves as the basis for a query for a structure object. | ||
| 559 | |||
| 560 | Derivation: | ||
| 561 | |||
| 562 | * //AnnotableWhereType// (extension) | ||
| 563 | ** //IdentifiableWhereType// (extension) | ||
| 564 | *** //NameableWhereType// (extension) | ||
| 565 | **** //VersionableWhereType// (extension) | ||
| 566 | ***** //MaintainableWhereType// (extension) | ||
| 567 | ****** //StructureWhereType// | ||
| 568 | |||
| 569 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 570 | type? | ||
| 571 | |||
| 572 | Content: | ||
| 573 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, //ComponentListWhere*//, //ComponentWhere*// | ||
| 574 | |||
| 575 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 576 | |||
| 577 | (% style="width:1045.29px" %) | ||
| 578 | |**Name**|**Type**|(% style="width:707px" %)**Documentation** | ||
| 579 | |type|com: MaintainableTypeCodelistType|(% style="width:707px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 580 | |||
| 581 | Element Documentation: | ||
| 582 | |||
| 583 | (% style="width:1043.29px" %) | ||
| 584 | |**Name**|**Type**|(% style="width:615px" %)**Documentation** | ||
| 585 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:615px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 586 | |URN|xs:anyURI|(% style="width:615px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 587 | |ID|QueryIDType|(% style="width:615px" %)ID is used to match the id of the identified object. | ||
| 588 | |Name|QueryTextType|(% style="width:615px" %)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. | ||
| 589 | |Description|QueryTextType|(% style="width:615px" %)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. | ||
| 590 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:615px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 591 | |VersionTo|com: TimeRangeValueType|(% style="width:615px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 592 | |VersionFrom|com: TimeRangeValueType|(% style="width:615px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 593 | |VersionActive|xs:boolean|(% style="width:615px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 594 | |AgencyID|QueryNestedIDType|(% style="width:615px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 595 | |UsedConcept|com: ConceptReferenceType|(% style="width:615px" %)UsedConcept is used to query for a structure that uses the referenced (% style="color:#e74c3c" %)concept(%%) as the basis of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 596 | |UsedRepresentation|//com: ItemSchemeReferenceB aseType//|(% style="width:615px" %)UsedRepresentation is used to query for a structure that uses the referenced [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 597 | |//ComponentListWhere//|//ComponentListWhereType//|(% style="width:615px" %)ComponentListWhere is an abstract substitution head to query for a [[component>>doc:sdmx:Glossary.Component.WebHome]] list within a structure. A [[component>>doc:sdmx:Glossary.Component.WebHome]] list where query is implicitly an and-query - that is the conditions within the [[component>>doc:sdmx:Glossary.Component.WebHome]] list where must all be met in order to return a match. | ||
| 598 | |//ComponentWhere//|//ComponentWhereType//|(% style="width:615px" %)ComponentWhere is an abstract substitution head to query for a [[component>>doc:sdmx:Glossary.Component.WebHome]] within a [[component>>doc:sdmx:Glossary.Component.WebHome]] list or a structure. A [[component>>doc:sdmx:Glossary.Component.WebHome]] where query is implicitly an and-query - that is the conditions within the [[component>>doc:sdmx:Glossary.Component.WebHome]] where must all be met in order to return a match. | ||
| 599 | |||
| 600 | **//ComponentListWhereType//: **ComponentListWhereType is an abstract base type that serves as the basis for a query for a [[component>>doc:sdmx:Glossary.Component.WebHome]] list within a structure query. A list of [[component>>doc:sdmx:Glossary.Component.WebHome]] where children are provided to query for the list's child [[components>>doc:sdmx:Glossary.Component.WebHome]]. The conditions within a [[component>>doc:sdmx:Glossary.Component.WebHome]] list query are implied to be in an and-query. If an id and a child [[component>>doc:sdmx:Glossary.Component.WebHome]] where condition are supplied, then both conditions will have to met in order for the [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 601 | |||
| 602 | Derivation: | ||
| 603 | |||
| 604 | * //AnnotableWhereType// (extension) | ||
| 605 | ** //IdentifiableWhereType// (extension) | ||
| 606 | *** //ComponentListWhereType// | ||
| 607 | |||
| 608 | Content: | ||
| 609 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, //ComponentWhere*// | ||
| 610 | |||
| 611 | Element Documentation: | ||
| 612 | |||
| 613 | (% style="width:1034.29px" %) | ||
| 614 | |**Name**|**Type**|(% style="width:703px" %)**Documentation** | ||
| 615 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:703px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 616 | |URN|xs:anyURI|(% style="width:703px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 617 | |ID|QueryIDType|(% style="width:703px" %)ID is used to match the id of the identified object. | ||
| 618 | |//ComponentWhere//|//ComponentWhereType//|(% style="width:703px" %)ComponentWhere is an abstract substitution head to query for a [[component>>doc:sdmx:Glossary.Component.WebHome]] within a [[component>>doc:sdmx:Glossary.Component.WebHome]] list or a structure. A [[component>>doc:sdmx:Glossary.Component.WebHome]] where query is implicitly an and-query - that is the conditions within the [[component>>doc:sdmx:Glossary.Component.WebHome]] where must all be met in order to return a match. | ||
| 619 | |||
| 620 | **//ComponentWhereType//: **ComponentWhereType is an abstract base type that serves as the basis for a query for a [[component>>doc:sdmx:Glossary.Component.WebHome]] within a [[component>>doc:sdmx:Glossary.Component.WebHome]] list where or a structure query. A (% style="color:#e74c3c" %)concept(%%) identity and a local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] condition are available to seek a [[component>>doc:sdmx:Glossary.Component.WebHome]] that utilizes a particular (% style="color:#e74c3c" %)concept(%%) or [[representation>>doc:sdmx:Glossary.Representation.WebHome]] scheme. The conditions within a [[component>>doc:sdmx:Glossary.Component.WebHome]] query are implied to be in an and-query. If an id and a (% style="color:#e74c3c" %)concept(%%) identity condition are supplied, then both conditions will have to met in order for the [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 621 | |||
| 622 | Derivation: | ||
| 623 | |||
| 624 | * //AnnotableWhereType// (extension) | ||
| 625 | ** //IdentifiableWhereType// (extension) | ||
| 626 | *** //ComponentWhereType// | ||
| 627 | |||
| 628 | Content: | ||
| 629 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, ConceptIdentity?, Enumeration? | ||
| 630 | |||
| 631 | Element Documentation: | ||
| 632 | |||
| 633 | (% style="width:1032.29px" %) | ||
| 634 | |**Name**|**Type**|(% style="width:623px" %)**Documentation** | ||
| 635 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:623px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 636 | |URN|xs:anyURI|(% style="width:623px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 637 | |ID|QueryIDType|(% style="width:623px" %)ID is used to match the id of the identified object. | ||
| 638 | |ConceptIdentity|com: ConceptReferenceType|(% style="width:623px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 639 | |Enumeration|//com: ItemSchemeReferenceBaseType//|(% style="width:623px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 640 | |||
| 641 | **//StructureUsageWhereType//: **StructureUsageWhereType is an abstract base type that serves as the basis for a query for a structure usage object. | ||
| 642 | |||
| 643 | Derivation: | ||
| 644 | |||
| 645 | * //AnnotableWhereType// (extension) | ||
| 646 | ** //IdentifiableWhereType// (extension) | ||
| 647 | *** //NameableWhereType// (extension) | ||
| 648 | **** //VersionableWhereType// (extension) | ||
| 649 | ***** //MaintainableWhereType// (extension) | ||
| 650 | ****** //StructureUsageWhereType// | ||
| 651 | |||
| 652 | Attributes: | ||
| 653 | type? | ||
| 654 | |||
| 655 | Content: | ||
| 656 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure? | ||
| 657 | |||
| 658 | Attribute Documentation: | ||
| 659 | |||
| 660 | (% style="width:1044.29px" %) | ||
| 661 | |(% style="width:110px" %)**Name**|(% style="width:227px" %)**Type**|(% style="width:706px" %)**Documentation** | ||
| 662 | |(% style="width:110px" %)type|(% style="width:227px" %)com: MaintainableTypeCodelistType|(% style="width:706px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 663 | |||
| 664 | Element Documentation: | ||
| 665 | |||
| 666 | (% style="width:1044.29px" %) | ||
| 667 | |**Name**|**Type**|(% style="width:679px" %)**Documentation** | ||
| 668 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:679px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 669 | |URN|xs:anyURI|(% style="width:679px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 670 | |ID|QueryIDType|(% style="width:679px" %)ID is used to match the id of the identified object. | ||
| 671 | |Name|QueryTextType|(% style="width:679px" %)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. | ||
| 672 | |Description|QueryTextType|(% style="width:679px" %)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. | ||
| 673 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:679px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 674 | |VersionTo|com: TimeRangeValueType|(% style="width:679px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 675 | |VersionFrom|com: TimeRangeValueType|(% style="width:679px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 676 | |VersionActive|xs:boolean|(% style="width:679px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 677 | |AgencyID|QueryNestedIDType|(% style="width:679px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 678 | |Structure|//com: StructureReferenceBaseType//|(% style="width:679px" %)Structure is used to match the structure referenced by a structure usage object. Only structure usages which reference the supplied structure will be returned. | ||
| 679 | |||
| 680 | **ConceptValueType: **ConceptValueType describes the structure of a query for the value of the underlying (% style="color:#e74c3c" %)concept(%%) of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. It provides a reference to a (% style="color:#e74c3c" %)concept(%%) in a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] via a URN and/or a complete set of reference fields, as well as a numeric, text, or un-typed value. | ||
| 681 | |||
| 682 | Content: | ||
| 683 | (% style="color:#e74c3c" %)Concept(%%), (NumericValue[1..2] | TextValue+ | TimeValue[1..2] | Value) | ||
| 684 | |||
| 685 | Element Documentation: | ||
| 686 | |||
| 687 | (% style="width:1016.29px" %) | ||
| 688 | |**Name**|**Type**|(% style="width:688px" %)**Documentation** | ||
| 689 | |(%%)(% style="color:#e74c3c" %)Concept|com: ConceptReferenceType|(% style="width:688px" %) | ||
| 690 | |NumericValue|NumericValueType|(% style="width:688px" %)NumericValue is used to query for a the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 691 | |TextValue|QueryTextType|(% style="width:688px" %)TextValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]]. If only a simple equality check is necessary, regardless of language, the Value element can be used. | ||
| 692 | |TimeValue|TimePeriodValueType|(% style="width:688px" %)TimeValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 693 | |Value|SimpleValueType|(% style="width:688px" %)Value is used to query for the value of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. This should be used for (% style="color:#e74c3c" %)concepts(%%) or [[components>>doc:sdmx:Glossary.Component.WebHome]] based on a simple value (e.g. a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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. | ||
| 694 | |||
| 695 | **CodeValueType: **CodeValueType is used to query for data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] where a [[component>>doc:sdmx:Glossary.Component.WebHome]] which uses the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] 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>>doc:sdmx:Glossary.Code list.WebHome]] which is specified as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] or an identifiable object target in a metadata target. | ||
| 696 | |||
| 697 | Attributes: | ||
| 698 | value | ||
| 699 | |||
| 700 | Content: | ||
| 701 | [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] | ||
| 702 | |||
| 703 | Attribute Documentation: | ||
| 704 | |||
| 705 | (% style="width:1011.29px" %) | ||
| 706 | |**Name**|**Type**|(% style="width:565px" %)**Documentation** | ||
| 707 | |value|xs:string|(% style="width:565px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the coded value that is to be queried for. | ||
| 708 | |||
| 709 | Element Documentation: | ||
| 710 | |||
| 711 | (% style="width:1011.29px" %) | ||
| 712 | |**Name**|(% style="width:253px" %)**Type**|(% style="width:570px" %)**Documentation** | ||
| 713 | |[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|(% style="width:253px" %)com: CodelistReferenceType|(% style="width:570px" %)[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] references the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] for which the coded value is being sought. | ||
| 714 | |||
| 715 | **SimpleValueType: **SimpleValueType describes the structure of a simple value query. A value is provided as the content in string format. | ||
| 716 | |||
| 717 | Derivation: | ||
| 718 | |||
| 719 | * xs:anySimpleType (restriction) | ||
| 720 | ** xs:string (extension) | ||
| 721 | *** SimpleValueType | ||
| 722 | |||
| 723 | Attributes: | ||
| 724 | operator? | ||
| 725 | |||
| 726 | Content: | ||
| 727 | Attribute Documentation: | ||
| 728 | |||
| 729 | (% style="width:1067.29px" %) | ||
| 730 | |(% style="width:200px" %)**Name**|(% style="width:214px" %)**Type**|(% style="width:649px" %)**Documentation** | ||
| 731 | |(% style="width:200px" %)operator (default: equal)|(% style="width:214px" %)com: SimpleOperatorType|(% style="width:649px" %)The operator [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the operator to apply to the string value query. The options are equal and notEqual. | ||
| 732 | |||
| 733 | **NumericValueType: **NumericValueType describes the structure of a numeric query. A value is provided as the content in [[decimal>>doc:sdmx:Glossary.Decimals.WebHome]] format. | ||
| 734 | |||
| 735 | Derivation: | ||
| 736 | |||
| 737 | * xs:anySimpleType (restriction) | ||
| 738 | ** xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]] (extension) | ||
| 739 | *** NumericValueType | ||
| 740 | |||
| 741 | Attributes: | ||
| 742 | operator? | ||
| 743 | |||
| 744 | Content: | ||
| 745 | Attribute Documentation: | ||
| 746 | |||
| 747 | (% style="width:1059.29px" %) | ||
| 748 | |(% style="width:197px" %)**Name**|(% style="width:348px" %)**Type**|(% style="width:512px" %)**Documentation** | ||
| 749 | |(% style="width:197px" %)operator (default: equal)|(% style="width:348px" %)com: OrderedOperatorType|(% style="width:512px" %)The operator [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the operator to apply to the numeric value query, such as equal to or greater than. | ||
| 750 | |||
| 751 | **QueryStringType: **QueryStringType defines the structure of a string query. | ||
| 752 | |||
| 753 | Derivation: | ||
| 754 | |||
| 755 | * xs:anySimpleType (restriction) | ||
| 756 | ** xs:string (extension) | ||
| 757 | *** QueryStringType | ||
| 758 | |||
| 759 | Attributes: | ||
| 760 | operator? | ||
| 761 | |||
| 762 | Content: | ||
| 763 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 764 | |||
| 765 | (% style="width:1072.29px" %) | ||
| 766 | |**Name**|**Type**|(% style="width:722px" %)**Documentation** | ||
| 767 | |operator (default: equal)|com:TextOperatorType|(% style="width:722px" %)The operator [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 768 | |||
| 769 | **QueryIDType: **QueryIDType defines the structure of a query for an identifier. | ||
| 770 | |||
| 771 | Derivation: | ||
| 772 | |||
| 773 | * xs:anySimpleType (restriction) | ||
| 774 | ** xs:string (restriction) | ||
| 775 | *** com:NestedIDType (restriction) | ||
| 776 | **** com:IDType (extension) | ||
| 777 | ***** QueryIDType | ||
| 778 | |||
| 779 | Attributes: | ||
| 780 | operator? | ||
| 781 | |||
| 782 | Content: | ||
| 783 | Attribute Documentation: | ||
| 784 | |||
| 785 | (% style="width:1065.29px" %) | ||
| 786 | |**Name**|**Type**|(% style="width:715px" %)**Documentation** | ||
| 787 | |operator (default: equal)|com:TextOperatorType|(% style="width:715px" %)The operator [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 788 | |||
| 789 | **QueryNestedIDType: **QueryNestedIDType defines the structure of a query for a nested identifier. | ||
| 790 | |||
| 791 | Derivation: | ||
| 792 | |||
| 793 | * xs:anySimpleType (restriction) | ||
| 794 | ** xs:string (restriction) | ||
| 795 | *** com:NestedIDType (extension) | ||
| 796 | **** QueryNestedIDType | ||
| 797 | |||
| 798 | Attributes: | ||
| 799 | operator? | ||
| 800 | |||
| 801 | Content: | ||
| 802 | Attribute Documentation: | ||
| 803 | |||
| 804 | (% style="width:1091.29px" %) | ||
| 805 | |**Name**|**Type**|(% style="width:741px" %)**Documentation** | ||
| 806 | |operator (default: equal)|com:TextOperatorType|(% style="width:741px" %)The operator [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 807 | |||
| 808 | **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. | ||
| 809 | |||
| 810 | Derivation: | ||
| 811 | |||
| 812 | * xs:anySimpleType (restriction) | ||
| 813 | ** xs:string (extension) | ||
| 814 | *** com:TextType (extension) | ||
| 815 | **** QueryTextType | ||
| 816 | |||
| 817 | Attributes: | ||
| 818 | xml:lang?, operator? | ||
| 819 | |||
| 820 | Content: | ||
| 821 | Attribute Documentation: | ||
| 822 | |||
| 823 | (% style="width:1264.29px" %) | ||
| 824 | |**Name**|**Type**|(% style="width:914px" %)**Documentation** | ||
| 825 | |xml:lang (default: en)|xs:language|(% style="width:914px" %)The xml:lang [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies a language [[code>>doc:sdmx:Glossary.Code.WebHome]] for the text. If not supplied, the default language is assumed to be English. | ||
| 826 | |operator (default: equal)|com:TextOperatorType|(% style="width:914px" %)The operator [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 827 | |||
| 828 | **TimePeriodValueType: **TimePeriodValueType describes the structure of a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] query. A value is provided as the content in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[time period>>doc:sdmx:Glossary.Time period.WebHome]] format. | ||
| 829 | |||
| 830 | Derivation: | ||
| 831 | |||
| 832 | * xs:anySimpleType (restriction) | ||
| 833 | ** com:ObservationalTimePeriodType (extension) | ||
| 834 | *** TimePeriodValueType | ||
| 835 | |||
| 836 | Attributes: | ||
| 837 | operator?, reportingYearStartDay? | ||
| 838 | |||
| 839 | Content: | ||
| 840 | |||
| 841 | Attribute Documentation: | ||
| 842 | |||
| 843 | (% style="width:1171.29px" %) | ||
| 844 | |**Name**|**Type**|(% style="width:714px" %)**Documentation** | ||
| 845 | |operator (default: equal)|com:TimeOperatorType|(% style="width:714px" %)The operator [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the operator to apply to the value query, such as equal to or greater than. | ||
| 846 | |reportingYearStartDay (default: Any)|ReportingYearStartDayQueryType|(% style="width:714px" %)The reportingYearStartDay [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 847 | |||
| 848 | **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. | ||
| 849 | |||
| 850 | Derivation: | ||
| 851 | |||
| 852 | * //StructuralMetadataQueryType// (restriction) | ||
| 853 | ** CategorisationQueryType | ||
| 854 | |||
| 855 | Content: | ||
| 856 | ReturnDetails, CategorisationWhere | ||
| 857 | |||
| 858 | Element Documentation: | ||
| 859 | |||
| 860 | (% style="width:1067.29px" %) | ||
| 861 | |**Name**|**Type**|(% style="width:657px" %)**Documentation** | ||
| 862 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:657px" %) | ||
| 863 | |CategorisationWhere|CategorisationWhereType|(% style="width:657px" %)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>>doc:sdmx:Glossary.Category.WebHome]] the object is categorized against. | ||
| 864 | |||
| 865 | **//CategorisationWhereBaseType//: **CategorisationWhereBaseType is an abstract base type which forms the basis for the CategorisationWhereType. | ||
| 866 | |||
| 867 | Derivation: | ||
| 868 | |||
| 869 | * //AnnotableWhereType// (extension) | ||
| 870 | ** //IdentifiableWhereType// (extension) | ||
| 871 | *** //NameableWhereType// (extension) | ||
| 872 | **** //VersionableWhereType// (extension) | ||
| 873 | ***** //MaintainableWhereType// (restriction) | ||
| 874 | ****** //CategorisationWhereBaseType// | ||
| 875 | |||
| 876 | Attributes: | ||
| 877 | type? | ||
| 878 | |||
| 879 | Content: | ||
| 880 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 881 | |||
| 882 | Attribute Documentation: | ||
| 883 | |||
| 884 | (% style="width:1100.29px" %) | ||
| 885 | |(% style="width:151px" %)**Name**|(% style="width:319px" %)**Type**|(% style="width:627px" %)**Documentation** | ||
| 886 | |(% style="width:151px" %)type (fixed: Categorisation)|(% style="width:319px" %)com: MaintainableTypeCodelistType|(% style="width:627px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 887 | |||
| 888 | Element Documentation: | ||
| 889 | |||
| 890 | (% style="width:1105.29px" %) | ||
| 891 | |**Name**|**Type**|(% style="width:788px" %)**Documentation** | ||
| 892 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:788px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 893 | |URN|xs:anyURI|(% style="width:788px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 894 | |ID|QueryIDType|(% style="width:788px" %)ID is used to match the id of the identified object. | ||
| 895 | |Name|QueryTextType|(% style="width:788px" %)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. | ||
| 896 | |Description|QueryTextType|(% style="width:788px" %)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. | ||
| 897 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:788px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 898 | |VersionTo|com: TimeRangeValueType|(% style="width:788px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 899 | |VersionFrom|com: TimeRangeValueType|(% style="width:788px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 900 | |VersionActive|xs:boolean|(% style="width:788px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 901 | |AgencyID|QueryNestedIDType|(% style="width:788px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 902 | |||
| 903 | **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. | ||
| 904 | |||
| 905 | Derivation: | ||
| 906 | |||
| 907 | * //AnnotableWhereType// (extension) | ||
| 908 | ** //IdentifiableWhereType// (extension) | ||
| 909 | *** //NameableWhereType// (extension) | ||
| 910 | **** //VersionableWhereType// (extension) | ||
| 911 | ***** //MaintainableWhereType// (restriction) | ||
| 912 | ****** //CategorisationWhereBaseType// (extension) | ||
| 913 | ******* CategorisationWhereType | ||
| 914 | |||
| 915 | Attributes: | ||
| 916 | type? | ||
| 917 | |||
| 918 | Content: | ||
| 919 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CategoryScheme?, TargetCategory?, ObjectReference?, CategorisedObjectType* | ||
| 920 | |||
| 921 | Attribute Documentation: | ||
| 922 | |||
| 923 | (% style="width:1046.29px" %) | ||
| 924 | |**Name**|**Type**|(% style="width:572px" %)**Documentation** | ||
| 925 | |type (fixed: Categorisation)|com: MaintainableTypeCodelistType|(% style="width:572px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 926 | |||
| 927 | Element Documentation: | ||
| 928 | |||
| 929 | (% style="width:1047.29px" %) | ||
| 930 | |**Name**|**Type**|(% style="width:590px" %)**Documentation** | ||
| 931 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:590px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 932 | |URN|xs:anyURI|(% style="width:590px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 933 | |ID|QueryIDType|(% style="width:590px" %)ID is used to match the id of the identified object. | ||
| 934 | |Name|QueryTextType|(% style="width:590px" %)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. | ||
| 935 | |Description|QueryTextType|(% style="width:590px" %)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. | ||
| 936 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:590px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 937 | |VersionTo|com: TimeRangeValueType|(% style="width:590px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 938 | |VersionFrom|com: TimeRangeValueType|(% style="width:590px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 939 | |VersionActive|xs:boolean|(% style="width:590px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 940 | |AgencyID|QueryNestedIDType|(% style="width:590px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 941 | |CategoryScheme|com: CategorySchemeReferenceType|(% style="width:590px" %)CategoryScheme references a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] for which categorisations or sought for any of the scheme's [[categories>>doc:sdmx:Glossary.Category.WebHome]]. Any categorisation which has a target of a [[category>>doc:sdmx:Glossary.Category.WebHome]] defined in the scheme will be returned. | ||
| 942 | |TargetCategory|com: CategoryReferenceType|(% style="width:590px" %)TargetCategory references the [[category>>doc:sdmx:Glossary.Category.WebHome]] that defines the target of the categorisation (the [[category>>doc:sdmx:Glossary.Category.WebHome]] which an object is categorized against). Only categorisations which refence the [[category>>doc:sdmx:Glossary.Category.WebHome]] supplied here will be returned. | ||
| 943 | |ObjectReference|com: ObjectReferenceType|(% style="width:590px" %)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. | ||
| 944 | |CategorisedObjectType|com: ObjectTypeCodelistType|(% style="width:590px" %)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>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 945 | |||
| 946 | **CategorySchemeQueryType: **CategorySchemeQueryType defines the structure of a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] 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>>doc:sdmx:Glossary.Category scheme.WebHome]] should be returned. | ||
| 947 | |||
| 948 | Derivation: | ||
| 949 | |||
| 950 | * //StructuralMetadataQueryType// (restriction) | ||
| 951 | ** CategorySchemeQueryType | ||
| 952 | |||
| 953 | Content: | ||
| 954 | ReturnDetails, CategorySchemeWhere | ||
| 955 | |||
| 956 | Element Documentation: | ||
| 957 | |||
| 958 | (% style="width:1065.29px" %) | ||
| 959 | |**Name**|**Type**|(% style="width:652px" %)**Documentation** | ||
| 960 | |ReturnDetails|StructureReturnDetailsType|(% style="width:652px" %) | ||
| 961 | |CategorySchemeWhere|CategorySchemeWhereType|(% style="width:652px" %)CategorySchemeWhere contains the parameters for a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] 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>>doc:sdmx:Glossary.Category scheme.WebHome]] based on the details of its [[categories>>doc:sdmx:Glossary.Category.WebHome]]. In any case, the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] will be returned according the indicated return detail. | ||
| 962 | |||
| 963 | **CategorySchemeWhereType: **CategorySchemeWhereType defines the parameters of a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 964 | |||
| 965 | Derivation: | ||
| 966 | |||
| 967 | * //AnnotableWhereType// (extension) | ||
| 968 | ** //IdentifiableWhereType// (extension) | ||
| 969 | *** //NameableWhereType// (extension) | ||
| 970 | **** //VersionableWhereType// (extension) | ||
| 971 | ***** //MaintainableWhereType// (extension) | ||
| 972 | ****** //ItemSchemeWhereType// (restriction) | ||
| 973 | ******* CategorySchemeWhereType | ||
| 974 | |||
| 975 | Attributes: | ||
| 976 | type? | ||
| 977 | |||
| 978 | Content: | ||
| 979 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CategoryWhere* | ||
| 980 | |||
| 981 | Attribute Documentation: | ||
| 982 | |||
| 983 | (% style="width:1077.29px" %) | ||
| 984 | |(% style="width:151px" %)**Name**|(% style="width:280px" %)**Type**|(% style="width:644px" %)**Documentation** | ||
| 985 | |(% style="width:151px" %)type (fixed: CategoryScheme)|(% style="width:280px" %)com: MaintainableTypeCodelistType|(% style="width:644px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 986 | |||
| 987 | Element Documentation: | ||
| 988 | |||
| 989 | (% style="width:1045.29px" %) | ||
| 990 | |**Name**|**Type**|(% style="width:713px" %)**Documentation** | ||
| 991 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:713px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 992 | |URN|xs:anyURI|(% style="width:713px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 993 | |ID|QueryIDType|(% style="width:713px" %)ID is used to match the id of the identified object. | ||
| 994 | |Name|QueryTextType|(% style="width:713px" %)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. | ||
| 995 | |Description|QueryTextType|(% style="width:713px" %)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. | ||
| 996 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:713px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 997 | |VersionTo|com: TimeRangeValueType|(% style="width:713px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 998 | |VersionFrom|com: TimeRangeValueType|(% style="width:713px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 999 | |VersionActive|xs:boolean|(% style="width:713px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1000 | |AgencyID|QueryNestedIDType|(% style="width:713px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1001 | |CategoryWhere|CategoryWhereType|(% style="width:713px" %)CategoryWhere is used to query for [[categories>>doc:sdmx:Glossary.Category.WebHome]] matching the parameters supplied. It allows for nested [[category>>doc:sdmx:Glossary.Category.WebHome]] queries so that hierarchical [[categories>>doc:sdmx:Glossary.Category.WebHome]] can be queried explicitly by their nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) [[category>>doc:sdmx:Glossary.Category.WebHome]] will always result in a search for [[categories>>doc:sdmx:Glossary.Category.WebHome]] at any (% style="color:#e74c3c" %)level(%%). This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match. | ||
| 1002 | |||
| 1003 | **CategoryWhereType: **CategoryQueryWhereType contains a set of parameters for matching a [[category>>doc:sdmx:Glossary.Category.WebHome]]. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 1004 | |||
| 1005 | Derivation: | ||
| 1006 | |||
| 1007 | * //AnnotableWhereType// (extension) | ||
| 1008 | ** //IdentifiableWhereType// (extension) | ||
| 1009 | *** //NameableWhereType// (extension) | ||
| 1010 | **** //ItemWhereType// (restriction) | ||
| 1011 | ***** CategoryWhereType | ||
| 1012 | |||
| 1013 | Content: | ||
| 1014 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, CategoryWhere* | ||
| 1015 | |||
| 1016 | Element Documentation: | ||
| 1017 | |||
| 1018 | (% style="width:1068.29px" %) | ||
| 1019 | |**Name**|**Type**|(% style="width:760px" %)**Documentation** | ||
| 1020 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:760px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1021 | |ID|QueryIDType|(% style="width:760px" %)ID is used to match the id of the identified object. | ||
| 1022 | |Name|QueryTextType|(% style="width:760px" %)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. | ||
| 1023 | |Description|QueryTextType|(% style="width:760px" %)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. | ||
| 1024 | |CategoryWhere|CategoryWhereType|(% style="width:760px" %)CategoryWhere is used to query for [[categories>>doc:sdmx:Glossary.Category.WebHome]] matching the parameters supplied. It allows for nested [[category>>doc:sdmx:Glossary.Category.WebHome]] queries so that hierarchical [[categories>>doc:sdmx:Glossary.Category.WebHome]] can be queried explicitly by their nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) [[category>>doc:sdmx:Glossary.Category.WebHome]] will always result in a search for [[categories>>doc:sdmx:Glossary.Category.WebHome]] at any (% style="color:#e74c3c" %)level(%%). This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match. | ||
| 1025 | |||
| 1026 | **CodelistQueryType: **CodelistQueryType defines the structure of a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Code list.WebHome]] should be returned. | ||
| 1027 | |||
| 1028 | Derivation: | ||
| 1029 | |||
| 1030 | * //StructuralMetadataQueryType// (restriction) | ||
| 1031 | ** CodelistQueryType | ||
| 1032 | |||
| 1033 | Content: | ||
| 1034 | ReturnDetails, CodelistWhere | ||
| 1035 | |||
| 1036 | Element Documentation: | ||
| 1037 | |||
| 1038 | (% style="width:1065.29px" %) | ||
| 1039 | |**Name**|**Type**|(% style="width:726px" %)**Documentation** | ||
| 1040 | |ReturnDetails|StructureReturnDetailsType|(% style="width:726px" %) | ||
| 1041 | |CodelistWhere|CodelistWhereType|(% style="width:726px" %)CodelistWhere defines the parameters for a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]]. In any case, the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] will be returned according the indicated return detail. | ||
| 1042 | |||
| 1043 | **CodelistWhereType: **CodelistWhereType contains the parameters of a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 1044 | |||
| 1045 | Derivation: | ||
| 1046 | |||
| 1047 | * //AnnotableWhereType// (extension) | ||
| 1048 | ** //IdentifiableWhereType// (extension) | ||
| 1049 | *** //NameableWhereType// (extension) | ||
| 1050 | **** //VersionableWhereType// (extension) | ||
| 1051 | ***** //MaintainableWhereType// (extension) | ||
| 1052 | ****** //ItemSchemeWhereType// (restriction) | ||
| 1053 | ******* CodelistWhereType | ||
| 1054 | |||
| 1055 | Attributes: | ||
| 1056 | type? | ||
| 1057 | |||
| 1058 | Content: | ||
| 1059 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CodeWhere* | ||
| 1060 | |||
| 1061 | Attribute Documentation: | ||
| 1062 | |||
| 1063 | (% style="width:1024.29px" %) | ||
| 1064 | |**Name**|(% style="width:235px" %)**Type**|(% style="width:627px" %)**Documentation** | ||
| 1065 | |type (fixed: [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]])|(% style="width:235px" %)com: MaintainableTypeCodelistType|(% style="width:627px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 | (% style="width:1054.29px" %) | ||
| 1070 | |**Name**|**Type**|(% style="width:737px" %)**Documentation** | ||
| 1071 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:737px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1072 | |URN|xs:anyURI|(% style="width:737px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 1073 | |ID|QueryIDType|(% style="width:737px" %)ID is used to match the id of the identified object. | ||
| 1074 | |Name|QueryTextType|(% style="width:737px" %)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. | ||
| 1075 | |Description|QueryTextType|(% style="width:737px" %)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. | ||
| 1076 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:737px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 1077 | |VersionTo|com: TimeRangeValueType|(% style="width:737px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1078 | |VersionFrom|com: TimeRangeValueType|(% style="width:737px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1079 | |VersionActive|xs:boolean|(% style="width:737px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1080 | |AgencyID|QueryNestedIDType|(% style="width:737px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1081 | |CodeWhere|CodeWhereType|(% style="width:737px" %)CodeWhere is used to query for [[codes>>doc:sdmx:Glossary.Code.WebHome]] 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. | ||
| 1082 | |||
| 1083 | **CodeWhereType: **CodeWhereType defines a set of parameters for matching a [[code>>doc:sdmx:Glossary.Code.WebHome]]. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 1084 | |||
| 1085 | Derivation: | ||
| 1086 | |||
| 1087 | * //AnnotableWhereType// (extension) | ||
| 1088 | ** //IdentifiableWhereType// (extension) | ||
| 1089 | *** //NameableWhereType// (extension) | ||
| 1090 | **** //ItemWhereType// (restriction) | ||
| 1091 | ***** CodeWhereType | ||
| 1092 | |||
| 1093 | Content: | ||
| 1094 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, Parent? | ||
| 1095 | |||
| 1096 | Element Documentation: | ||
| 1097 | |||
| 1098 | (% style="width:1060.29px" %) | ||
| 1099 | |**Name**|**Type**|(% style="width:736px" %)**Documentation** | ||
| 1100 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:736px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1101 | |ID|QueryIDType|(% style="width:736px" %)ID is used to match the id of the identified object. | ||
| 1102 | |Name|QueryTextType|(% style="width:736px" %)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. | ||
| 1103 | |Description|QueryTextType|(% style="width:736px" %)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. | ||
| 1104 | |Parent|com: LocalCodeReferenceType|(% style="width:736px" %)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>>doc:sdmx:Glossary.Hierarchy.WebHome]]. If child items are sought for an item that is contained in a nested [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] (e.g. a [[category>>doc:sdmx:Glossary.Category.WebHome]]) on can query directly for the parent [[category>>doc:sdmx:Glossary.Category.WebHome]] and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details. | ||
| 1105 | |||
| 1106 | **ConceptSchemeQueryType: **ConceptSchemeQueryType defines the structure of a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] 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>>doc:sdmx:Glossary.Concept scheme.WebHome]] should be returned. | ||
| 1107 | |||
| 1108 | Derivation: | ||
| 1109 | |||
| 1110 | * //StructuralMetadataQueryType// (restriction) | ||
| 1111 | ** ConceptSchemeQueryType | ||
| 1112 | |||
| 1113 | Content: | ||
| 1114 | ReturnDetails, ConceptSchemeWhere | ||
| 1115 | |||
| 1116 | Element Documentation: | ||
| 1117 | |||
| 1118 | (% style="width:1054.29px" %) | ||
| 1119 | |**Name**|**Type**|(% style="width:651px" %)**Documentation** | ||
| 1120 | |ReturnDetails|StructureReturnDetailsType|(% style="width:651px" %) | ||
| 1121 | |ConceptSchemeWhere|ConceptSchemeWhereType|(% style="width:651px" %)ConceptSchemeWhere defines the parameters for a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] 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>>doc:sdmx:Glossary.Concept scheme.WebHome]] based on the details of its (% style="color:#e74c3c" %)concepts(%%). In any case, the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] will be returned according the indicated return detail. | ||
| 1122 | |||
| 1123 | **ConceptSchemeWhereType: **ConceptSchemeWhereType contains the parameters of a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 1124 | |||
| 1125 | Derivation: | ||
| 1126 | |||
| 1127 | * //AnnotableWhereType// (extension) | ||
| 1128 | ** //IdentifiableWhereType// (extension) | ||
| 1129 | *** //NameableWhereType// (extension) | ||
| 1130 | **** //VersionableWhereType// (extension) | ||
| 1131 | ***** //MaintainableWhereType// (extension) | ||
| 1132 | ****** //ItemSchemeWhereType// (restriction) | ||
| 1133 | ******* ConceptSchemeWhereType | ||
| 1134 | |||
| 1135 | Attributes: | ||
| 1136 | type? | ||
| 1137 | |||
| 1138 | Content: | ||
| 1139 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ConceptWhere* | ||
| 1140 | |||
| 1141 | Attribute Documentation: | ||
| 1142 | |||
| 1143 | (% style="width:1081.29px" %) | ||
| 1144 | |**Name**|**Type**|(% style="width:593px" %)**Documentation** | ||
| 1145 | |type (fixed: ConceptScheme)|com: MaintainableTypeCodelistType|(% style="width:593px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 1146 | |||
| 1147 | Element Documentation: | ||
| 1148 | |||
| 1149 | (% style="width:1076.29px" %) | ||
| 1150 | |**Name**|**Type**|(% style="width:749px" %)**Documentation** | ||
| 1151 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:749px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1152 | |URN|xs:anyURI|(% style="width:749px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 1153 | |ID|QueryIDType|(% style="width:749px" %)ID is used to match the id of the identified object. | ||
| 1154 | |Name|QueryTextType|(% style="width:749px" %)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. | ||
| 1155 | |Description|QueryTextType|(% style="width:749px" %)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. | ||
| 1156 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:749px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 1157 | |VersionTo|com: TimeRangeValueType|(% style="width:749px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1158 | |VersionFrom|com: TimeRangeValueType|(% style="width:749px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1159 | |VersionActive|xs:boolean|(% style="width:749px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1160 | |AgencyID|QueryNestedIDType|(% style="width:749px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1161 | |ConceptWhere|ConceptWhereType|(% style="width:749px" %)ConceptWhere is used to query for (% style="color:#e74c3c" %)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. | ||
| 1162 | |||
| 1163 | **//ConceptWhereBaseType//: **ConceptWhereBaseType is an abstract base type that forms the basis for the ConceptWhereType. | ||
| 1164 | |||
| 1165 | Derivation: | ||
| 1166 | |||
| 1167 | * //AnnotableWhereType// (extension) | ||
| 1168 | ** //IdentifiableWhereType// (extension) | ||
| 1169 | *** //NameableWhereType// (extension) | ||
| 1170 | **** //ItemWhereType// (restriction) | ||
| 1171 | ***** //ConceptWhereBaseType// | ||
| 1172 | |||
| 1173 | Content: | ||
| 1174 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, Parent? | ||
| 1175 | |||
| 1176 | Element Documentation: | ||
| 1177 | |||
| 1178 | (% style="width:1081.29px" %) | ||
| 1179 | |**Name**|**Type**|(% style="width:736px" %)**Documentation** | ||
| 1180 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:736px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1181 | |ID|QueryIDType|(% style="width:736px" %)ID is used to match the id of the identified object. | ||
| 1182 | |Name|QueryTextType|(% style="width:736px" %)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. | ||
| 1183 | |Description|QueryTextType|(% style="width:736px" %)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. | ||
| 1184 | |Parent|com: LocalConceptReferenceType|(% style="width:736px" %)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>>doc:sdmx:Glossary.Hierarchy.WebHome]]. If child items are sought for an item that is contained in a nested [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] (e.g. a [[category>>doc:sdmx:Glossary.Category.WebHome]]) on can query directly for the parent [[category>>doc:sdmx:Glossary.Category.WebHome]] and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details. | ||
| 1185 | |||
| 1186 | **ConceptWhereType: **ConceptWhereType defines a set of parameters for matching a (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)concept(%%) can be queried based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as a core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 1187 | |||
| 1188 | Derivation: | ||
| 1189 | |||
| 1190 | * //AnnotableWhereType// (extension) | ||
| 1191 | ** //IdentifiableWhereType// (extension) | ||
| 1192 | *** //NameableWhereType// (extension) | ||
| 1193 | **** //ItemWhereType// (restriction) | ||
| 1194 | ***** //ConceptWhereBaseType// (extension) | ||
| 1195 | ****** ConceptWhereType | ||
| 1196 | |||
| 1197 | Content: | ||
| 1198 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, Parent?, Enumeration? | ||
| 1199 | |||
| 1200 | Element Documentation: | ||
| 1201 | |||
| 1202 | (% style="width:1049.29px" %) | ||
| 1203 | |**Name**|**Type**|(% style="width:693px" %)**Documentation** | ||
| 1204 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:693px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1205 | |ID|QueryIDType|(% style="width:693px" %)ID is used to match the id of the identified object. | ||
| 1206 | |Name|QueryTextType|(% style="width:693px" %)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. | ||
| 1207 | |Description|QueryTextType|(% style="width:693px" %)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. | ||
| 1208 | |Parent|com: LocalConceptReferenceType|(% style="width:693px" %)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>>doc:sdmx:Glossary.Hierarchy.WebHome]]. If child items are sought for an item that is contained in a nested [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] (e.g. a [[category>>doc:sdmx:Glossary.Category.WebHome]]) on can query directly for the parent [[category>>doc:sdmx:Glossary.Category.WebHome]] and request that the child items be returned by specifying cascadeMatchedItems in the detail field of the return details. | ||
| 1209 | |Enumeration|com: CodelistReferenceType|(% style="width:693px" %)Enumeration is used to query for a (% style="color:#e74c3c" %)concept(%%) based on the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] that is used as the enumeration for its core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 1210 | |||
| 1211 | **ConstraintQueryType: **ConstraintQueryType defines the structure of a (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)constraint(%%) should be returned. | ||
| 1212 | |||
| 1213 | Derivation: | ||
| 1214 | |||
| 1215 | * //StructuralMetadataQueryType// (restriction) | ||
| 1216 | ** ConstraintQueryType | ||
| 1217 | |||
| 1218 | Content: | ||
| 1219 | ReturnDetails, ConstraintWhere | ||
| 1220 | |||
| 1221 | Element Documentation: | ||
| 1222 | |||
| 1223 | (% style="width:1042.29px" %) | ||
| 1224 | |**Name**|**Type**|(% style="width:662px" %)**Documentation** | ||
| 1225 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:662px" %) | ||
| 1226 | |ConstraintWhere|ConstraintWhereType|(% style="width:662px" %)AttachmentConstraintWhere contains the parameters for a (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)constraint(%%) based on the objects it applies to. | ||
| 1227 | |||
| 1228 | **//ConstraintWhereBaseType//: **ConstraintWhereBaseType is an abstract base type which forms the basis for the ConstraintWhereType. | ||
| 1229 | |||
| 1230 | Derivation: | ||
| 1231 | |||
| 1232 | * //AnnotableWhereType// (extension) | ||
| 1233 | ** //IdentifiableWhereType// (extension) | ||
| 1234 | *** //NameableWhereType// (extension) | ||
| 1235 | **** //VersionableWhereType// (extension) | ||
| 1236 | ***** //MaintainableWhereType// (restriction) | ||
| 1237 | ****** //ConstraintWhereBaseType// | ||
| 1238 | |||
| 1239 | Attributes: | ||
| 1240 | type? | ||
| 1241 | |||
| 1242 | Content: | ||
| 1243 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 1244 | |||
| 1245 | Attribute Documentation: | ||
| 1246 | |||
| 1247 | (% style="width:1075.29px" %) | ||
| 1248 | |**Name**|**Type**|(% style="width:533px" %)**Documentation** | ||
| 1249 | |type (default: (% style="color:#e74c3c" %)Constraint(%%))|ConstraintTypeCodelistType|(% style="width:533px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 1250 | |||
| 1251 | Element Documentation: | ||
| 1252 | |||
| 1253 | (% style="width:1074.29px" %) | ||
| 1254 | |**Name**|**Type**|(% style="width:757px" %)**Documentation** | ||
| 1255 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:757px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1256 | |URN|xs:anyURI|(% style="width:757px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 1257 | |ID|QueryIDType|(% style="width:757px" %)ID is used to match the id of the identified object. | ||
| 1258 | |Name|QueryTextType|(% style="width:757px" %)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. | ||
| 1259 | |Description|QueryTextType|(% style="width:757px" %)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. | ||
| 1260 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:757px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 1261 | |VersionTo|com: TimeRangeValueType|(% style="width:757px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1262 | |VersionFrom|com: TimeRangeValueType|(% style="width:757px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1263 | |VersionActive|xs:boolean|(% style="width:757px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1264 | |AgencyID|QueryNestedIDType|(% style="width:757px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1265 | |||
| 1266 | **ConstraintWhereType: **ConstraintWhereType contains the parameters of a (% style="color:#e74c3c" %)constraint(%%) query. All supplied parameters must be matched in order for an object to stratify the query. | ||
| 1267 | |||
| 1268 | Derivation: | ||
| 1269 | |||
| 1270 | * //AnnotableWhereType// (extension) | ||
| 1271 | ** //IdentifiableWhereType// (extension) | ||
| 1272 | *** //NameableWhereType// (extension) | ||
| 1273 | **** //VersionableWhereType// (extension) | ||
| 1274 | ***** //MaintainableWhereType// (restriction) | ||
| 1275 | ****** //ConstraintWhereBaseType// (extension) | ||
| 1276 | ******* ConstraintWhereType | ||
| 1277 | |||
| 1278 | Attributes: | ||
| 1279 | type?, allowable? | ||
| 1280 | |||
| 1281 | Content: | ||
| 1282 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ConstraintAttachmentWhere? | ||
| 1283 | |||
| 1284 | Attribute Documentation: | ||
| 1285 | |||
| 1286 | (% style="width:1160.29px" %) | ||
| 1287 | |**Name**|**Type**|(% style="width:796px" %)**Documentation** | ||
| 1288 | |type (default: (% style="color:#e74c3c" %)Constraint(%%))|ConstraintTypeCodelistType|(% style="width:796px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 1289 | |allowable|xs:boolean|(% style="width:796px" %)The allowable [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the returned search should be limited to only allowable (% style="color:#e74c3c" %)constraints(%%). This only applies to content (% style="color:#e74c3c" %)constraint(%%). If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a value of true, this indicates that only matching allowable content (% style="color:#e74c3c" %)constraints(%%) should be returned. If this is false, than only actual content (% style="color:#e74c3c" %)constraints(%%) returned. If no value is provided, all matching content (% style="color:#e74c3c" %)constraints(%%) will be returned, regardless of whether they are stating actual or allowable content. | ||
| 1290 | |||
| 1291 | Element Documentation: | ||
| 1292 | |||
| 1293 | (% style="width:1162.29px" %) | ||
| 1294 | |**Name**|**Type**|(% style="width:688px" %)**Documentation** | ||
| 1295 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:688px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1296 | |URN|xs:anyURI|(% style="width:688px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 1297 | |ID|QueryIDType|(% style="width:688px" %)ID is used to match the id of the identified object. | ||
| 1298 | |Name|QueryTextType|(% style="width:688px" %)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. | ||
| 1299 | |Description|QueryTextType|(% style="width:688px" %)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. | ||
| 1300 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:688px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 1301 | |VersionTo|com: TimeRangeValueType|(% style="width:688px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1302 | |VersionFrom|com: TimeRangeValueType|(% style="width:688px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1303 | |VersionActive|xs:boolean|(% style="width:688px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1304 | |AgencyID|QueryNestedIDType|(% style="width:688px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1305 | |ConstraintAttachmentWhere|ConstraintAttachmentWhereType|(% style="width:688px" %)ConstraintAttachmentWhere identifies a collection of objects to which a (% style="color:#e74c3c" %)constraint(%%) may be attached. This container is an implicit and-query, meaning all of the objects referenced in here must be part of the (% style="color:#e74c3c" %)constraint(%%) attachment in order for a (% style="color:#e74c3c" %)constraint(%%) to match. | ||
| 1306 | |||
| 1307 | **ConstraintAttachmentWhereType: **ConstraintAttachmentWhereType describes the structure for querying for a (% style="color:#e74c3c" %)constraint(%%) based on the objects it is attached to. A (% style="color:#e74c3c" %)constraint(%%) attachment query is implicitly an and-query meaning all of the referenced objects must be part of a (% style="color:#e74c3c" %)constraints(%%) attachment in order to return a match. It is treated as a condition within its parent query. | ||
| 1308 | |||
| 1309 | Content: | ||
| 1310 | (DataProvider | [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] | DataStructure | [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] | MetadataStructure | ProvisionAgreement | [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] | MetadataSet | DataSourceURL)+ | ||
| 1311 | |||
| 1312 | Element Documentation: | ||
| 1313 | |||
| 1314 | (% style="width:1174.29px" %) | ||
| 1315 | |**Name**|**Type**|(% style="width:706px" %)**Documentation** | ||
| 1316 | |DataProvider|com: DataProviderReferenceType|(% style="width:706px" %)DataProviderReference references a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) is attached. It is referenced via a URN and/or a full set of reference fields. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] referenced, a match will be returned. | ||
| 1317 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|com: DataflowReferenceType|(% style="width:706px" %)DataflowReference references a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) is attached. It is referenced via a URN and/or a full set of reference fields. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] referenced, a match will be returned. | ||
| 1318 | |DataStructure|com: DataStructureReferenceType|(% style="width:706px" %)DataStructureReference references a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) is attached. It is referenced via a URN and/or a full set of reference fields. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] referenced, a match will be returned. | ||
| 1319 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|com: MetadataflowReferenceType|(% style="width:706px" %)MetadataflowReference references a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) is attached. It is referenced via a URN and/or a full set of reference fields. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] referenced, a match will be returned. | ||
| 1320 | |MetadataStructure|com: MetadataStructureReferenceType|(% style="width:706px" %)MetadataStructureReference references a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) is attached. It is referenced via a URN and/or a full set of reference fields. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] referenced, a match will be returned. | ||
| 1321 | |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|(% style="width:706px" %)ProvisionAgreementReference references a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) is attached. It is referenced via a URN and/or a full set of reference fields. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] referenced, a match will be returned. | ||
| 1322 | |[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|com:SetReferenceType|(% style="width:706px" %)DataSetReference references a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) is attached. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] referenced, a match will be returned. | ||
| 1323 | |MetadataSet|com:SetReferenceType|(% style="width:706px" %)MetadataSetReference references a [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] set to which a (% style="color:#e74c3c" %)constraint(%%) is attached. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] referenced, a match will be returned. | ||
| 1324 | |DataSourceURL|xs:anyURI|(% style="width:706px" %)DataSourceURL references a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which a (% style="color:#e74c3c" %)constraint(%%) it attached. The [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is referenced by its data URL. If a (% style="color:#e74c3c" %)constraint(%%) is attached to the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] described (by matching the data URL), a match will be returned. | ||
| 1325 | |||
| 1326 | **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. | ||
| 1327 | |||
| 1328 | Content: | ||
| 1329 | ReturnDetails, DataWhere | ||
| 1330 | |||
| 1331 | Element Documentation: | ||
| 1332 | |||
| 1333 | (% style="width:1178.29px" %) | ||
| 1334 | |**Name**|**Type**|(% style="width:796px" %)**Documentation** | ||
| 1335 | |ReturnDetails|DataReturnDetailsTyp e|(% style="width:796px" %)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. | ||
| 1336 | |DataWhere|DataParametersAndType|(% style="width:796px" %)DataWhere contains the details of the data query. | ||
| 1337 | |||
| 1338 | **TimeSeriesDataQueryType: **TimeSeriesDataQueryType defines the structure of a query for data. This specifically applies to requesting time series only structured data. | ||
| 1339 | |||
| 1340 | Derivation: | ||
| 1341 | |||
| 1342 | * DataQueryType (restriction) | ||
| 1343 | ** TimeSeriesDataQueryType | ||
| 1344 | |||
| 1345 | Content: | ||
| 1346 | ReturnDetails, DataWhere | ||
| 1347 | |||
| 1348 | Element Documentation: | ||
| 1349 | |||
| 1350 | (% style="width:1021.29px" %) | ||
| 1351 | |**Name**|**Type**|(% style="width:572px" %)**Documentation** | ||
| 1352 | |ReturnDetails|TimeSeriesDataReturn DetailsType|(% style="width:572px" %)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. | ||
| 1353 | |DataWhere|DataParametersAndType|(% style="width:572px" %)DataWhere contains the details of the data query. | ||
| 1354 | |||
| 1355 | **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. | ||
| 1356 | |||
| 1357 | Derivation: | ||
| 1358 | |||
| 1359 | * DataQueryType (restriction) | ||
| 1360 | ** GenericDataQueryType | ||
| 1361 | |||
| 1362 | Content: | ||
| 1363 | ReturnDetails, DataWhere | ||
| 1364 | |||
| 1365 | Element Documentation: | ||
| 1366 | |||
| 1367 | (% style="width:1138.29px" %) | ||
| 1368 | |**Name**|**Type**|(% style="width:712px" %)**Documentation** | ||
| 1369 | |ReturnDetails|GenericDataReturnDet ailsType|(% style="width:712px" %)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. | ||
| 1370 | |DataWhere|DataParametersAndType|(% style="width:712px" %)DataWhere contains the details of the data query. | ||
| 1371 | |||
| 1372 | **GenericTimeSeriesDataQueryType: **GenericTimeSeriesDataQueryType defines the structure of a query for time series only data formatted in the generic format. | ||
| 1373 | |||
| 1374 | Derivation: | ||
| 1375 | |||
| 1376 | * DataQueryType (restriction) | ||
| 1377 | ** GenericDataQueryType (restriction) | ||
| 1378 | *** GenericTimeSeriesDataQueryType | ||
| 1379 | |||
| 1380 | Content: | ||
| 1381 | ReturnDetails, DataWhere | ||
| 1382 | |||
| 1383 | Element Documentation: | ||
| 1384 | |||
| 1385 | (% style="width:1086.29px" %) | ||
| 1386 | |**Name**|**Type**|(% style="width:587px" %)**Documentation** | ||
| 1387 | |ReturnDetails|GenericTimeSeriesDat aReturnDetailsType|(% style="width:587px" %)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. | ||
| 1388 | |DataWhere|DataParametersAndType|(% style="width:587px" %)DataWhere contains the details of the data query. | ||
| 1389 | |||
| 1390 | **//DataReturnDetailsBaseType//: **DataReturnDetailsBaseType is an abstract base type which forms the basis of the DataReturnDetailsType. | ||
| 1391 | |||
| 1392 | Derivation: | ||
| 1393 | |||
| 1394 | * //ReturnDetailsBaseType// (restriction) | ||
| 1395 | ** //DataReturnDetailsBaseType// | ||
| 1396 | |||
| 1397 | Attributes: | ||
| 1398 | defaultLimit?, detail? | ||
| 1399 | |||
| 1400 | Content: | ||
| 1401 | {Empty} | ||
| 1402 | |||
| 1403 | Attribute Documentation: | ||
| 1404 | |||
| 1405 | (% style="width:1107.29px" %) | ||
| 1406 | |**Name**|**Type**|(% style="width:810px" %)**Documentation** | ||
| 1407 | |defaultLimit|xs:integer|(% style="width:810px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 1408 | |detail (default: Full)|DataReturnDetailType|(% style="width:810px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to indicate whether the response to the query should return the full details of matched [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or just a subset of the information should be returned. A value of "Full" indicates that the complete [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (including data and documentation) will be returned. A value of "DataOnly" indicates that only the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], Group, and Series (% style="color:#e74c3c" %)level(%%) [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). | ||
| 1409 | |||
| 1410 | **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. | ||
| 1411 | |||
| 1412 | Derivation: | ||
| 1413 | |||
| 1414 | * //ReturnDetailsBaseType// (restriction) | ||
| 1415 | ** //DataReturnDetailsBaseType// (extension) | ||
| 1416 | *** DataReturnDetailsType | ||
| 1417 | |||
| 1418 | Attributes: | ||
| 1419 | defaultLimit?, detail?, observationAction? | ||
| 1420 | |||
| 1421 | Content: | ||
| 1422 | FirstNObservations?, LastNObservations?, Structure* | ||
| 1423 | |||
| 1424 | Attribute Documentation: | ||
| 1425 | |||
| 1426 | (% style="width:1053.29px" %) | ||
| 1427 | |**Name**|**Type**|(% style="width:654px" %)**Documentation** | ||
| 1428 | |defaultLimit|xs:integer|(% style="width:654px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 1429 | |detail (default: Full)|DataReturnDetailType|(% style="width:654px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to indicate whether the response to the query should return the full details of matched [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or just a subset of the information should be returned. A value of "Full" indicates that the complete [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (including data and documentation) will be returned. A value of "DataOnly" indicates that only the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], Group, and Series (% style="color:#e74c3c" %)level(%%) [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). | ||
| 1430 | |observationAction (default: Active)|ObservationActionCodeType|(% style="width:654px" %)The observationAction [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the type of observations (added, deleted, udpated, or current) to be returned. In the absence of the Updated parameter, this will return all observations that have ever existed for Added, any observations that have ever been updated for Updated, and any observations that have ever been deleted for Deleted. Note that since observations themselves contain no status in the data messages, it is only possible to query for active observations or deleted observations, but not both. It is possible to subset active observation into recently added and recently updated, however it is only possible to retrieve on or the other. If active observations are returned, there will be no distinction as to whether an individual observation was updated or added during the requested Update parameter. | ||
| 1431 | |||
| 1432 | Element Documentation: | ||
| 1433 | |||
| 1434 | (% style="width:1048.29px" %) | ||
| 1435 | |**Name**|**Type**|(% style="width:664px" %)**Documentation** | ||
| 1436 | |FirstNObservations|xs:int|(% style="width:664px" %)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. | ||
| 1437 | |LastNObservations|xs:int|(% style="width:664px" %)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. | ||
| 1438 | |Structure|com: DataStructureRequestType|(% style="width:664px" %)Structure defines how the is requested to be oriented in the returned message. For each data structure, [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) can be specified, and in the case that the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and the query is for structured data, the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 1439 | |||
| 1440 | **GenericDataReturnDetailsType: **GenericDataReturnDetailsType specifies the specifics of the how data should be returned as it pertains to a request for generic data. | ||
| 1441 | |||
| 1442 | Derivation: | ||
| 1443 | |||
| 1444 | * //ReturnDetailsBaseType// (restriction) | ||
| 1445 | ** //DataReturnDetailsBaseType// (extension) | ||
| 1446 | *** DataReturnDetailsType (restriction) | ||
| 1447 | **** GenericDataReturnDetailsType | ||
| 1448 | |||
| 1449 | Attributes: | ||
| 1450 | defaultLimit?, detail?, observationAction? | ||
| 1451 | |||
| 1452 | Content: | ||
| 1453 | FirstNObservations?, LastNObservations?, Structure* | ||
| 1454 | |||
| 1455 | Attribute Documentation: | ||
| 1456 | |||
| 1457 | (% style="width:1055.29px" %) | ||
| 1458 | |**Name**|**Type**|(% style="width:656px" %)**Documentation** | ||
| 1459 | |defaultLimit|xs:integer|(% style="width:656px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 1460 | |detail (default: Full)|DataReturnDetailType|(% style="width:656px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to indicate whether the response to the query should return the full details of matched [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or just a subset of the information should be returned. A value of "Full" indicates that the complete [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (including data and documentation) will be returned. A value of "DataOnly" indicates that only the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], Group, and Series (% style="color:#e74c3c" %)level(%%) [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). | ||
| 1461 | |observationAction (default: Active)|ObservationActionCodeType|(% style="width:656px" %)The observationAction [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 1462 | |||
| 1463 | Element Documentation: | ||
| 1464 | |||
| 1465 | (% style="width:1049.29px" %) | ||
| 1466 | |**Name**|**Type**|(% style="width:610px" %)**Documentation** | ||
| 1467 | |FirstNObservations|xs:int|(% style="width:610px" %)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. | ||
| 1468 | |LastNObservations|xs:int|(% style="width:610px" %)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. | ||
| 1469 | |Structure|com: GenericDataStructureRequestType|(% style="width:610px" %)Structure defines how the is requested to be oriented in the returned message. For each data structure, [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) can be specified, and in the case that the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and the query is for structured data, the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 1470 | |||
| 1471 | **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. | ||
| 1472 | |||
| 1473 | Derivation: | ||
| 1474 | |||
| 1475 | * //ReturnDetailsBaseType// (restriction) | ||
| 1476 | ** //DataReturnDetailsBaseType// (extension) | ||
| 1477 | *** DataReturnDetailsType (restriction) | ||
| 1478 | **** GenericDataReturnDetailsType (restriction) | ||
| 1479 | ***** GenericTimeSeriesDataReturnDetailsType | ||
| 1480 | |||
| 1481 | Attributes: | ||
| 1482 | defaultLimit?, detail?, observationAction? | ||
| 1483 | |||
| 1484 | Content: | ||
| 1485 | FirstNObservations?, LastNObservations?, Structure* | ||
| 1486 | |||
| 1487 | Attribute Documentation: | ||
| 1488 | |||
| 1489 | (% style="width:1086.29px" %) | ||
| 1490 | |**Name**|**Type**|(% style="width:687px" %)**Documentation** | ||
| 1491 | |defaultLimit|xs:integer|(% style="width:687px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 1492 | |detail (default: Full)|DataReturnDetailType|(% style="width:687px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to indicate whether the response to the query should return the full details of matched [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or just a subset of the information should be returned. A value of "Full" indicates that the complete [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (including data and documentation) will be returned. A value of "DataOnly" indicates that only the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], Group, and Series (% style="color:#e74c3c" %)level(%%) [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). | ||
| 1493 | |observationAction (default: Active)|ObservationActionCodeType|(% style="width:687px" %)The observationAction [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 1494 | |||
| 1495 | Element Documentation: | ||
| 1496 | |||
| 1497 | (% style="width:1078.29px" %) | ||
| 1498 | |**Name**|**Type**|(% style="width:563px" %)**Documentation** | ||
| 1499 | |FirstNObservations|xs:int|(% style="width:563px" %)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. | ||
| 1500 | |LastNObservations|xs:int|(% style="width:563px" %)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. | ||
| 1501 | |Structure|com: TimeSeriesGenericDataStructureRequestTyp e|(% style="width:563px" %)Structure defines how the is requested to be oriented in the returned message. For each data structure, [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) can be specified, and in the case that the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and the query is for structured data, the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 1502 | |||
| 1503 | **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. | ||
| 1504 | |||
| 1505 | Derivation: | ||
| 1506 | |||
| 1507 | * //ReturnDetailsBaseType// (restriction) | ||
| 1508 | ** //DataReturnDetailsBaseType// (extension) | ||
| 1509 | *** DataReturnDetailsType (restriction) | ||
| 1510 | **** TimeSeriesDataReturnDetailsType | ||
| 1511 | |||
| 1512 | Attributes: | ||
| 1513 | defaultLimit?, detail?, observationAction? | ||
| 1514 | |||
| 1515 | Content: | ||
| 1516 | FirstNObservations?, LastNObservations?, Structure* | ||
| 1517 | |||
| 1518 | Attribute Documentation: | ||
| 1519 | |||
| 1520 | (% style="width:1032.29px" %) | ||
| 1521 | |**Name**|**Type**|(% style="width:633px" %)**Documentation** | ||
| 1522 | |defaultLimit|xs:integer|(% style="width:633px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 1523 | |detail (default: Full)|DataReturnDetailType|(% style="width:633px" %)The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to indicate whether the response to the query should return the full details of matched [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or just a subset of the information should be returned. A value of "Full" indicates that the complete [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (including data and documentation) will be returned. A value of "DataOnly" indicates that only the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] and keys should be returned. A value of "SeriesKeyOnly" indicates that only the Series elements and their keys (i.e. [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values) should be returned. A value of "NoData" indicates that only documentation should be returned (i.e. the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], Group, and Series (% style="color:#e74c3c" %)level(%%) [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). | ||
| 1524 | |observationAction (default: Active)|ObservationActionCodeType|(% style="width:633px" %)The observationAction [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 1525 | |||
| 1526 | Element Documentation: | ||
| 1527 | |||
| 1528 | (% style="width:1029.29px" %) | ||
| 1529 | |**Name**|**Type**|(% style="width:566px" %)**Documentation** | ||
| 1530 | |FirstNObservations|xs:int|(% style="width:566px" %)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. | ||
| 1531 | |LastNObservations|xs:int|(% style="width:566px" %)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. | ||
| 1532 | |Structure|com: TimeSeriesDataStructureRequestType|(% style="width:566px" %)Structure defines how the is requested to be oriented in the returned message. For each data structure, [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) can be specified, and in the case that the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and the query is for structured data, the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 1533 | |||
| 1534 | **//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. | ||
| 1535 | |||
| 1536 | Content: | ||
| 1537 | DataSetID*, DataProvider*, DataStructure*, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]*, ProvisionAgreement*, [[Category>>doc:sdmx:Glossary.Category.WebHome]]*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue*, AttributeValue*, PrimaryMeasureValue*, AttachmentConstraint*, TimeFormat*, Or*, And* | ||
| 1538 | |||
| 1539 | Element Documentation: | ||
| 1540 | |||
| 1541 | (% style="width:1132.29px" %) | ||
| 1542 | |**Name**|**Type**|(% style="width:654px" %)**Documentation** | ||
| 1543 | |DataSetID|QueryIDType|(% style="width:654px" %)DataSetID is used to match the id of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] with an identifier satisfying these conditions will be matched. | ||
| 1544 | |DataProvider|com: DataProviderReferenceType|(% style="width:654px" %)DataProvider is used to match the provider of data to the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]]. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] provided by the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] will be matched. | ||
| 1545 | |DataStructure|com: DataStructureReferenceType|(% style="width:654px" %)DataStructure is used to match the underlying structure of the data. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] that conform to referenced [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will be matched. | ||
| 1546 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|com: DataflowReferenceType|(% style="width:654px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is used to match the flow which data is reported against. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] report against referenced [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will be matched. | ||
| 1547 | |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:654px" %)ProvisionAgreement is used to match the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] which data is reported against. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] report against the referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] will be matched. | ||
| 1548 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:654px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]] is used to match a data based on the categorization of its underlying structure ([[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]), or the usage of that structure ([[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]]). Only data whose underlying structure or structure usage are categorized against the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]] will be matched. | ||
| 1549 | |Updated|com: TimeRangeValueType|(% style="width:654px" %)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. | ||
| 1550 | |ConceptValue|ConceptValueType|(% style="width:654px" %)ConceptValue is used to match data based on the value of a particular (% style="color:#e74c3c" %)concept(%%). This (% style="color:#e74c3c" %)concept(%%) may be used as a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]] for the data. So long as the referenced (% style="color:#e74c3c" %)concept(%%) has the specified value for a given data point, it will be matched. | ||
| 1551 | |RepresentationValue|CodeValueType|(% style="width:654px" %)RepresentationValue is used to match data based on a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] scheme having a particular value. This [[representation>>doc:sdmx:Glossary.Representation.WebHome]] scheme may be used as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. So long as the value of the (% style="color:#e74c3c" %)concept(%%) using the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] has the value specified, any data point for the (% style="color:#e74c3c" %)concept(%%) will be matched. | ||
| 1552 | |DimensionValue|DimensionValueType|(% style="width:654px" %)DimensionValue is used to match data based on the value of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Any data with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] with the supplied identifier satisfies the conditions supplied will be matched. | ||
| 1553 | |TimeDimensionValue|TimeDimensionValueType|(% style="width:654px" %)TimeDimensionValue is used to match data based on the value of the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Any data with a time value satisfying the conditions supplied will be matched. | ||
| 1554 | |AttributeValue|AttributeValueType|(% style="width:654px" %)AttributeValue is used to match data based on the value of an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. Any data with an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with the supplied identifier satisfies the conditions supplied will be matched. | ||
| 1555 | |PrimaryMeasureValue|PrimaryMeasureValueType|(% style="width:654px" %)PrimaryMeasureValue is used to match data based on the value of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. Any data with its value satisfying the conditions supplied will be matched. | ||
| 1556 | |AttachmentConstraint|com: AttachmentConstraintReferenceType|(% style="width:654px" %)AttachmentConstraint references an attachment (% style="color:#e74c3c" %)constraint(%%) in order to match data which matches the effective data keys or cube regions defined in the (% style="color:#e74c3c" %)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. | ||
| 1557 | |TimeFormat|com:TimeDataType|(% style="width:654px" %)TimeFormat is used to match data when a frequency [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is not explicitly defined. Only data reported against the supplied time data type will be returned. | ||
| 1558 | |Or|DataParametersOrType|(% style="width:654px" %)Or contains a collection of additional parameters, any one of which can be satisfied to result in a match. | ||
| 1559 | |And|DataParametersAndType|(% style="width:654px" %)And contains a collection of additional parameters, all of which must be satisfied to result in a match. | ||
| 1560 | |||
| 1561 | **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. | ||
| 1562 | |||
| 1563 | Derivation: | ||
| 1564 | |||
| 1565 | * //DataParametersType// (restriction) | ||
| 1566 | ** DataParametersOrType | ||
| 1567 | |||
| 1568 | Content: | ||
| 1569 | DataSetID*, DataProvider*, DataStructure*, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]*, ProvisionAgreement*, [[Category>>doc:sdmx:Glossary.Category.WebHome]]*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue*, AttributeValue*, PrimaryMeasureValue*, AttachmentConstraint*, TimeFormat*, And* | ||
| 1570 | |||
| 1571 | Element Documentation: | ||
| 1572 | |||
| 1573 | (% style="width:1086.29px" %) | ||
| 1574 | |**Name**|**Type**|(% style="width:608px" %)**Documentation** | ||
| 1575 | |DataSetID|QueryIDType|(% style="width:608px" %)DataSetID is used to match the id of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] with an identifier satisfying these conditions will be matched. | ||
| 1576 | |DataProvider|com: DataProviderReferenceType|(% style="width:608px" %)DataProvider is used to match the provider of data to the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]]. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] provided by the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] will be matched. | ||
| 1577 | |DataStructure|com: DataStructureReferenceType|(% style="width:608px" %)DataStructure is used to match the underlying structure of the data. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] that conform to referenced [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will be matched. | ||
| 1578 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|com: DataflowReferenceType|(% style="width:608px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is used to match the flow which data is reported against. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] report against referenced [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will be matched. | ||
| 1579 | |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:608px" %)ProvisionAgreement is used to match the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] which data is reported against. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] report against the referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] will be matched. | ||
| 1580 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:608px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]] is used to match a data based on the categorization of its underlying structure ([[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]), or the usage of that structure ([[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]]). Only data whose underlying structure or structure usage are categorized against the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]] will be matched. | ||
| 1581 | |Updated|com: TimeRangeValueType|(% style="width:608px" %)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. | ||
| 1582 | |ConceptValue|ConceptValueType|(% style="width:608px" %)ConceptValue is used to match data based on the value of a particular (% style="color:#e74c3c" %)concept(%%). This (% style="color:#e74c3c" %)concept(%%) may be used as a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]] for the data. So long as the referenced (% style="color:#e74c3c" %)concept(%%) has the specified value for a given data point, it will be matched. | ||
| 1583 | |RepresentationValue|CodeValueType|(% style="width:608px" %)RepresentationValue is used to match data based on a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] scheme having a particular value. This [[representation>>doc:sdmx:Glossary.Representation.WebHome]] scheme may be used as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. So long as the value of the (% style="color:#e74c3c" %)concept(%%) using the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] has the value specified, any data point for the (% style="color:#e74c3c" %)concept(%%) will be matched. | ||
| 1584 | |DimensionValue|DimensionValueType|(% style="width:608px" %)DimensionValue is used to match data based on the value of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Any data with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] with the supplied identifier satisfies the conditions supplied will be matched. | ||
| 1585 | |TimeDimensionValue|TimeDimensionValueType|(% style="width:608px" %)TimeDimensionValue is used to match data based on the value of the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Any data with a time value satisfying the conditions supplied will be matched. | ||
| 1586 | |AttributeValue|AttributeValueType|(% style="width:608px" %)AttributeValue is used to match data based on the value of an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. Any data with an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with the supplied identifier satisfies the conditions supplied will be matched. | ||
| 1587 | |PrimaryMeasureValue|PrimaryMeasureValueType|(% style="width:608px" %)PrimaryMeasureValue is used to match data based on the value of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. Any data with its value satisfying the conditions supplied will be matched. | ||
| 1588 | |AttachmentConstraint|com: AttachmentConstraintReferenceType|(% style="width:608px" %)AttachmentConstraint references an attachment (% style="color:#e74c3c" %)constraint(%%) in order to match data which matches the effective data keys or cube regions defined in the (% style="color:#e74c3c" %)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. | ||
| 1589 | |TimeFormat|com:TimeDataType|(% style="width:608px" %)TimeFormat is used to match data when a frequency [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is not explicitly defined. Only data reported against the supplied time data type will be returned. | ||
| 1590 | |And|DataParametersAndType|(% style="width:608px" %)And contains a collection of additional parameters, all of which must be satisfied to result in a match. | ||
| 1591 | |||
| 1592 | **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>>doc:sdmx:Glossary.Data set.WebHome]] identifier should be "xyz" and the data identifier should be "abc". | ||
| 1593 | |||
| 1594 | Derivation: | ||
| 1595 | |||
| 1596 | * //DataParametersType// (restriction) | ||
| 1597 | ** DataParametersAndType | ||
| 1598 | |||
| 1599 | Content: | ||
| 1600 | DataSetID?, DataProvider?, DataStructure?, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]?, ProvisionAgreement?, [[Category>>doc:sdmx:Glossary.Category.WebHome]]*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue?, AttributeValue*, PrimaryMeasureValue?, AttachmentConstraint*, TimeFormat?, Or* | ||
| 1601 | |||
| 1602 | Element Documentation: | ||
| 1603 | |||
| 1604 | (% style="width:1083.29px" %) | ||
| 1605 | |**Name**|**Type**|(% style="width:605px" %)**Documentation** | ||
| 1606 | |DataSetID|QueryIDType|(% style="width:605px" %)DataSetID is used to match the id of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] with an identifier satisfying these conditions will be matched. | ||
| 1607 | |DataProvider|com: DataProviderReferenceType|(% style="width:605px" %)DataProvider is used to match the provider of data to the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]]. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] provided by the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] will be matched. | ||
| 1608 | |DataStructure|com: DataStructureReferenceType|(% style="width:605px" %)DataStructure is used to match the underlying structure of the data. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] that conform to referenced [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will be matched. | ||
| 1609 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|com: DataflowReferenceType|(% style="width:605px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is used to match the flow which data is reported against. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] report against referenced [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will be matched. | ||
| 1610 | |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:605px" %)ProvisionAgreement is used to match the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] which data is reported against. Only data from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] report against the referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] will be matched. | ||
| 1611 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:605px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]] is used to match a data based on the categorization of its underlying structure ([[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]), or the usage of that structure ([[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]]). Only data whose underlying structure or structure usage are categorized against the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]] will be matched. | ||
| 1612 | |Updated|com: TimeRangeValueType|(% style="width:605px" %)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. | ||
| 1613 | |ConceptValue|ConceptValueType|(% style="width:605px" %)ConceptValue is used to match data based on the value of a particular (% style="color:#e74c3c" %)concept(%%). This (% style="color:#e74c3c" %)concept(%%) may be used as a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]] for the data. So long as the referenced (% style="color:#e74c3c" %)concept(%%) has the specified value for a given data point, it will be matched. | ||
| 1614 | |RepresentationValue|CodeValueType|(% style="width:605px" %)RepresentationValue is used to match data based on a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] scheme having a particular value. This [[representation>>doc:sdmx:Glossary.Representation.WebHome]] scheme may be used as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. So long as the value of the (% style="color:#e74c3c" %)concept(%%) using the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] has the value specified, any data point for the (% style="color:#e74c3c" %)concept(%%) will be matched. | ||
| 1615 | |DimensionValue|DimensionValueType|(% style="width:605px" %)DimensionValue is used to match data based on the value of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Any data with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] with the supplied identifier satisfies the conditions supplied will be matched. | ||
| 1616 | |TimeDimensionValue|TimeDimensionValueType|(% style="width:605px" %)TimeDimensionValue is used to match data based on the value of the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Any data with a time value satisfying the conditions supplied will be matched. | ||
| 1617 | |AttributeValue|AttributeValueType|(% style="width:605px" %)AttributeValue is used to match data based on the value of an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. Any data with an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with the supplied identifier satisfies the conditions supplied will be matched. | ||
| 1618 | |PrimaryMeasureValue|PrimaryMeasureValueType|(% style="width:605px" %)PrimaryMeasureValue is used to match data based on the value of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. Any data with its value satisfying the conditions supplied will be matched. | ||
| 1619 | |AttachmentConstraint|com: AttachmentConstraintReferenceType|(% style="width:605px" %)AttachmentConstraint references an attachment (% style="color:#e74c3c" %)constraint(%%) in order to match data which matches the effective data keys or cube regions defined in the (% style="color:#e74c3c" %)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. | ||
| 1620 | |TimeFormat|com:TimeDataType|(% style="width:605px" %)TimeFormat is used to match data when a frequency [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is not explicitly defined. Only data reported against the supplied time data type will be returned. | ||
| 1621 | |Or|DataParametersOrType|(% style="width:605px" %)Or contains a collection of additional parameters, any one of which can be satisfied to result in a match. | ||
| 1622 | |||
| 1623 | **//DataStructureComponentValueQueryType//: **DataStructureComponentValueQueryType is an abstract base type that is the basis for query a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] for a particular value. Multiple values may be supplied, but the [[component>>doc:sdmx:Glossary.Component.WebHome]] value must match all of the value conditions supplied in order to return a match. | ||
| 1624 | |||
| 1625 | Content: | ||
| 1626 | ID?, (NumericValue[1..2] | TextValue+ | TimeValue[1..2] | Value)? | ||
| 1627 | |||
| 1628 | Element Documentation: | ||
| 1629 | |||
| 1630 | (% style="width:1036.29px" %) | ||
| 1631 | |**Name**|**Type**|(% style="width:744px" %)**Documentation** | ||
| 1632 | |ID|com:NCNameIDType|(% style="width:744px" %)ID provides the identifier for [[component>>doc:sdmx:Glossary.Component.WebHome]] for which the value is sought. | ||
| 1633 | |NumericValue|NumericValueType|(% style="width:744px" %)NumericValue is used to query for a the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1634 | |TextValue|QueryTextType|(% style="width:744px" %)TextValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]]. If only a simple equality check is necessary, regardless of language, the Value element can be used. | ||
| 1635 | |TimeValue|TimePeriodValueType|(% style="width:744px" %)TimeValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1636 | |Value|SimpleValueType|(% style="width:744px" %)Value is used to query for the value of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. This should be used for (% style="color:#e74c3c" %)concepts(%%) or [[components>>doc:sdmx:Glossary.Component.WebHome]] based on a simple value (e.g. a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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. | ||
| 1637 | |||
| 1638 | **DimensionValueType: **DimensionValueType is used to query for data where a given [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] has a particular value. | ||
| 1639 | |||
| 1640 | Derivation: | ||
| 1641 | |||
| 1642 | * //DataStructureComponentValueQueryType// (restriction) | ||
| 1643 | ** DimensionValueType | ||
| 1644 | |||
| 1645 | Content: | ||
| 1646 | ID, (NumericValue[1..2] | TimeValue[1..2] | Value) | ||
| 1647 | |||
| 1648 | Element Documentation: | ||
| 1649 | |||
| 1650 | (% style="width:1035.29px" %) | ||
| 1651 | |**Name**|**Type**|(% style="width:743px" %)**Documentation** | ||
| 1652 | |ID|com:NCNameIDType|(% style="width:743px" %)ID provides the identifier for [[component>>doc:sdmx:Glossary.Component.WebHome]] for which the value is sought. | ||
| 1653 | |NumericValue|NumericValueType|(% style="width:743px" %)NumericValue is used to query for a the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1654 | |TimeValue|TimePeriodValueType|(% style="width:743px" %)TimeValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1655 | |Value|SimpleValueType|(% style="width:743px" %)Value is used to query for the value of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. This should be used for (% style="color:#e74c3c" %)concepts(%%) or [[components>>doc:sdmx:Glossary.Component.WebHome]] based on a simple value (e.g. a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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. | ||
| 1656 | |||
| 1657 | **AttributeValueType: **AttributeValueType is used to query for data where a given [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a particular value. | ||
| 1658 | |||
| 1659 | Derivation: | ||
| 1660 | |||
| 1661 | * //DataStructureComponentValueQueryType// (restriction) | ||
| 1662 | ** AttributeValueType | ||
| 1663 | |||
| 1664 | Content: | ||
| 1665 | ID, (NumericValue[1..2] | TextValue | TimeValue[1..2] | Value) | ||
| 1666 | |||
| 1667 | Element Documentation: | ||
| 1668 | |||
| 1669 | (% style="width:1051.29px" %) | ||
| 1670 | |**Name**|**Type**|(% style="width:759px" %)**Documentation** | ||
| 1671 | |ID|com:NCNameIDType|(% style="width:759px" %)ID provides the identifier for [[component>>doc:sdmx:Glossary.Component.WebHome]] for which the value is sought. | ||
| 1672 | |NumericValue|NumericValueType|(% style="width:759px" %)NumericValue is used to query for a the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1673 | |TextValue|QueryTextType|(% style="width:759px" %)TextValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]]. If only a simple equality check is necessary, regardless of language, the Value element can be used. | ||
| 1674 | |TimeValue|TimePeriodValueType|(% style="width:759px" %)TimeValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1675 | |Value|SimpleValueType|(% style="width:759px" %)Value is used to query for the value of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. This should be used for (% style="color:#e74c3c" %)concepts(%%) or [[components>>doc:sdmx:Glossary.Component.WebHome]] based on a simple value (e.g. a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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. | ||
| 1676 | |||
| 1677 | **PrimaryMeasureValueType: **PrimaryMeasureValueType is used to query for data where the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (i.e. the observed value) has a particular value. | ||
| 1678 | |||
| 1679 | Derivation: | ||
| 1680 | |||
| 1681 | * //DataStructureComponentValueQueryType// (restriction) | ||
| 1682 | ** PrimaryMeasureValueType | ||
| 1683 | |||
| 1684 | Content: | ||
| 1685 | ID?, (NumericValue[1..2] | TextValue | TimeValue[1..2] | Value) | ||
| 1686 | |||
| 1687 | Element Documentation: | ||
| 1688 | |||
| 1689 | (% style="width:1042.29px" %) | ||
| 1690 | |**Name**|**Type**|(% style="width:750px" %)**Documentation** | ||
| 1691 | |ID|com:NCNameIDType|(% style="width:750px" %)ID provides the identifier for [[component>>doc:sdmx:Glossary.Component.WebHome]] for which the value is sought. | ||
| 1692 | |NumericValue|NumericValueType|(% style="width:750px" %)NumericValue is used to query for a the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1693 | |TextValue|QueryTextType|(% style="width:750px" %)TextValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]]. If only a simple equality check is necessary, regardless of language, the Value element can be used. | ||
| 1694 | |TimeValue|TimePeriodValueType|(% style="width:750px" %)TimeValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1695 | |Value|SimpleValueType|(% style="width:750px" %)Value is used to query for the value of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. This should be used for (% style="color:#e74c3c" %)concepts(%%) or [[components>>doc:sdmx:Glossary.Component.WebHome]] based on a simple value (e.g. a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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. | ||
| 1696 | |||
| 1697 | **TimeDimensionValueType: **TimeDimensionValueType is used to query for data where the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] has a particular value. | ||
| 1698 | |||
| 1699 | Derivation: | ||
| 1700 | |||
| 1701 | * //DataStructureComponentValueQueryType// (restriction) | ||
| 1702 | ** TimeDimensionValueType | ||
| 1703 | |||
| 1704 | Content: | ||
| 1705 | ID?, TimeValue[1..2] | ||
| 1706 | |||
| 1707 | Element Documentation: | ||
| 1708 | |||
| 1709 | (% style="width:1058.29px" %) | ||
| 1710 | |**Name**|**Type**|(% style="width:791px" %)**Documentation** | ||
| 1711 | |ID|com:NCNameIDType|(% style="width:791px" %)ID provides the identifier for [[component>>doc:sdmx:Glossary.Component.WebHome]] for which the value is sought. | ||
| 1712 | |TimeValue|TimePeriodValueType|(% style="width:791px" %)TimeValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 1713 | |||
| 1714 | **DataflowQueryType: **DataflowQueryType defines the structure of a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] 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>>doc:sdmx:Glossary.Dataflow.WebHome]] should be returned. | ||
| 1715 | |||
| 1716 | Derivation: | ||
| 1717 | |||
| 1718 | * //StructuralMetadataQueryType// (restriction) | ||
| 1719 | ** DataflowQueryType | ||
| 1720 | |||
| 1721 | Content: | ||
| 1722 | ReturnDetails, DataflowWhere | ||
| 1723 | |||
| 1724 | Element Documentation: | ||
| 1725 | |||
| 1726 | (% style="width:1051.29px" %) | ||
| 1727 | |**Name**|**Type**|(% style="width:682px" %)**Documentation** | ||
| 1728 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:682px" %) | ||
| 1729 | |DataflowWhere|DataflowWhereType|(% style="width:682px" %)DataflowWhere defines the parameters for a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] 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>>doc:sdmx:Glossary.Dataflow.WebHome]] based on the key family it defines the usage of. | ||
| 1730 | |||
| 1731 | **DataflowWhereType: **DataflowWhereType contains the parameters of a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 1732 | |||
| 1733 | Derivation: | ||
| 1734 | |||
| 1735 | * //AnnotableWhereType// (extension) | ||
| 1736 | ** //IdentifiableWhereType// (extension) | ||
| 1737 | *** //NameableWhereType// (extension) | ||
| 1738 | **** //VersionableWhereType// (extension) | ||
| 1739 | ***** //MaintainableWhereType// (extension) | ||
| 1740 | ****** //StructureUsageWhereType// (restriction) | ||
| 1741 | ******* DataflowWhereType | ||
| 1742 | |||
| 1743 | Attributes: | ||
| 1744 | type? | ||
| 1745 | |||
| 1746 | Content: | ||
| 1747 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure? | ||
| 1748 | |||
| 1749 | Attribute Documentation: | ||
| 1750 | |||
| 1751 | (% style="width:1090.29px" %) | ||
| 1752 | |**Name**|**Type**|(% style="width:653px" %)**Documentation** | ||
| 1753 | |type (fixed: [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]])|com: MaintainableTypeCodelistType|(% style="width:653px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 1754 | |||
| 1755 | Element Documentation: | ||
| 1756 | |||
| 1757 | (% style="width:1089.29px" %) | ||
| 1758 | |**Name**|**Type**|(% style="width:726px" %)**Documentation** | ||
| 1759 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:726px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1760 | |URN|xs:anyURI|(% style="width:726px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 1761 | |ID|QueryIDType|(% style="width:726px" %)ID is used to match the id of the identified object. | ||
| 1762 | |Name|QueryTextType|(% style="width:726px" %)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. | ||
| 1763 | |Description|QueryTextType|(% style="width:726px" %)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. | ||
| 1764 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:726px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 1765 | |VersionTo|com: TimeRangeValueType|(% style="width:726px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1766 | |VersionFrom|com: TimeRangeValueType|(% style="width:726px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1767 | |VersionActive|xs:boolean|(% style="width:726px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1768 | |AgencyID|QueryNestedIDType|(% style="width:726px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1769 | |Structure|com: DataStructureReferenceType|(% style="width:726px" %)Structure is used to indicate which key family the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] must define a usage for in order to constitute a match. | ||
| 1770 | |||
| 1771 | **DataStructureQueryType: **DataStructureQueryType defines the structure of a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] should be returned. | ||
| 1772 | |||
| 1773 | Derivation: | ||
| 1774 | |||
| 1775 | * //StructuralMetadataQueryType// (restriction) | ||
| 1776 | ** DataStructureQueryType | ||
| 1777 | |||
| 1778 | Content: | ||
| 1779 | ReturnDetails, DataStructureWhere | ||
| 1780 | |||
| 1781 | Element Documentation: | ||
| 1782 | |||
| 1783 | (% style="width:1059.29px" %) | ||
| 1784 | |**Name**|**Type**|(% style="width:656px" %)**Documentation** | ||
| 1785 | |ReturnDetails|MaintainableReturnDe tailsType|(% style="width:656px" %) | ||
| 1786 | |DataStructureWhere|DataStructureWhereType|(% style="width:656px" %)DataStructureWhere contains the parameters for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 1787 | |||
| 1788 | **//DataStructureWhereBaseType//: **DataStructureWhereBaseType is an abstract base type that forms the basis of the DataStructureWhereType. | ||
| 1789 | |||
| 1790 | Derivation: | ||
| 1791 | |||
| 1792 | * //AnnotableWhereType// (extension) | ||
| 1793 | ** //IdentifiableWhereType// (extension) | ||
| 1794 | *** //NameableWhereType// (extension) | ||
| 1795 | **** //VersionableWhereType// (extension) | ||
| 1796 | ***** //MaintainableWhereType// (extension) | ||
| 1797 | ****** //StructureWhereType// (restriction) | ||
| 1798 | ******* //DataStructureWhereBaseType// | ||
| 1799 | |||
| 1800 | Attributes: | ||
| 1801 | type? | ||
| 1802 | |||
| 1803 | Content: | ||
| 1804 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, GroupWhere* | ||
| 1805 | |||
| 1806 | Attribute Documentation: | ||
| 1807 | |||
| 1808 | (% style="width:1051.29px" %) | ||
| 1809 | |**Name**|**Type**|(% style="width:581px" %)**Documentation** | ||
| 1810 | |type (fixed: DataStructure)|com: MaintainableTypeCodelistType|(% style="width:581px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 1811 | |||
| 1812 | Element Documentation: | ||
| 1813 | |||
| 1814 | (% style="width:1137.29px" %) | ||
| 1815 | |**Name**|**Type**|(% style="width:579px" %)**Documentation** | ||
| 1816 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:579px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1817 | |URN|xs:anyURI|(% style="width:579px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 1818 | |ID|QueryIDType|(% style="width:579px" %)ID is used to match the id of the identified object. | ||
| 1819 | |Name|QueryTextType|(% style="width:579px" %)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. | ||
| 1820 | |Description|QueryTextType|(% style="width:579px" %)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. | ||
| 1821 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:579px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 1822 | |VersionTo|com: TimeRangeValueType|(% style="width:579px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1823 | |VersionFrom|com: TimeRangeValueType|(% style="width:579px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1824 | |VersionActive|xs:boolean|(% style="width:579px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1825 | |AgencyID|QueryNestedIDType|(% style="width:579px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1826 | |UsedConcept|com: ConceptReferenceType|(% style="width:579px" %)UsedConcept is used to query for a structure that uses the referenced (% style="color:#e74c3c" %)concept(%%) as the basis of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 1827 | |UsedRepresentation|com: DataStructureEnumerationSchemeReferenceType|(% style="width:579px" %)UsedRepresentation is used to query for a structure that uses the referenced [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 1828 | |GroupWhere|GroupWhereType|(% style="width:579px" %)GroupWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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. | ||
| 1829 | |||
| 1830 | **DataStructureWhereType: **DataStructureWhereType defines the parameters of a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] query. In addition to querying based on the identification, it is also possible to search for [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] based on information about its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 1831 | |||
| 1832 | Derivation: | ||
| 1833 | |||
| 1834 | * //AnnotableWhereType// (extension) | ||
| 1835 | ** //IdentifiableWhereType// (extension) | ||
| 1836 | *** //NameableWhereType// (extension) | ||
| 1837 | **** //VersionableWhereType// (extension) | ||
| 1838 | ***** //MaintainableWhereType// (extension) | ||
| 1839 | ****** //StructureWhereType// (restriction) | ||
| 1840 | ******* //DataStructureWhereBaseType// (extension) | ||
| 1841 | ******** DataStructureWhereType | ||
| 1842 | |||
| 1843 | Attributes: | ||
| 1844 | type? | ||
| 1845 | |||
| 1846 | Content: | ||
| 1847 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, GroupWhere*, AttributeWhere*, DimensionWhere*, MeasureDimensionWhere?, TimeDimensionWhere?, PrimaryMeasureWhere? | ||
| 1848 | |||
| 1849 | Attribute Documentation: | ||
| 1850 | |||
| 1851 | (% style="width:1106.29px" %) | ||
| 1852 | |**Name**|**Type**|(% style="width:636px" %)**Documentation** | ||
| 1853 | |type (fixed: DataStructure)|com: MaintainableTypeCodelistType|(% style="width:636px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 1854 | |||
| 1855 | Element Documentation: | ||
| 1856 | |||
| 1857 | (% style="width:1106.29px" %) | ||
| 1858 | |**Name**|**Type**|(% style="width:511px" %)**Documentation** | ||
| 1859 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:511px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1860 | |URN|xs:anyURI|(% style="width:511px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 1861 | |ID|QueryIDType|(% style="width:511px" %)ID is used to match the id of the identified object. | ||
| 1862 | |Name|QueryTextType|(% style="width:511px" %)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. | ||
| 1863 | |Description|QueryTextType|(% style="width:511px" %)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. | ||
| 1864 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:511px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 1865 | |VersionTo|com: TimeRangeValueType|(% style="width:511px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1866 | |VersionFrom|com: TimeRangeValueType|(% style="width:511px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 1867 | |VersionActive|xs:boolean|(% style="width:511px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 1868 | |AgencyID|QueryNestedIDType|(% style="width:511px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 1869 | |UsedConcept|com: ConceptReferenceType|(% style="width:511px" %)UsedConcept is used to query for a structure that uses the referenced (% style="color:#e74c3c" %)concept(%%) as the basis of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 1870 | |UsedRepresentation|com: DataStructureEnumerationSchemeReferenceType|(% style="width:511px" %)UsedRepresentation is used to query for a structure that uses the referenced [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 1871 | |GroupWhere|GroupWhereType|(% style="width:511px" %)GroupWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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. | ||
| 1872 | |AttributeWhere|AttributeWhereType|(% style="width:511px" %)AttributeWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] meeting the conditions contained in this structure. The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, its [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]], the role it plays, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. 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 | |DimensionWhere|DimensionWhereType|(% style="width:511px" %)DimensionWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] meeting the conditions contained in this structure. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, the role it plays, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 1874 | |MeasureDimensionWhere|MeasureDimensionWhereType|(% style="width:511px" %)MeasureDimensionWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] meeting the conditions contained in this structure. The cross-sectional [[measure>>doc:sdmx:Glossary.Measure.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 1875 | |TimeDimensionWhere|TimeDimensionWhereType|(% style="width:511px" %)TimeDimensionWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] meeting the conditions contained in this structure. The time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be queried based on its identification and the (% style="color:#e74c3c" %)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. | ||
| 1876 | |PrimaryMeasureWhere|PrimaryMeasureWhereType|(% style="width:511px" %)PrimaryMeasureWhere is used to query for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that contains a primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] meeting the conditions contained in this structure. The primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 1877 | |||
| 1878 | **//GroupWhereBaseType//: **GroupWhereBaseType is an abstract base type that forms the basis for the GroupWhereType. | ||
| 1879 | |||
| 1880 | Derivation: | ||
| 1881 | |||
| 1882 | * //AnnotableWhereType// (extension) | ||
| 1883 | ** //IdentifiableWhereType// (extension) | ||
| 1884 | *** //ComponentListWhereType// (restriction) | ||
| 1885 | **** //GroupWhereBaseType// | ||
| 1886 | |||
| 1887 | Content: | ||
| 1888 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, GroupDimensionWhere* | ||
| 1889 | |||
| 1890 | Element Documentation: | ||
| 1891 | |||
| 1892 | (% style="width:1065.29px" %) | ||
| 1893 | |**Name**|**Type**|(% style="width:669px" %)**Documentation** | ||
| 1894 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:669px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1895 | |ID|QueryIDType|(% style="width:669px" %)ID is used to match the id of the identified object. | ||
| 1896 | |GroupDimensionWhere|DimensionWhereType|(% style="width:669px" %)GroupDimensionWhere is used to query a group based on the details of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] 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. | ||
| 1897 | |||
| 1898 | **GroupWhereType: **GroupWhereType defines the parameters querying for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] based a group meeting the conditions detailed. Parameters include identification, [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] used in the group, and the group's referenced attachment (% style="color:#e74c3c" %)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. | ||
| 1899 | |||
| 1900 | Derivation: | ||
| 1901 | |||
| 1902 | * //AnnotableWhereType// (extension) | ||
| 1903 | ** //IdentifiableWhereType// (extension) | ||
| 1904 | *** //ComponentListWhereType// (restriction) | ||
| 1905 | **** //GroupWhereBaseType// (extension) | ||
| 1906 | ***** GroupWhereType | ||
| 1907 | |||
| 1908 | Content: | ||
| 1909 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, GroupDimensionWhere*, AttachmentConstraint? | ||
| 1910 | |||
| 1911 | Element Documentation: | ||
| 1912 | |||
| 1913 | (% style="width:1107.29px" %) | ||
| 1914 | |**Name**|**Type**|(% style="width:593px" %)**Documentation** | ||
| 1915 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:593px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1916 | |ID|QueryIDType|(% style="width:593px" %)ID is used to match the id of the identified object. | ||
| 1917 | |GroupDimensionWhere|DimensionWhereType|(% style="width:593px" %)GroupDimensionWhere is used to query a group based on the details of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] 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. | ||
| 1918 | |AttachmentConstraint|com: AttachmentConstraintReferenceType|(% style="width:593px" %)AttachmentConstraint queries for a group where the referenced attachment (% style="color:#e74c3c" %)constraint(%%) defines the contents of the group. | ||
| 1919 | |||
| 1920 | **DataStructureComponentWhereType: **DataStructureComponentWhereType defines the basic information for querying for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]]. The [[component>>doc:sdmx:Glossary.Component.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]],. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 1921 | |||
| 1922 | Derivation: | ||
| 1923 | |||
| 1924 | * //AnnotableWhereType// (extension) | ||
| 1925 | ** //IdentifiableWhereType// (extension) | ||
| 1926 | *** //ComponentWhereType// (restriction) | ||
| 1927 | **** DataStructureComponentWhereType | ||
| 1928 | |||
| 1929 | Content: | ||
| 1930 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, ConceptIdentity?, Enumeration? | ||
| 1931 | |||
| 1932 | Element Documentation: | ||
| 1933 | |||
| 1934 | (% style="width:1057.29px" %) | ||
| 1935 | |**Name**|**Type**|(% style="width:713px" %)**Documentation** | ||
| 1936 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:713px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1937 | |ID|QueryIDType|(% style="width:713px" %)ID is used to match the id of the identified object. | ||
| 1938 | |ConceptIdentity|com: ConceptReferenceType|(% style="width:713px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 1939 | |Enumeration|com: CodelistReferenceType|(% style="width:713px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 1940 | |||
| 1941 | **AttributeWhereType: **AttributeWhereType describes the structure of an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] query. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, the role it plays, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 1942 | |||
| 1943 | Derivation: | ||
| 1944 | |||
| 1945 | * //AnnotableWhereType// (extension) | ||
| 1946 | ** //IdentifiableWhereType// (extension) | ||
| 1947 | *** //ComponentWhereType// (restriction) | ||
| 1948 | **** DataStructureComponentWhereType (extension) | ||
| 1949 | ***** AttributeWhereType | ||
| 1950 | |||
| 1951 | Content: | ||
| 1952 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, ConceptIdentity?, Enumeration?, Role* | ||
| 1953 | |||
| 1954 | Element Documentation: | ||
| 1955 | |||
| 1956 | (% style="width:1063.29px" %) | ||
| 1957 | |**Name**|**Type**|(% style="width:719px" %)**Documentation** | ||
| 1958 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:719px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1959 | |ID|QueryIDType|(% style="width:719px" %)ID is used to match the id of the identified object. | ||
| 1960 | |ConceptIdentity|com: ConceptReferenceType|(% style="width:719px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 1961 | |Enumeration|com: CodelistReferenceType|(% style="width:719px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 1962 | |Role|com: ConceptReferenceType|(% style="width:719px" %)Role is used to specify the role of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 1963 | |||
| 1964 | **DimensionWhereType: **DimensionWhereType describes the structure of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] query. A [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, the role it plays, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 1965 | |||
| 1966 | Derivation: | ||
| 1967 | |||
| 1968 | * //AnnotableWhereType// (extension) | ||
| 1969 | ** //IdentifiableWhereType// (extension) | ||
| 1970 | *** //ComponentWhereType// (restriction) | ||
| 1971 | **** DataStructureComponentWhereType (extension) | ||
| 1972 | ***** DimensionWhereType | ||
| 1973 | |||
| 1974 | Content: | ||
| 1975 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, ConceptIdentity?, Enumeration?, Role* | ||
| 1976 | |||
| 1977 | Element Documentation: | ||
| 1978 | |||
| 1979 | (% style="width:1073.29px" %) | ||
| 1980 | |**Name**|**Type**|(% style="width:729px" %)**Documentation** | ||
| 1981 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:729px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1982 | |ID|QueryIDType|(% style="width:729px" %)ID is used to match the id of the identified object. | ||
| 1983 | |ConceptIdentity|com: ConceptReferenceType|(% style="width:729px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 1984 | |Enumeration|com: CodelistReferenceType|(% style="width:729px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 1985 | |Role|com: ConceptReferenceType|(% style="width:729px" %)Role is used to specify the role of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 1986 | |||
| 1987 | **TimeDimensionWhereType: **TimeDimensionWhereType describes the structure of a time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] query. The time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be queried based on the (% style="color:#e74c3c" %)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. | ||
| 1988 | |||
| 1989 | Derivation: | ||
| 1990 | |||
| 1991 | * //AnnotableWhereType// (extension) | ||
| 1992 | ** //IdentifiableWhereType// (extension) | ||
| 1993 | *** //ComponentWhereType// (restriction) | ||
| 1994 | **** DataStructureComponentWhereType (restriction) | ||
| 1995 | ***** TimeDimensionWhereType | ||
| 1996 | |||
| 1997 | Content: | ||
| 1998 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity? | ||
| 1999 | |||
| 2000 | Element Documentation: | ||
| 2001 | |||
| 2002 | (% style="width:1067.29px" %) | ||
| 2003 | |**Name**|(% style="width:227px" %)**Type**|(% style="width:648px" %)**Documentation** | ||
| 2004 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|(% style="width:227px" %)AnnotationWhereType|(% style="width:648px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2005 | |ConceptIdentity|(% style="width:227px" %)com: ConceptReferenceType|(% style="width:648px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 2006 | |||
| 2007 | **//MeasureDimensionWhereBaseType//: **MeasureDimensionWhereBaseType is an abstract base type which forms the basis for a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] query. | ||
| 2008 | |||
| 2009 | Derivation: | ||
| 2010 | |||
| 2011 | * //AnnotableWhereType// (extension) | ||
| 2012 | ** //IdentifiableWhereType// (extension) | ||
| 2013 | *** //ComponentWhereType// (restriction) | ||
| 2014 | **** //MeasureDimensionWhereBaseType// | ||
| 2015 | |||
| 2016 | Content: | ||
| 2017 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, ConceptIdentity?, Enumeration? | ||
| 2018 | |||
| 2019 | Element Documentation: | ||
| 2020 | |||
| 2021 | (% style="width:1048.29px" %) | ||
| 2022 | |**Name**|**Type**|(% style="width:647px" %)**Documentation** | ||
| 2023 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:647px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2024 | |ID|QueryIDType|(% style="width:647px" %)ID is used to match the id of the identified object. | ||
| 2025 | |ConceptIdentity|com: ConceptReferenceType|(% style="width:647px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 2026 | |Enumeration|com: ConceptSchemeReferenceType|(% style="width:647px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2027 | |||
| 2028 | **MeasureDimensionWhereType: **MeasureDimensionWhereType describes the structure of a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] query. A [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, the role it plays, and the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] which defines its [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)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. | ||
| 2029 | |||
| 2030 | Derivation: | ||
| 2031 | |||
| 2032 | * //AnnotableWhereType// (extension) | ||
| 2033 | ** //IdentifiableWhereType// (extension) | ||
| 2034 | *** //ComponentWhereType// (restriction) | ||
| 2035 | **** //MeasureDimensionWhereBaseType// (extension) | ||
| 2036 | ***** MeasureDimensionWhereType | ||
| 2037 | |||
| 2038 | Content: | ||
| 2039 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, ConceptIdentity?, Enumeration?, Role* | ||
| 2040 | |||
| 2041 | Element Documentation: | ||
| 2042 | |||
| 2043 | (% style="width:1078.29px" %) | ||
| 2044 | |**Name**|**Type**|(% style="width:677px" %)**Documentation** | ||
| 2045 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:677px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2046 | |ID|QueryIDType|(% style="width:677px" %)ID is used to match the id of the identified object. | ||
| 2047 | |ConceptIdentity|com: ConceptReferenceType|(% style="width:677px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 2048 | |Enumeration|com: ConceptSchemeReferenceType|(% style="width:677px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2049 | |Role|com: ConceptReferenceType|(% style="width:677px" %)Role is used to specify the role of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 2050 | |||
| 2051 | **PrimaryMeasureWhereType: **MeasureWhereType describes the structure of a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] query. The primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] can be queried based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] it uses as the enumeration of its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 2052 | |||
| 2053 | Derivation: | ||
| 2054 | |||
| 2055 | * //AnnotableWhereType// (extension) | ||
| 2056 | ** //IdentifiableWhereType// (extension) | ||
| 2057 | *** //ComponentWhereType// (restriction) | ||
| 2058 | **** DataStructureComponentWhereType (restriction) | ||
| 2059 | ***** PrimaryMeasureWhereType | ||
| 2060 | |||
| 2061 | Content: | ||
| 2062 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity?, Enumeration? | ||
| 2063 | |||
| 2064 | Element Documentation: | ||
| 2065 | |||
| 2066 | (% style="width:1075.29px" %) | ||
| 2067 | |**Name**|**Type**|(% style="width:731px" %)**Documentation** | ||
| 2068 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:731px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2069 | |ConceptIdentity|com: ConceptReferenceType|(% style="width:731px" %)ConceptIdentity is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic. | ||
| 2070 | |Enumeration|com: CodelistReferenceType|(% style="width:731px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2071 | |||
| 2072 | **HierarchicalCodelistQueryType: **HierarchicalCodelistQueryType defines the structure of a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Code list.WebHome]] should be returned. | ||
| 2073 | |||
| 2074 | Derivation: | ||
| 2075 | |||
| 2076 | * //StructuralMetadataQueryType// (restriction) | ||
| 2077 | ** HierarchicalCodelistQueryType | ||
| 2078 | |||
| 2079 | Content: | ||
| 2080 | ReturnDetails, HierarchicalCodelistWhere | ||
| 2081 | |||
| 2082 | Element Documentation: | ||
| 2083 | |||
| 2084 | (% style="width:1039.29px" %) | ||
| 2085 | |**Name**|**Type**|(% style="width:588px" %)**Documentation** | ||
| 2086 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:588px" %) | ||
| 2087 | |HierarchicalCodelistWhere|HierarchicalCodelistWhereType|(% style="width:588px" %)HierarchicalCodelistWhere defines the parameters for a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Code list.WebHome]] based on the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] it arranges into hierarchies. | ||
| 2088 | |||
| 2089 | **//HierarchicalCodelistWhereBaseType//: **HierarchicalCodelistWhereBaseType is an abstract base type which forms the basis for the HierarchicalCodelistWhereType. | ||
| 2090 | |||
| 2091 | Derivation: | ||
| 2092 | |||
| 2093 | * //AnnotableWhereType// (extension) | ||
| 2094 | ** //IdentifiableWhereType// (extension) | ||
| 2095 | *** //NameableWhereType// (extension) | ||
| 2096 | **** //VersionableWhereType// (extension) | ||
| 2097 | ***** //MaintainableWhereType// (restriction) | ||
| 2098 | ****** //HierarchicalCodelistWhereBaseType// | ||
| 2099 | |||
| 2100 | Attributes: | ||
| 2101 | type? | ||
| 2102 | |||
| 2103 | Content: | ||
| 2104 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 2105 | |||
| 2106 | Attribute Documentation: | ||
| 2107 | |||
| 2108 | (% style="width:1075.29px" %) | ||
| 2109 | |(% style="width:254px" %)**Name**|(% style="width:285px" %)**Type**|(% style="width:533px" %)**Documentation** | ||
| 2110 | |(% style="width:254px" %)type (fixed: HierarchicalCodelist)|(% style="width:285px" %)com: MaintainableTypeCodelistType|(% style="width:533px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 2111 | |||
| 2112 | Element Documentation: | ||
| 2113 | |||
| 2114 | (% style="width:1075.29px" %) | ||
| 2115 | |**Name**|**Type**|(% style="width:758px" %)**Documentation** | ||
| 2116 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:758px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2117 | |URN|xs:anyURI|(% style="width:758px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2118 | |ID|QueryIDType|(% style="width:758px" %)ID is used to match the id of the identified object. | ||
| 2119 | |Name|QueryTextType|(% style="width:758px" %)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. | ||
| 2120 | |Description|QueryTextType|(% style="width:758px" %)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. | ||
| 2121 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:758px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2122 | |VersionTo|com: TimeRangeValueType|(% style="width:758px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2123 | |VersionFrom|com: TimeRangeValueType|(% style="width:758px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2124 | |VersionActive|xs:boolean|(% style="width:758px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2125 | |AgencyID|QueryNestedIDType|(% style="width:758px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2126 | |||
| 2127 | **HierarchicalCodelistWhereType: **HierarchicalCodelistWhereType contains the parameters of a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 2128 | |||
| 2129 | Derivation: | ||
| 2130 | |||
| 2131 | * //AnnotableWhereType// (extension) | ||
| 2132 | ** //IdentifiableWhereType// (extension) | ||
| 2133 | *** //NameableWhereType// (extension) | ||
| 2134 | **** //VersionableWhereType// (extension) | ||
| 2135 | ***** //MaintainableWhereType// (restriction) | ||
| 2136 | ****** //HierarchicalCodelistWhereBaseType// (extension) | ||
| 2137 | ******* HierarchicalCodelistWhereType | ||
| 2138 | |||
| 2139 | Attributes: | ||
| 2140 | type? | ||
| 2141 | |||
| 2142 | Content: | ||
| 2143 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, IncludedCodelist* | ||
| 2144 | |||
| 2145 | Attribute Documentation: | ||
| 2146 | |||
| 2147 | (% style="width:1103.29px" %) | ||
| 2148 | |(% style="width:247px" %)**Name**|(% style="width:279px" %)**Type**|(% style="width:575px" %)**Documentation** | ||
| 2149 | |(% style="width:247px" %)type (fixed: HierarchicalCodelist)|(% style="width:279px" %)com: MaintainableTypeCodelistType|(% style="width:575px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 2150 | |||
| 2151 | Element Documentation: | ||
| 2152 | |||
| 2153 | (% style="width:1105.29px" %) | ||
| 2154 | |**Name**|**Type**|(% style="width:761px" %)**Documentation** | ||
| 2155 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:761px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2156 | |URN|xs:anyURI|(% style="width:761px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2157 | |ID|QueryIDType|(% style="width:761px" %)ID is used to match the id of the identified object. | ||
| 2158 | |Name|QueryTextType|(% style="width:761px" %)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. | ||
| 2159 | |Description|QueryTextType|(% style="width:761px" %)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. | ||
| 2160 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:761px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2161 | |VersionTo|com: TimeRangeValueType|(% style="width:761px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2162 | |VersionFrom|com: TimeRangeValueType|(% style="width:761px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2163 | |VersionActive|xs:boolean|(% style="width:761px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2164 | |AgencyID|QueryNestedIDType|(% style="width:761px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2165 | |IncludedCodelist|com: CodelistReferenceType|(% style="width:761px" %)IncludedCodelist is used to reference a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] which the hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] to be matched references. | ||
| 2166 | |||
| 2167 | **MetadataQueryType: **MetadataQueryType defines the structure of a [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] query. [[Reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is queried as individual reports. The result of this query will be a collection of [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]], with only the relevant metadata reports contained within them. If no report (% style="color:#e74c3c" %)level(%%) parameters are specified, then the query will result in entire [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] being returned. | ||
| 2168 | |||
| 2169 | Content: | ||
| 2170 | ReturnDetails, MetadataParameters | ||
| 2171 | |||
| 2172 | Element Documentation: | ||
| 2173 | |||
| 2174 | (% style="width:1013.29px" %) | ||
| 2175 | |**Name**|**Type**|(% style="width:477px" %)**Documentation** | ||
| 2176 | |ReturnDetails|MetadataReturnDetailsType|(% style="width:477px" %)ReturnDetails specifies the details of how the [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] should be returned. | ||
| 2177 | |MetadataParameters|MetadataParametersAndType|(% style="width:477px" %)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. | ||
| 2178 | |||
| 2179 | **MetadataReturnDetailsType: **MetadataReturnDetailsType is a structure for detailing how [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] should be returned. Only a default size limit can be specified. | ||
| 2180 | |||
| 2181 | Derivation: | ||
| 2182 | |||
| 2183 | * //ReturnDetailsBaseType// (extension) | ||
| 2184 | ** MetadataReturnDetailsType | ||
| 2185 | |||
| 2186 | Attributes: | ||
| 2187 | defaultLimit?, detail? | ||
| 2188 | |||
| 2189 | Content: | ||
| 2190 | {Empty} | ||
| 2191 | |||
| 2192 | Attribute Documentation: | ||
| 2193 | |||
| 2194 | (% style="width:1007.29px" %) | ||
| 2195 | |(% style="width:127px" %)**Name**|(% style="width:151px" %)**Type**|(% style="width:726px" %)**Documentation** | ||
| 2196 | |(% style="width:127px" %)defaultLimit|(% style="width:151px" %)xs:integer|(% style="width:726px" %)The defaultLimit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the suggested maximum response size in kilobytes. | ||
| 2197 | |(% style="width:127px" %)detail|(% style="width:151px" %)xs:string|(% style="width:726px" %)>The detail [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to indicate how much of the matched object should be returned. | ||
| 2198 | |||
| 2199 | **//MetadataParametersType//: **MetadataParametersType defines the parameters for querying for [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. This structure is refined by separate And/Or constructs which make logical restrictions on which parameters apply in such cases. | ||
| 2200 | |||
| 2201 | Content: | ||
| 2202 | MetadataSetID*, DataProvider*, MetadataStructure*, [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]*, ProvisionAgreement*, [[Category>>doc:sdmx:Glossary.Category.WebHome]]*, Updated*, ConceptValue*, RepresentationValue*, MetadataTargetValue*, ReportStructureValue*, AttachmentConstraint*, AttachedObject*, AttachedDataKey*, AttachedDataSet*, AttachedReportingPeriod*, Or*, And* | ||
| 2203 | |||
| 2204 | Element Documentation: | ||
| 2205 | |||
| 2206 | (% style="width:1053.29px" %) | ||
| 2207 | |**Name**|**Type**|(% style="width:562px" %)**Documentation** | ||
| 2208 | |MetadataSetID|QueryIDType|(% style="width:562px" %)MetadataSetID is used to match the id of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. Only metadata reports from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] with an identifier satisfying these conditions will be matched. | ||
| 2209 | |DataProvider|com: DataProviderReferenceType|(% style="width:562px" %)DataProviderReference is used to match the provider of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]]. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] provided by the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] will be matched. | ||
| 2210 | |MetadataStructure|com: MetadataStructureReferenceType|(% style="width:562px" %)MetadataStructureReference is used to match the underlying structure of the data. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] that conform to [[referenced metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] structure definition will be matched. | ||
| 2211 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|com: MetadataflowReferenceType|(% style="width:562px" %)MetadataflowReference is used to match the flow which [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is reported against. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] report against [[referenced metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] flow will be matched. | ||
| 2212 | |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:562px" %)ProvisionAgreement is used to match the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] which metadata is reported against. Only metadata from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] report against the referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] will be matched. | ||
| 2213 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:562px" %)CategoryReference is used to match a [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the categorization of its underlying structure ([[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]), or the usage of that structure ([[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]]). Only metadata reports whose underlying structure or structure usage are categorized against the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]] will be matched. | ||
| 2214 | |Updated|com: TimeRangeValueType|(% style="width:562px" %)Updated is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on when it was last updated. Only metadata reports which satisfy the conditions for the last update parameters supplied here will be matched. | ||
| 2215 | |ConceptValue|ConceptValueType|(% style="width:562px" %)ConceptValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the value of a particular (% style="color:#e74c3c" %)concept(%%) which defines a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. So long as the referenced (% style="color:#e74c3c" %)concept(%%) has the specified value for a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] anywhere within the report structure, the metadata report which contains that [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be matched. | ||
| 2216 | |RepresentationValue|CodeValueType|(% style="width:562px" %)RepresentationValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] having a particular value. This [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] only applies in the context of the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. So long as the value of any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] within the report structure which uses the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] has the value specified, any metadata report containing the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be matched. | ||
| 2217 | |MetadataTargetValue|MetadataTargetValueType|(% style="width:562px" %)MetadataTargetValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Reference metadata.WebHome]] target is used. All target object value conditions must be met to constitute a match. | ||
| 2218 | |ReportStructureValue|ReportStructureValueType|(% style="width:562px" %)ReportStructureValue is used to match particular [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] contained within the reference report. In this case, only metadata reports based on the referenced report structure which have the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values specified will be matched. | ||
| 2219 | |AttachmentConstraint|com: AttachmentConstraintReferenceType|(% style="width:562px" %)AttachmentConstraint references an attachment (% style="color:#e74c3c" %)constraint(%%) in order to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] which matches the effective metadata keys or metadata target regions defined in the (% style="color:#e74c3c" %)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. | ||
| 2220 | |AttachedObject|com: ObjectReferenceType|(% style="width:562px" %)AttachedObject is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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. | ||
| 2221 | |AttachedDataKey|com:DataKeyType|(% style="width:562px" %)AttachedDataKey is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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. | ||
| 2222 | |AttachedDataSet|com:SetReferenceType|(% style="width:562px" %)AttachedDataSet is used to query for [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] it is attached to, regardless of the report structure or metadata target in which the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is referenced. Any metadata reports attached to the supplied metadata key will be matched. | ||
| 2223 | |AttachedReportingPeriod|com: TimeRangeValueType|(% style="width:562px" %)AttachedReportingPeriod is used to query for [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the reporting period to which it is attached, regardless of the report structure or metadata target in which the [[reference period>>doc:sdmx:Glossary.Reference period.WebHome]] is referenced. Any metadata reports attached to a reporting period which falls within the range specified will be matched. | ||
| 2224 | |Or|MetadataParametersOr Type|(% style="width:562px" %)Or contains a collection of additional parameters, any one of which can be satisfied to result in a match. | ||
| 2225 | |And|MetadataParametersAndType|(% style="width:562px" %)And contains a collection of additional parameters, all of which must be satisfied to result in a match. | ||
| 2226 | |||
| 2227 | **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. | ||
| 2228 | |||
| 2229 | Derivation: | ||
| 2230 | |||
| 2231 | * //MetadataParametersType// (restriction) | ||
| 2232 | ** MetadataParametersOrType | ||
| 2233 | |||
| 2234 | Content: | ||
| 2235 | MetadataSetID*, DataProvider*, MetadataStructure*, [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]*, ProvisionAgreement*, [[Category>>doc:sdmx:Glossary.Category.WebHome]]*, Updated*, ConceptValue*, RepresentationValue*, MetadataTargetValue*, ReportStructureValue*, AttachmentConstraint*, AttachedObject*, AttachedDataKey*, AttachedDataSet*, AttachedReportingPeriod*, And* | ||
| 2236 | |||
| 2237 | Element Documentation: | ||
| 2238 | |||
| 2239 | (% style="width:1037.29px" %) | ||
| 2240 | |**Name**|**Type**|(% style="width:546px" %)**Documentation** | ||
| 2241 | |MetadataSetID|QueryIDType|(% style="width:546px" %)MetadataSetID is used to match the id of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. Only metadata reports from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] with an identifier satisfying these conditions will be matched. | ||
| 2242 | |DataProvider|com: DataProviderReferenceType|(% style="width:546px" %)DataProviderReference is used to match the provider of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]]. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] provided by the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] will be matched. | ||
| 2243 | |MetadataStructure|com: MetadataStructureReferenceType|(% style="width:546px" %)MetadataStructureReference is used to match the underlying structure of the data. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] that conform to [[referenced metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] structure definition will be matched. | ||
| 2244 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|com: MetadataflowReferenceType|(% style="width:546px" %)MetadataflowReference is used to match the flow which [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is reported against. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] report against [[referenced metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] flow will be matched. | ||
| 2245 | |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:546px" %)ProvisionAgreement is used to match the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] which metadata is reported against. Only metadata from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] report against the referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] will be matched. | ||
| 2246 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:546px" %)CategoryReference is used to match a [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the categorization of its underlying structure ([[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]), or the usage of that structure ([[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]]). Only metadata reports whose underlying structure or structure usage are categorized against the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]] will be matched. | ||
| 2247 | |Updated|com: TimeRangeValueType|(% style="width:546px" %)Updated is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on when it was last updated. Only metadata reports which satisfy the conditions for the last update parameters supplied here will be matched. | ||
| 2248 | |ConceptValue|ConceptValueType|(% style="width:546px" %)ConceptValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the value of a particular (% style="color:#e74c3c" %)concept(%%) which defines a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. So long as the referenced (% style="color:#e74c3c" %)concept(%%) has the specified value for a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] anywhere within the report structure, the metadata report which contains that [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be matched. | ||
| 2249 | |RepresentationValue|CodeValueType|(% style="width:546px" %)RepresentationValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] having a particular value. This [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] only applies in the context of the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. So long as the value of any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] within the report structure which uses the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] has the value specified, any metadata report containing the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be matched. | ||
| 2250 | |MetadataTargetValue|MetadataTargetValueType|(% style="width:546px" %)MetadataTargetValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Reference metadata.WebHome]] target is used. All target object value conditions must be met to constitute a match. | ||
| 2251 | |ReportStructureValue|ReportStructureValueType|(% style="width:546px" %)ReportStructureValue is used to match particular [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] contained within the reference report. In this case, only metadata reports based on the referenced report structure which have the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values specified will be matched. | ||
| 2252 | |AttachmentConstraint|com: AttachmentConstraintReferenceType|(% style="width:546px" %)AttachmentConstraint references an attachment (% style="color:#e74c3c" %)constraint(%%) in order to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] which matches the effective metadata keys or metadata target regions defined in the (% style="color:#e74c3c" %)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. | ||
| 2253 | |AttachedObject|com: ObjectReferenceType|(% style="width:546px" %)AttachedObject is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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. | ||
| 2254 | |AttachedDataKey|com:DataKeyType|(% style="width:546px" %)AttachedDataKey is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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. | ||
| 2255 | |AttachedDataSet|com:SetReferenceType|(% style="width:546px" %)AttachedDataSet is used to query for [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] it is attached to, regardless of the report structure or metadata target in which the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is referenced. Any metadata reports attached to the supplied metadata key will be matched. | ||
| 2256 | |AttachedReportingPeriod|com: TimeRangeValueType|(% style="width:546px" %)AttachedReportingPeriod is used to query for [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the reporting period to which it is attached, regardless of the report structure or metadata target in which the [[reference period>>doc:sdmx:Glossary.Reference period.WebHome]] is referenced. Any metadata reports attached to a reporting period which falls within the range specified will be matched. | ||
| 2257 | |And|MetadataParametersAndType|(% style="width:546px" %)And contains a collection of additional parameters, all of which must be satisfied to result in a match. | ||
| 2258 | |||
| 2259 | **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>>doc:sdmx:Glossary.Data set.WebHome]] identifier should be "xyz" and the data identifier should be "abc". | ||
| 2260 | |||
| 2261 | Derivation: | ||
| 2262 | |||
| 2263 | * //MetadataParametersType// (restriction) | ||
| 2264 | ** MetadataParametersAndType | ||
| 2265 | |||
| 2266 | Content: | ||
| 2267 | MetadataSetID?, DataProvider?, MetadataStructure?, [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]?, ProvisionAgreement*, [[Category>>doc:sdmx:Glossary.Category.WebHome]]*, Updated?, ConceptValue*, RepresentationValue*, MetadataTargetValue?, ReportStructureValue?, AttachmentConstraint*, AttachedObject*, AttachedDataKey?, AttachedDataSet?, AttachedReportingPeriod?, Or* | ||
| 2268 | |||
| 2269 | Element Documentation: | ||
| 2270 | |||
| 2271 | (% style="width:1096.29px" %) | ||
| 2272 | |**Name**|**Type**|(% style="width:618px" %)**Documentation** | ||
| 2273 | |MetadataSetID|QueryIDType|(% style="width:618px" %)MetadataSetID is used to match the id of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. Only metadata reports from [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] with an identifier satisfying these conditions will be matched. | ||
| 2274 | |DataProvider|com: DataProviderReferenceType|(% style="width:618px" %)DataProviderReference is used to match the provider of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]]. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] provided by the referenced [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] will be matched. | ||
| 2275 | |MetadataStructure|com: MetadataStructureReferenceType|(% style="width:618px" %)MetadataStructureReference is used to match the underlying structure of the data. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] that conform to [[referenced metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] structure definition will be matched. | ||
| 2276 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|com: MetadataflowReferenceType|(% style="width:618px" %)MetadataflowReference is used to match the flow which [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is reported against. Only metadata reports from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] report against [[referenced metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] flow will be matched. | ||
| 2277 | |ProvisionAgreement|com: ProvisionAgreementReferenceType|(% style="width:618px" %)ProvisionAgreement is used to match the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] which metadata is reported against. Only metadata from [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] report against the referenced [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] will be matched. | ||
| 2278 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|com: CategoryReferenceType|(% style="width:618px" %)CategoryReference is used to match a [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the categorization of its underlying structure ([[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]), or the usage of that structure ([[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]]). Only metadata reports whose underlying structure or structure usage are categorized against the referenced [[category>>doc:sdmx:Glossary.Category.WebHome]] will be matched. | ||
| 2279 | |Updated|com: TimeRangeValueType|(% style="width:618px" %)Updated is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on when it was last updated. Only metadata reports which satisfy the conditions for the last update parameters supplied here will be matched. | ||
| 2280 | |ConceptValue|ConceptValueType|(% style="width:618px" %)ConceptValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the value of a particular (% style="color:#e74c3c" %)concept(%%) which defines a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. So long as the referenced (% style="color:#e74c3c" %)concept(%%) has the specified value for a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] anywhere within the report structure, the metadata report which contains that [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be matched. | ||
| 2281 | |RepresentationValue|CodeValueType|(% style="width:618px" %)RepresentationValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] having a particular value. This [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] only applies in the context of the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. So long as the value of any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] within the report structure which uses the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] has the value specified, any metadata report containing the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be matched. | ||
| 2282 | |MetadataTargetValue|MetadataTargetValueType|(% style="width:618px" %)MetadataTargetValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Reference metadata.WebHome]] target is used. All target object value conditions must be met to constitute a match. | ||
| 2283 | |ReportStructureValue|ReportStructureValueType|(% style="width:618px" %)ReportStructureValue is used to match particular [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] contained within the reference report. In this case, only metadata reports based on the referenced report structure which have the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values specified will be matched. | ||
| 2284 | |AttachmentConstraint|com: AttachmentConstraintReferenceType|(% style="width:618px" %)AttachmentConstraint references an attachment (% style="color:#e74c3c" %)constraint(%%) in order to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] which matches the effective metadata keys or metadata target regions defined in the (% style="color:#e74c3c" %)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. | ||
| 2285 | |AttachedObject|com: ObjectReferenceType|(% style="width:618px" %)AttachedObject is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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. | ||
| 2286 | |AttachedDataKey|com:DataKeyType|(% style="width:618px" %)AttachedDataKey is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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. | ||
| 2287 | |AttachedDataSet|com:SetReferenceType|(% style="width:618px" %)AttachedDataSet is used to query for [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] it is attached to, regardless of the report structure or metadata target in which the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is referenced. Any metadata reports attached to the supplied metadata key will be matched. | ||
| 2288 | |AttachedReportingPer iod|com: TimeRangeValueType|(% style="width:618px" %)AttachedReportingPeriod is used to query for [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] based on the reporting period to which it is attached, regardless of the report structure or metadata target in which the [[reference period>>doc:sdmx:Glossary.Reference period.WebHome]] is referenced. Any metadata reports attached to a reporting period which falls within the range specified will be matched. | ||
| 2289 | |Or|MetadataParametersOrType|(% style="width:618px" %)Or contains a collection of additional parameters, any one of which can be satisfied to result in a match. | ||
| 2290 | |||
| 2291 | **MetadataTargetValueType: **MetadataTargetValueType describes the structure that is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Reference metadata.WebHome]] target is used. All target object value conditions must be met to constitute a match. | ||
| 2292 | |||
| 2293 | Content: | ||
| 2294 | ID, TargetObjectValue* | ||
| 2295 | |||
| 2296 | Element Documentation: | ||
| 2297 | |||
| 2298 | (% style="width:1056.29px" %) | ||
| 2299 | |**Name**|**Type**|(% style="width:560px" %)**Documentation** | ||
| 2300 | |ID|com:NCNameIDType|(% style="width:560px" %) | ||
| 2301 | |TargetObjectValue|TargetObjectValueTyp \e|(% style="width:560px" %)TargetObjectValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] where a given target object in a metadata target references a particular object or [[time period>>doc:sdmx:Glossary.Time period.WebHome]]. | ||
| 2302 | |||
| 2303 | **TargetObjectValueType: **IdentifierComponentValueType describes the structure that is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] where a given identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] has a particular value. | ||
| 2304 | |||
| 2305 | Content: | ||
| 2306 | ID, ([[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] | DataKey | Object | TimeValue[1..2]) | ||
| 2307 | |||
| 2308 | Element Documentation: | ||
| 2309 | |||
| 2310 | (% style="width:1054.29px" %) | ||
| 2311 | |**Name**|**Type**|(% style="width:580px" %)**Documentation** | ||
| 2312 | |ID|com:NCNameIDType|(% style="width:580px" %)ID identifies the metadata target object. | ||
| 2313 | |[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|com:SetReferenceType|(% style="width:580px" %)[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] provides a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] which the target object should reference to result in a match. | ||
| 2314 | |DataKey|com:DataKeyType|(% style="width:580px" %)DataKey provides a data key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values) which the target object should reference to result in a match. | ||
| 2315 | |Object|com: ObjectReferenceType|(% style="width:580px" %)Object provides a reference to any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiable object which the target object should reference to result in a match. | ||
| 2316 | |TimeValue|TimePeriodValueType|(% style="width:580px" %)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. | ||
| 2317 | |||
| 2318 | **ReportStructureValueType: **ReportStructureValueType describes the structure that is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] where the metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of a report structure have particular values. All metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value conditions must be met to constitute a match. | ||
| 2319 | |||
| 2320 | Content: | ||
| 2321 | ID, MetadataAttributeValue* | ||
| 2322 | |||
| 2323 | Element Documentation: | ||
| 2324 | |||
| 2325 | (% style="width:998.294px" %) | ||
| 2326 | |(% style="width:196px" %)**Name**|(% style="width:251px" %)**Type**|(% style="width:548px" %)**Documentation** | ||
| 2327 | |(% style="width:196px" %)ID|(% style="width:251px" %)com:NCNameIDType|(% style="width:548px" %) | ||
| 2328 | |(% style="width:196px" %)MetadataAttributeValue|(% style="width:251px" %)MetadataAttributeValueType|(% style="width:548px" %)MetadataAttributeValue is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] where a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a particular value within the referenced report structure. | ||
| 2329 | |||
| 2330 | **MetadataAttributeValueType: **MetadataAttributeValueType describes the structure that is used to match [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] where a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a particular value. Metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value queries can be nested for querying nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If no value is provided, then simply the presence of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] within the given context will result in a match. All nested metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value conditions must be met to constitute a match. | ||
| 2331 | |||
| 2332 | Content: | ||
| 2333 | ID, (Value | TextValue+ | NumericValue[1..2] | TimeValue[1..2])?, MetadataAttributeValue* | ||
| 2334 | |||
| 2335 | Element Documentation: | ||
| 2336 | |||
| 2337 | (% style="width:1036.29px" %) | ||
| 2338 | |**Name**|**Type**|(% style="width:632px" %)**Documentation** | ||
| 2339 | |ID|com:NCNameIDType|(% style="width:632px" %) | ||
| 2340 | |Value|SimpleValueType|(% style="width:632px" %)Value is used to query for the value of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. This should be used for (% style="color:#e74c3c" %)concepts(%%) or [[components>>doc:sdmx:Glossary.Component.WebHome]] based on a simple value (e.g. a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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. | ||
| 2341 | |TextValue|QueryTextType|(% style="width:632px" %)TextValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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>>doc:sdmx:Glossary.Component.WebHome]]. If only a simple equality check is necessary, regardless of language, the Value element can be used. | ||
| 2342 | |NumericValue|NumericValueType|(% style="width:632px" %)NumericValue is used to query for a the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 2343 | |TimeValue|TimePeriodValueType|(% style="width:632px" %)TimeValue is used to query for the value of a (% style="color:#e74c3c" %)concept(%%) or [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 2344 | |MetadataAttributeValue|MetadataAttributeValueType|(% style="width:632px" %) | ||
| 2345 | |||
| 2346 | **MetadataflowQueryType: **MetadataflowQueryType defines the structure of a [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] 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>>doc:sdmx:Glossary.Metadataflow.WebHome]] should be returned. | ||
| 2347 | |||
| 2348 | Derivation: | ||
| 2349 | |||
| 2350 | * //StructuralMetadataQueryType// (restriction) | ||
| 2351 | ** MetadataflowQueryType | ||
| 2352 | |||
| 2353 | Content: | ||
| 2354 | ReturnDetails, MetadataflowWhere | ||
| 2355 | |||
| 2356 | Element Documentation: | ||
| 2357 | |||
| 2358 | (% style="width:1015.29px" %) | ||
| 2359 | |**Name**|**Type**|(% style="width:623px" %)**Documentation** | ||
| 2360 | |ReturnDetails|MaintainableReturnDe tailsType|(% style="width:623px" %) | ||
| 2361 | |MetadataflowWhere|MetadataflowWhereType|(% style="width:623px" %)MetadataflowWhere contains the parameters for a [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] 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>>doc:sdmx:Glossary.Metadataflow.WebHome]] based on the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] it defines the usage of. | ||
| 2362 | |||
| 2363 | **MetadataflowWhereType: **MetadataflowWhereType contains the parameters of a [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 2364 | |||
| 2365 | Derivation: | ||
| 2366 | |||
| 2367 | * //AnnotableWhereType// (extension) | ||
| 2368 | ** //IdentifiableWhereType// (extension) | ||
| 2369 | *** //NameableWhereType// (extension) | ||
| 2370 | **** //VersionableWhereType// (extension) | ||
| 2371 | ***** //MaintainableWhereType// (extension) | ||
| 2372 | ****** //StructureUsageWhereType// (restriction) | ||
| 2373 | ******* MetadataflowWhereType | ||
| 2374 | |||
| 2375 | Attributes: | ||
| 2376 | type? | ||
| 2377 | |||
| 2378 | Content: | ||
| 2379 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure? | ||
| 2380 | |||
| 2381 | Attribute Documentation: | ||
| 2382 | |||
| 2383 | (% style="width:1107.29px" %) | ||
| 2384 | |**Name**|**Type**|(% style="width:641px" %)**Documentation** | ||
| 2385 | |type (fixed: [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]])|com: MaintainableTypeCodelistType|(% style="width:641px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2386 | |||
| 2387 | Element Documentation: | ||
| 2388 | |||
| 2389 | (% style="width:1101.29px" %) | ||
| 2390 | |**Name**|**Type**|(% style="width:706px" %)**Documentation** | ||
| 2391 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:706px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2392 | |URN|xs:anyURI|(% style="width:706px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2393 | |ID|QueryIDType|(% style="width:706px" %)ID is used to match the id of the identified object. | ||
| 2394 | |Name|QueryTextType|(% style="width:706px" %)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. | ||
| 2395 | |Description|QueryTextType|(% style="width:706px" %)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. | ||
| 2396 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:706px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2397 | |VersionTo|com: TimeRangeValueType|(% style="width:706px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2398 | |VersionFrom|com: TimeRangeValueType|(% style="width:706px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2399 | |VersionActive|xs:boolean|(% style="width:706px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2400 | |AgencyID|QueryNestedIDType|(% style="width:706px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2401 | |Structure|com: MetadataStructureReferenceType|(% style="width:706px" %)MetadataStructureReference is used to indicate which [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] the [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] must define a usage for in order to constitute a match. | ||
| 2402 | |||
| 2403 | **MetadataStructureQueryType: **MetadataStructureQueryType defines the structure of a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] 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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] should be returned. | ||
| 2404 | |||
| 2405 | Derivation: | ||
| 2406 | |||
| 2407 | * //StructuralMetadataQueryType// (restriction) | ||
| 2408 | ** MetadataStructureQueryType | ||
| 2409 | |||
| 2410 | Content: | ||
| 2411 | ReturnDetails, MetadataStructureWhere | ||
| 2412 | |||
| 2413 | Element Documentation: | ||
| 2414 | |||
| 2415 | (% style="width:1052.29px" %) | ||
| 2416 | |**Name**|**Type**|(% style="width:614px" %)**Documentation** | ||
| 2417 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:614px" %) | ||
| 2418 | |MetadataStructureWhere|MetadataStructureWhereType|(% style="width:614px" %)MetadataStructureWhere contains the parameters for a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] 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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. | ||
| 2419 | |||
| 2420 | **//MetadataStructureWhereBaseType//: **MetadataStructureWhereBaseType is an abstract base type the forms the basis for the MetadataStructureWhereType. | ||
| 2421 | |||
| 2422 | Derivation: | ||
| 2423 | |||
| 2424 | * //AnnotableWhereType// (extension) | ||
| 2425 | ** //IdentifiableWhereType// (extension) | ||
| 2426 | *** //NameableWhereType// (extension) | ||
| 2427 | **** //VersionableWhereType// (extension) | ||
| 2428 | ***** //MaintainableWhereType// (extension) | ||
| 2429 | ****** //StructureWhereType// (restriction) | ||
| 2430 | ******* //MetadataStructureWhereBaseType// | ||
| 2431 | |||
| 2432 | Attributes: | ||
| 2433 | type? | ||
| 2434 | |||
| 2435 | Content: | ||
| 2436 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation* | ||
| 2437 | |||
| 2438 | Attribute Documentation: | ||
| 2439 | |||
| 2440 | (% style="width:1116.29px" %) | ||
| 2441 | |**Name**|**Type**|(% style="width:617px" %)**Documentation** | ||
| 2442 | |type (fixed: MetadataStructure)|com: MaintainableTypeCodelistType|(% style="width:617px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2443 | |||
| 2444 | Element Documentation: | ||
| 2445 | |||
| 2446 | (% style="width:1113.29px" %) | ||
| 2447 | |**Name**|**Type**|(% style="width:711px" %)**Documentation** | ||
| 2448 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:711px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2449 | |URN|xs:anyURI|(% style="width:711px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2450 | |ID|QueryIDType|(% style="width:711px" %)ID is used to match the id of the identified object. | ||
| 2451 | |Name|QueryTextType|(% style="width:711px" %)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. | ||
| 2452 | |Description|QueryTextType|(% style="width:711px" %)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. | ||
| 2453 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:711px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2454 | |VersionTo|com: TimeRangeValueType|(% style="width:711px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2455 | |VersionFrom|com: TimeRangeValueType|(% style="width:711px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2456 | |VersionActive|xs:boolean|(% style="width:711px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2457 | |AgencyID|QueryNestedIDType|(% style="width:711px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2458 | |UsedConcept|com: ConceptReferenceType|(% style="width:711px" %)UsedConcept is used to query for a structure that uses the referenced (% style="color:#e74c3c" %)concept(%%) as the basis of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2459 | |UsedRepresentation|com: ItemSchemeReferenceType|(% style="width:711px" %)UsedRepresentation is used to query for a structure that uses the referenced [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2460 | |||
| 2461 | **MetadataStructureWhereType: **MetadataStructureWhereType defines the parameters of a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] query. In addition to querying based on the identification, it is also possible to search for [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] based on information about its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2462 | |||
| 2463 | Derivation: | ||
| 2464 | |||
| 2465 | * //AnnotableWhereType// (extension) | ||
| 2466 | ** //IdentifiableWhereType// (extension) | ||
| 2467 | *** //NameableWhereType// (extension) | ||
| 2468 | **** //VersionableWhereType// (extension) | ||
| 2469 | ***** //MaintainableWhereType// (extension) | ||
| 2470 | ****** //StructureWhereType// (restriction) | ||
| 2471 | ******* //MetadataStructureWhereBaseType// (extension) | ||
| 2472 | ******** MetadataStructureWhereType | ||
| 2473 | |||
| 2474 | Attributes: | ||
| 2475 | type? | ||
| 2476 | |||
| 2477 | Content: | ||
| 2478 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, MetadataTargetWhere*, TargetObjectWhere*, ReportStructureWhere*, MetadataAttributeWhere* | ||
| 2479 | |||
| 2480 | Attribute Documentation: | ||
| 2481 | |||
| 2482 | (% style="width:1074.29px" %) | ||
| 2483 | |**Name**|**Type**|(% style="width:575px" %)**Documentation** | ||
| 2484 | |type (fixed: MetadataStructure)|com: MaintainableTypeCodelistType|(% style="width:575px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2485 | |||
| 2486 | Element Documentation: | ||
| 2487 | |||
| 2488 | (% style="width:1076.29px" %) | ||
| 2489 | |**Name**|**Type**|(% style="width:648px" %)**Documentation** | ||
| 2490 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:648px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2491 | |URN|xs:anyURI|(% style="width:648px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2492 | |ID|QueryIDType|(% style="width:648px" %)ID is used to match the id of the identified object. | ||
| 2493 | |Name|QueryTextType|(% style="width:648px" %)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. | ||
| 2494 | |Description|QueryTextType|(% style="width:648px" %)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. | ||
| 2495 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:648px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2496 | |VersionTo|com: TimeRangeValueType|(% style="width:648px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2497 | |VersionFrom|com: TimeRangeValueType|(% style="width:648px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2498 | |VersionActive|xs:boolean|(% style="width:648px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2499 | |AgencyID|QueryNestedIDType|(% style="width:648px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2500 | |UsedConcept|com: ConceptReferenceType|(% style="width:648px" %)UsedConcept is used to query for a structure that uses the referenced (% style="color:#e74c3c" %)concept(%%) as the basis of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2501 | |UsedRepresentation|com: ItemSchemeReferenceType|(% style="width:648px" %)UsedRepresentation is used to query for a structure that uses the referenced [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of one of its [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2502 | |MetadataTargetWhere|MetadataTargetWhereType|(% style="width:648px" %)MetadataTargetWhere is used to query for a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] 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. | ||
| 2503 | |TargetObjectWhere|TargetObjectWhereType|(% style="width:648px" %)IdentifierComponentWhere is used to query for specific target identifiers or [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a contained identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 2504 | |ReportStructureWhere|ReportStructureWhereType|(% style="width:648px" %)ReportStructureWhere is used to query for [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a given report structure meets the conditions specified. A report structure can be queried based on identification or details about its metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 2505 | |MetadataAttributeWhere|MetadataAttributeWhereType|(% style="width:648px" %)MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a contained metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] meets the conditions specified. A metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] it uses as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. Nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] allow for the querying of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] explicitly at nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] query will be processed by querying metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at any (% style="color:#e74c3c" %)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. | ||
| 2506 | |||
| 2507 | **MetadataTargetWhereType: **MetadataTargetWhereType describes the structure that is used to query for [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] 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. | ||
| 2508 | |||
| 2509 | Derivation: | ||
| 2510 | |||
| 2511 | * //AnnotableWhereType// (extension) | ||
| 2512 | ** //IdentifiableWhereType// (extension) | ||
| 2513 | *** //ComponentListWhereType// (restriction) | ||
| 2514 | **** MetadataTargetWhereType | ||
| 2515 | |||
| 2516 | Content: | ||
| 2517 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, TargetObjectWhere* | ||
| 2518 | |||
| 2519 | Element Documentation: | ||
| 2520 | |||
| 2521 | (% style="width:1024.29px" %) | ||
| 2522 | |**Name**|**Type**|(% style="width:676px" %)**Documentation** | ||
| 2523 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:676px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2524 | |ID|QueryIDType|(% style="width:676px" %)ID is used to match the id of the identified object. | ||
| 2525 | |TargetObjectWhere|TargetObjectWhereType|(% style="width:676px" %)IdentifierComponentWhere is used to query for specific target identifiers or [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a contained identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] 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. | ||
| 2526 | |||
| 2527 | **//TargetObjectWhereBaseType//: **TargetObjectWhereBaseType is an abstract base type that forms the basis for the TargetObjectWhereType. | ||
| 2528 | |||
| 2529 | Derivation: | ||
| 2530 | |||
| 2531 | * //AnnotableWhereType// (extension) | ||
| 2532 | ** //IdentifiableWhereType// (extension) | ||
| 2533 | *** //ComponentWhereType// (restriction) | ||
| 2534 | **** //TargetObjectWhereBaseType// | ||
| 2535 | |||
| 2536 | Content: | ||
| 2537 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Enumeration? | ||
| 2538 | |||
| 2539 | Element Documentation: | ||
| 2540 | |||
| 2541 | (% style="width:1039.29px" %) | ||
| 2542 | |**Name**|**Type**|(% style="width:690px" %)**Documentation** | ||
| 2543 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:690px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2544 | |ID|QueryIDType|(% style="width:690px" %)ID is used to match the id of the identified object. | ||
| 2545 | |Enumeration|com: ItemSchemeReferenceType|(% style="width:690px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2546 | |||
| 2547 | **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>>doc:sdmx:Glossary.Data set.WebHome]] target, key descriptor values target, report period target, or identifiable object target), and in the case of an identifiable object target, an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which enumerates the possible values and/or the class of the target object reference. | ||
| 2548 | |||
| 2549 | Derivation: | ||
| 2550 | |||
| 2551 | * //AnnotableWhereType// (extension) | ||
| 2552 | ** //IdentifiableWhereType// (extension) | ||
| 2553 | *** //ComponentWhereType// (restriction) | ||
| 2554 | **** //TargetObjectWhereBaseType// (extension) | ||
| 2555 | ***** TargetObjectWhereType | ||
| 2556 | |||
| 2557 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2558 | type?, targetClass? | ||
| 2559 | |||
| 2560 | Content: | ||
| 2561 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Enumeration? | ||
| 2562 | |||
| 2563 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2564 | |||
| 2565 | (% style="width:1047.29px" %) | ||
| 2566 | |**Name**|(% style="width:278px" %)**Type**|(% style="width:636px" %)**Documentation** | ||
| 2567 | |type|(% style="width:278px" %)com: TargetObjectTypeCodelistType|(% style="width:636px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for a target object of a given type (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]] target, key descriptor values target, report period target, or identifiable object target) | ||
| 2568 | |targetClass|(% style="width:278px" %)com: ObjectTypeCodelistType|(% style="width:636px" %)The targetClass [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an identifiable object target based on the class its target object. | ||
| 2569 | |||
| 2570 | Element Documentation: | ||
| 2571 | |||
| 2572 | (% style="width:1045.29px" %) | ||
| 2573 | |**Name**|**Type**|(% style="width:692px" %)**Documentation** | ||
| 2574 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:692px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2575 | |ID|QueryIDType|(% style="width:692px" %)ID is used to match the id of the identified object. | ||
| 2576 | |Enumeration|com: ItemSchemeReferenceType|(% style="width:692px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2577 | |||
| 2578 | **ReportStructureWhereType: **ReportStructureWhereType defines the parameters for matching based on the details of a report structure. This is used to query for [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a given report structure meets the conditions specified. A report structure can be queried based on identification and details about its metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match. | ||
| 2579 | |||
| 2580 | Derivation: | ||
| 2581 | |||
| 2582 | * //AnnotableWhereType// (extension) | ||
| 2583 | ** //IdentifiableWhereType// (extension) | ||
| 2584 | *** //ComponentListWhereType// (restriction) | ||
| 2585 | **** ReportStructureWhereType | ||
| 2586 | |||
| 2587 | Content: | ||
| 2588 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, MetadataAttributeWhere* | ||
| 2589 | |||
| 2590 | Element Documentation: | ||
| 2591 | |||
| 2592 | (% style="width:1082.29px" %) | ||
| 2593 | |**Name**|**Type**|(% style="width:663px" %)**Documentation** | ||
| 2594 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:663px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2595 | |ID|QueryIDType|(% style="width:663px" %)ID is used to match the id of the identified object. | ||
| 2596 | |MetadataAttributeWhere|MetadataAttributeWhereType|(% style="width:663px" %)MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a contained metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] meets the conditions specified. A metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] it uses as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. Nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] allow for the querying of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] explicitly at nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] query will be processed by querying metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at any (% style="color:#e74c3c" %)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. | ||
| 2597 | |||
| 2598 | **//MetadataAttributeWhereBaseType//: **MetadataAttributeWhereBaseType is an abstract base type that forms the basis for the MetadataAttributeWhereType. | ||
| 2599 | |||
| 2600 | Derivation: | ||
| 2601 | |||
| 2602 | * //AnnotableWhereType// (extension) | ||
| 2603 | ** //IdentifiableWhereType// (extension) | ||
| 2604 | *** //ComponentWhereType// (restriction) | ||
| 2605 | **** //MetadataAttributeWhereBaseType// | ||
| 2606 | |||
| 2607 | Content: | ||
| 2608 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Enumeration? | ||
| 2609 | |||
| 2610 | Element Documentation: | ||
| 2611 | |||
| 2612 | (% style="width:1131.29px" %) | ||
| 2613 | |**Name**|**Type**|(% style="width:809px" %)**Documentation** | ||
| 2614 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:809px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2615 | |ID|QueryIDType|(% style="width:809px" %)ID is used to match the id of the identified object. | ||
| 2616 | |Enumeration|com: CodelistReferenceType|(% style="width:809px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2617 | |||
| 2618 | **MetadataAttributeWhereType: **MetadataAttributeWhereType describes the parameters for a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. A metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] it uses as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. Nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] allow for the querying of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] explicitly at nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] query will be processed by querying metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at any (% style="color:#e74c3c" %)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. | ||
| 2619 | |||
| 2620 | Derivation: | ||
| 2621 | |||
| 2622 | * //AnnotableWhereType// (extension) | ||
| 2623 | ** //IdentifiableWhereType// (extension) | ||
| 2624 | *** //ComponentWhereType// (restriction) | ||
| 2625 | **** //MetadataAttributeWhereBaseType// (extension) | ||
| 2626 | ***** MetadataAttributeWhereType | ||
| 2627 | |||
| 2628 | Content: | ||
| 2629 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Enumeration?, MetadataAttributeWhere* | ||
| 2630 | |||
| 2631 | Element Documentation: | ||
| 2632 | |||
| 2633 | (% style="width:1100.29px" %) | ||
| 2634 | |**Name**|**Type**|(% style="width:681px" %)**Documentation** | ||
| 2635 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:681px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2636 | |ID|QueryIDType|(% style="width:681px" %)ID is used to match the id of the identified object. | ||
| 2637 | |Enumeration|com: CodelistReferenceType|(% style="width:681px" %)Enumeration is used to query for a structure [[component>>doc:sdmx:Glossary.Component.WebHome]] based on the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that is used as the enumeration for its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This enumeration may be explicit defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), or inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (i.e. the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2638 | |MetadataAttributeWhere|MetadataAttributeWhereType|(% style="width:681px" %)MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] where a contained metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] meets the conditions specified. A metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be queried based on its identification, the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic, and an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] it uses as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. Nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] allow for the querying of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] explicitly at nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] query will be processed by querying metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at any (% style="color:#e74c3c" %)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. | ||
| 2639 | |||
| 2640 | **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. | ||
| 2641 | |||
| 2642 | Derivation: | ||
| 2643 | |||
| 2644 | * //StructuralMetadataQueryType// (restriction) | ||
| 2645 | ** OrganisationSchemeQueryType | ||
| 2646 | |||
| 2647 | Content: | ||
| 2648 | ReturnDetails, OrganisationSchemeWhere | ||
| 2649 | |||
| 2650 | Element Documentation: | ||
| 2651 | |||
| 2652 | (% style="width:1020.29px" %) | ||
| 2653 | |**Name**|**Type**|(% style="width:595px" %)**Documentation** | ||
| 2654 | |ReturnDetails|StructureReturnDetai lsType|(% style="width:595px" %) | ||
| 2655 | |OrganisationSchemeWhere|OrganisationSchemeWhereType|(% style="width:595px" %)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. | ||
| 2656 | |||
| 2657 | **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. | ||
| 2658 | |||
| 2659 | Derivation: | ||
| 2660 | |||
| 2661 | * //AnnotableWhereType// (extension) | ||
| 2662 | ** //IdentifiableWhereType// (extension) | ||
| 2663 | *** //NameableWhereType// (extension) | ||
| 2664 | **** //VersionableWhereType// (extension) | ||
| 2665 | ***** //MaintainableWhereType// (extension) | ||
| 2666 | ****** //ItemSchemeWhereType// (restriction) | ||
| 2667 | ******* OrganisationSchemeWhereType | ||
| 2668 | |||
| 2669 | Attributes: | ||
| 2670 | type? | ||
| 2671 | |||
| 2672 | Content: | ||
| 2673 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, OrganisationWhere* | ||
| 2674 | |||
| 2675 | Attribute Documentation: | ||
| 2676 | |||
| 2677 | (% style="width:1062.29px" %) | ||
| 2678 | |**Name**|**Type**|(% style="width:558px" %)**Documentation** | ||
| 2679 | |type (default: OrganisationScheme)|OrganisationSchemeTypeCodeType|(% style="width:558px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of organisation scheme which is being queried for, with the default being any organisation scheme. Note that agency, [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]], and [[data provider scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]] all have fixed identifiers and (% style="color:#e74c3c" %)versions(%%), so specifying these types with parameters for the identifier and/or (% style="color:#e74c3c" %)version(%%) which do not match these fixed values will never return a result. | ||
| 2680 | |||
| 2681 | Element Documentation: | ||
| 2682 | |||
| 2683 | (% style="width:1059.29px" %) | ||
| 2684 | |**Name**|**Type**|(% style="width:702px" %)**Documentation** | ||
| 2685 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:702px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2686 | |URN|xs:anyURI|(% style="width:702px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2687 | |ID|QueryIDType|(% style="width:702px" %)ID is used to match the id of the identified object. | ||
| 2688 | |Name|QueryTextType|(% style="width:702px" %)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. | ||
| 2689 | |Description|QueryTextType|(% style="width:702px" %)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. | ||
| 2690 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:702px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2691 | |VersionTo|com: TimeRangeValueType|(% style="width:702px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2692 | |VersionFrom|com: TimeRangeValueType|(% style="width:702px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2693 | |VersionActive|xs:boolean|(% style="width:702px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2694 | |AgencyID|QueryNestedIDType|(% style="width:702px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2695 | |OrganisationWhere|OrganisationWhereType|(% style="width:702px" %)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. | ||
| 2696 | |||
| 2697 | **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. | ||
| 2698 | |||
| 2699 | Derivation: | ||
| 2700 | |||
| 2701 | * //AnnotableWhereType// (extension) | ||
| 2702 | ** //IdentifiableWhereType// (extension) | ||
| 2703 | *** //NameableWhereType// (extension) | ||
| 2704 | **** //ItemWhereType// (restriction) | ||
| 2705 | ***** OrganisationWhereType | ||
| 2706 | |||
| 2707 | Content: | ||
| 2708 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, Parent? | ||
| 2709 | |||
| 2710 | Element Documentation: | ||
| 2711 | |||
| 2712 | (% style="width:1092.29px" %) | ||
| 2713 | |**Name**|**Type**|(% style="width:688px" %)**Documentation** | ||
| 2714 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:688px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2715 | |ID|QueryIDType|(% style="width:688px" %)ID is used to match the id of the identified object. | ||
| 2716 | |Name|QueryTextType|(% style="width:688px" %)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. | ||
| 2717 | |Description|QueryTextType|(% style="width:688px" %)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. | ||
| 2718 | |Parent|com: LocalOrganisationUnitReferenceType|(% style="width:688px" %)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. | ||
| 2719 | |||
| 2720 | **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. | ||
| 2721 | |||
| 2722 | Derivation: | ||
| 2723 | |||
| 2724 | * //StructuralMetadataQueryType// (restriction) | ||
| 2725 | ** ProcessQueryType | ||
| 2726 | |||
| 2727 | Content: | ||
| 2728 | ReturnDetails, ProcessWhere | ||
| 2729 | |||
| 2730 | Element Documentation: | ||
| 2731 | |||
| 2732 | (% style="width:1051.29px" %) | ||
| 2733 | |**Name**|**Type**|(% style="width:707px" %)**Documentation** | ||
| 2734 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:707px" %) | ||
| 2735 | |ProcessWhere|ProcessWhereType|(% style="width:707px" %)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. | ||
| 2736 | |||
| 2737 | **//ProcessWhereBaseType//: **ProcessWhereBaseType is an abstract base type which forms the basis for the ProcessWhereType. | ||
| 2738 | |||
| 2739 | Derivation: | ||
| 2740 | |||
| 2741 | * //AnnotableWhereType// (extension) | ||
| 2742 | ** //IdentifiableWhereType// (extension) | ||
| 2743 | *** //NameableWhereType// (extension) | ||
| 2744 | **** //VersionableWhereType// (extension) | ||
| 2745 | ***** //MaintainableWhereType// (restriction) | ||
| 2746 | ****** //ProcessWhereBaseType// | ||
| 2747 | |||
| 2748 | Attributes: | ||
| 2749 | type? | ||
| 2750 | |||
| 2751 | Content: | ||
| 2752 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 2753 | |||
| 2754 | Attribute Documentation: | ||
| 2755 | |||
| 2756 | (% style="width:1042.29px" %) | ||
| 2757 | |**Name**|**Type**|(% style="width:609px" %)**Documentation** | ||
| 2758 | |type (fixed: Process)|com: MaintainableTypeCodelistType|(% style="width:609px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2759 | |||
| 2760 | Element Documentation: | ||
| 2761 | |||
| 2762 | (% style="width:1041.29px" %) | ||
| 2763 | |**Name**|**Type**|(% style="width:724px" %)**Documentation** | ||
| 2764 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:724px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2765 | |URN|xs:anyURI|(% style="width:724px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2766 | |ID|QueryIDType|(% style="width:724px" %)ID is used to match the id of the identified object. | ||
| 2767 | |Name|QueryTextType|(% style="width:724px" %)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. | ||
| 2768 | |Description|QueryTextType|(% style="width:724px" %)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. | ||
| 2769 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:724px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2770 | |VersionTo|com: TimeRangeValueType|(% style="width:724px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2771 | |VersionFrom|com: TimeRangeValueType|(% style="width:724px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2772 | |VersionActive|xs:boolean|(% style="width:724px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2773 | |AgencyID|QueryNestedIDType|(% style="width:724px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2774 | |||
| 2775 | **ProcessWhereType: **ProcessWhereType defines the parameters of a process query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 2776 | |||
| 2777 | Derivation: | ||
| 2778 | |||
| 2779 | * //AnnotableWhereType// (extension) | ||
| 2780 | ** //IdentifiableWhereType// (extension) | ||
| 2781 | *** //NameableWhereType// (extension) | ||
| 2782 | **** //VersionableWhereType// (extension) | ||
| 2783 | ***** //MaintainableWhereType// (restriction) | ||
| 2784 | ****** //ProcessWhereBaseType// (extension) | ||
| 2785 | ******* ProcessWhereType | ||
| 2786 | |||
| 2787 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2788 | type? | ||
| 2789 | |||
| 2790 | Content: | ||
| 2791 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ProcessStepWhere* | ||
| 2792 | |||
| 2793 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2794 | |||
| 2795 | (% style="width:1056.29px" %) | ||
| 2796 | |**Name**|**Type**|(% style="width:624px" %)**Documentation** | ||
| 2797 | |type (fixed: Process)|com: MaintainableTypeCodelistType|(% style="width:624px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2798 | |||
| 2799 | Element Documentation: | ||
| 2800 | |||
| 2801 | (% style="width:1055.29px" %) | ||
| 2802 | |**Name**|**Type**|(% style="width:695px" %)**Documentation** | ||
| 2803 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:695px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2804 | |URN|xs:anyURI|(% style="width:695px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2805 | |ID|QueryIDType|(% style="width:695px" %)ID is used to match the id of the identified object. | ||
| 2806 | |Name|QueryTextType|(% style="width:695px" %)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. | ||
| 2807 | |Description|QueryTextType|(% style="width:695px" %)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. | ||
| 2808 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:695px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2809 | |VersionTo|com: TimeRangeValueType|(% style="width:695px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2810 | |VersionFrom|com: TimeRangeValueType|(% style="width:695px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2811 | |VersionActive|xs:boolean|(% style="width:695px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2812 | |AgencyID|QueryNestedIDType|(% style="width:695px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2813 | |ProcessStepWhere|ProcessStepWhereType|(% style="width:695px" %)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 (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) step will always result in a search for process steps at any (% style="color:#e74c3c" %)level(%%). This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match. | ||
| 2814 | |||
| 2815 | **ProcessStepWhereType: **ProcessStepWhereType defines a set of parameters for matching a [[category>>doc:sdmx:Glossary.Category.WebHome]]. 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. | ||
| 2816 | |||
| 2817 | Derivation: | ||
| 2818 | |||
| 2819 | * //AnnotableWhereType// (extension) | ||
| 2820 | ** //IdentifiableWhereType// (extension) | ||
| 2821 | *** ProcessStepWhereType | ||
| 2822 | |||
| 2823 | Content: | ||
| 2824 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, InputOrOutputObject*, ProcessStepWhere* | ||
| 2825 | |||
| 2826 | Element Documentation: | ||
| 2827 | |||
| 2828 | (% style="width:1014.29px" %) | ||
| 2829 | |**Name**|**Type**|(% style="width:593px" %)**Documentation** | ||
| 2830 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:593px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2831 | |URN|xs:anyURI|(% style="width:593px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2832 | |ID|QueryIDType|(% style="width:593px" %)ID is used to match the id of the identified object. | ||
| 2833 | |InputOrOutputObject|InputOrOutputObjectType|(% style="width:593px" %)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. | ||
| 2834 | |ProcessStepWhere|ProcessStepWhereType|(% style="width:593px" %)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. | ||
| 2835 | |||
| 2836 | **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>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object should be an input, output, or either of the two to the step. | ||
| 2837 | |||
| 2838 | Attributes: | ||
| 2839 | type? | ||
| 2840 | |||
| 2841 | Content: | ||
| 2842 | ObjectReference | ||
| 2843 | |||
| 2844 | Attribute Documentation: | ||
| 2845 | |||
| 2846 | (% style="width:1074.29px" %) | ||
| 2847 | |**Name**|**Type**|(% style="width:582px" %)**Documentation** | ||
| 2848 | |type (default: Any)|InputOutputTypeCodeType|(% style="width:582px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2849 | |||
| 2850 | Element Documentation: | ||
| 2851 | |||
| 2852 | (% style="width:1071.29px" %) | ||
| 2853 | |**Name**|(% style="width:219px" %)**Type**|(% style="width:637px" %)**Documentation** | ||
| 2854 | |ObjectReference|(% style="width:219px" %)com: ObjectReferenceType|(% style="width:637px" %)ObjectReference is used to query for a process containing process steps where the referenced object is input or output to the process step. | ||
| 2855 | |||
| 2856 | **ProvisionAgreementQueryType: **ProvisionAgreementQueryType defines the structure of a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] 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>>doc:sdmx:Glossary.Provision agreement.WebHome]] should be returned. | ||
| 2857 | |||
| 2858 | Derivation: | ||
| 2859 | |||
| 2860 | * //StructuralMetadataQueryType// (restriction) | ||
| 2861 | ** ProvisionAgreementQueryType | ||
| 2862 | |||
| 2863 | Content: | ||
| 2864 | ReturnDetails, ProvisionAgreementWhere | ||
| 2865 | |||
| 2866 | Element Documentation: | ||
| 2867 | |||
| 2868 | (% style="width:1112.29px" %) | ||
| 2869 | |**Name**|**Type**|(% style="width:658px" %)**Documentation** | ||
| 2870 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:658px" %) | ||
| 2871 | |ProvisionAgreementWhere|ProvisionAgreementWhereType|(% style="width:658px" %)ProvisionAgreementWhere contains the parameters for a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] 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>>doc:sdmx:Glossary.Provision agreement.WebHome]] based on the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] and the structure usage it pairs. | ||
| 2872 | |||
| 2873 | **//ProvisionAgreementWhereBaseType//: **ProvisionAgreementWhereBaseType is an abstract base type which forms the basis for the ProvisionAgreementWhereType. | ||
| 2874 | |||
| 2875 | Derivation: | ||
| 2876 | |||
| 2877 | * //AnnotableWhereType// (extension) | ||
| 2878 | ** //IdentifiableWhereType// (extension) | ||
| 2879 | *** //NameableWhereType// (extension) | ||
| 2880 | **** //VersionableWhereType// (extension) | ||
| 2881 | ***** //MaintainableWhereType// (restriction) | ||
| 2882 | ****** //ProvisionAgreementWhereBaseType// | ||
| 2883 | |||
| 2884 | Attributes: | ||
| 2885 | type? | ||
| 2886 | |||
| 2887 | Content: | ||
| 2888 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 2889 | |||
| 2890 | Attribute Documentation: | ||
| 2891 | |||
| 2892 | (% style="width:1093.29px" %) | ||
| 2893 | |**Name**|**Type**|(% style="width:444px" %)**Documentation** | ||
| 2894 | |type (fixed: ProvisionAgreement)|com: MaintainableTypeCodelistType|(% style="width:444px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 2895 | |||
| 2896 | Element Documentation: | ||
| 2897 | |||
| 2898 | (% style="width:1090.29px" %) | ||
| 2899 | |**Name**|**Type**|(% style="width:773px" %)**Documentation** | ||
| 2900 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:773px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2901 | |URN|xs:anyURI|(% style="width:773px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2902 | |ID|QueryIDType|(% style="width:773px" %)ID is used to match the id of the identified object. | ||
| 2903 | |Name|QueryTextType|(% style="width:773px" %)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. | ||
| 2904 | |Description|QueryTextType|(% style="width:773px" %)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. | ||
| 2905 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:773px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2906 | |VersionTo|com: TimeRangeValueType|(% style="width:773px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2907 | |VersionFrom|com: TimeRangeValueType|(% style="width:773px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2908 | |VersionActive|xs:boolean|(% style="width:773px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2909 | |AgencyID|QueryNestedIDType|(% style="width:773px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2910 | |||
| 2911 | **ProvisionAgreementWhereType: **ProvisionAgreementWhereType defines the parameters of a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 2912 | |||
| 2913 | Derivation: | ||
| 2914 | |||
| 2915 | * //AnnotableWhereType// (extension) | ||
| 2916 | ** //IdentifiableWhereType// (extension) | ||
| 2917 | *** //NameableWhereType// (extension) | ||
| 2918 | **** //VersionableWhereType// (extension) | ||
| 2919 | ***** //MaintainableWhereType// (restriction) | ||
| 2920 | ****** //ProvisionAgreementWhereBaseType// (extension) | ||
| 2921 | ******* ProvisionAgreementWhereType | ||
| 2922 | |||
| 2923 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2924 | type? | ||
| 2925 | |||
| 2926 | Content: | ||
| 2927 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, StructureUsage?, DataProvider? | ||
| 2928 | |||
| 2929 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2930 | |||
| 2931 | (% style="width:1142.29px" %) | ||
| 2932 | |(% style="width:258px" %)**Name**|(% style="width:292px" %)**Type**|(% style="width:589px" %)**Documentation** | ||
| 2933 | |(% style="width:258px" %)type (fixed: ProvisionAgreement)|(% style="width:292px" %)com: MaintainableTypeCodelistType|(% style="width:589px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 2934 | |||
| 2935 | Element Documentation: | ||
| 2936 | |||
| 2937 | (% style="width:1136.29px" %) | ||
| 2938 | |**Name**|**Type**|(% style="width:747px" %)**Documentation** | ||
| 2939 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:747px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2940 | |URN|xs:anyURI|(% style="width:747px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2941 | |ID|QueryIDType|(% style="width:747px" %)ID is used to match the id of the identified object. | ||
| 2942 | |Name|QueryTextType|(% style="width:747px" %)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. | ||
| 2943 | |Description|QueryTextType|(% style="width:747px" %)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. | ||
| 2944 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:747px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 2945 | |VersionTo|com: TimeRangeValueType|(% style="width:747px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2946 | |VersionFrom|com: TimeRangeValueType|(% style="width:747px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 2947 | |VersionActive|xs:boolean|(% style="width:747px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 2948 | |AgencyID|QueryNestedIDType|(% style="width:747px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 2949 | |StructureUsage|com: StructureUsageReferenceType|(% style="width:747px" %)StructureUsage is used to indicate which structure usage the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must reference in order to constitute a match. | ||
| 2950 | |DataProvider|com: DataProviderReferenceType|(% style="width:747px" %)DataProvider is used to indicate which [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must reference in order to constitute a match. | ||
| 2951 | |||
| 2952 | **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. | ||
| 2953 | |||
| 2954 | Derivation: | ||
| 2955 | |||
| 2956 | * //StructuralMetadataQueryType// (restriction) | ||
| 2957 | ** ReportingTaxonomyQueryType | ||
| 2958 | |||
| 2959 | Content: | ||
| 2960 | ReturnDetails, ReportingTaxonomyWhere | ||
| 2961 | |||
| 2962 | Element Documentation: | ||
| 2963 | |||
| 2964 | (% style="width:1050.29px" %) | ||
| 2965 | |**Name**|**Type**|(% style="width:599px" %)**Documentation** | ||
| 2966 | |ReturnDetails|StructureReturnDetai lsType|(% style="width:599px" %) | ||
| 2967 | |ReportingTaxonomyWhere|ReportingTaxonomyWhereType|(% style="width:599px" %)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>>doc:sdmx:Glossary.Reporting category.WebHome]]. In any case, the reporting taxonomy will be returned according the indicated return detail. | ||
| 2968 | |||
| 2969 | **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>>doc:sdmx:Glossary.Reporting category.WebHome]], and on the root (% style="color:#e74c3c" %)level(%%) structure definitions of the taxonomy. | ||
| 2970 | |||
| 2971 | Derivation: | ||
| 2972 | |||
| 2973 | * //AnnotableWhereType// (extension) | ||
| 2974 | ** //IdentifiableWhereType// (extension) | ||
| 2975 | *** //NameableWhereType// (extension) | ||
| 2976 | **** //VersionableWhereType// (extension) | ||
| 2977 | ***** //MaintainableWhereType// (extension) | ||
| 2978 | ****** //ItemSchemeWhereType// (restriction) | ||
| 2979 | ******* ReportingTaxonomyWhereType | ||
| 2980 | |||
| 2981 | Attributes: | ||
| 2982 | type? | ||
| 2983 | |||
| 2984 | Content: | ||
| 2985 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ReportingCategoryWhere* | ||
| 2986 | |||
| 2987 | Attribute Documentation: | ||
| 2988 | |||
| 2989 | (% style="width:1185.29px" %) | ||
| 2990 | |**Name**|**Type**|(% style="width:676px" %)**Documentation** | ||
| 2991 | |type (fixed: ReportingTaxonomy)|com: MaintainableTypeCodelistType|(% style="width:676px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2992 | |||
| 2993 | Element Documentation: | ||
| 2994 | |||
| 2995 | (% style="width:1113.29px" %) | ||
| 2996 | |**Name**|**Type**|(% style="width:678px" %)**Documentation** | ||
| 2997 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:678px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 2998 | |URN|xs:anyURI|(% style="width:678px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 2999 | |ID|QueryIDType|(% style="width:678px" %)ID is used to match the id of the identified object. | ||
| 3000 | |Name|QueryTextType|(% style="width:678px" %)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. | ||
| 3001 | |Description|QueryTextType|(% style="width:678px" %)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. | ||
| 3002 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:678px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3003 | |VersionTo|com: TimeRangeValueType|(% style="width:678px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3004 | |VersionFrom|com: TimeRangeValueType|(% style="width:678px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3005 | |VersionActive|xs:boolean|(% style="width:678px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3006 | |AgencyID|QueryNestedIDType|(% style="width:678px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3007 | |ReportingCategoryWhere|ReportingCategoryWhereType|(% style="width:678px" %)ReportingCategoryWhere is used to query for [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] matching the parameters supplied. It allows for nested reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] queries so that hierarchical [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] can be queried explicitly by their nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] will always result in a search for [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] at any (% style="color:#e74c3c" %)level(%%). This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match. | ||
| 3008 | |||
| 3009 | **//ReportingCategoryWhereBaseType//: **ReportingCategoryWhereBaseType is an abstract base type that forms the basis for the ReportingCategoryQueryType. | ||
| 3010 | |||
| 3011 | Derivation: | ||
| 3012 | |||
| 3013 | * //AnnotableWhereType// (extension) | ||
| 3014 | ** //IdentifiableWhereType// (extension) | ||
| 3015 | *** //NameableWhereType// (extension) | ||
| 3016 | **** //ItemWhereType// (restriction) | ||
| 3017 | ***** //ReportingCategoryWhereBaseType// | ||
| 3018 | |||
| 3019 | Content: | ||
| 3020 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, ReportingCategoryWhere* | ||
| 3021 | |||
| 3022 | Element Documentation: | ||
| 3023 | |||
| 3024 | (% style="width:1023.29px" %) | ||
| 3025 | |**Name**|**Type**|(% style="width:616px" %)**Documentation** | ||
| 3026 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:616px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3027 | |ID|QueryIDType|(% style="width:616px" %)ID is used to match the id of the identified object. | ||
| 3028 | |Name|QueryTextType|(% style="width:616px" %)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. | ||
| 3029 | |Description|QueryTextType|(% style="width:616px" %)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. | ||
| 3030 | |ReportingCategoryWhere|ReportingCategoryWhereType|(% style="width:616px" %)ReportingCategoryWhere is used to query for [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] matching the parameters supplied. It allows for nested reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] queries so that hierarchical [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] can be queried explicitly by their nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] will always result in a search for [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] at any (% style="color:#e74c3c" %)level(%%). This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match. | ||
| 3031 | |||
| 3032 | **ReportingCategoryWhereType: **ReportingCategoryWhereType contains a set of parameters for matching a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]]. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 3033 | |||
| 3034 | Derivation: | ||
| 3035 | |||
| 3036 | * //AnnotableWhereType// (extension) | ||
| 3037 | ** //IdentifiableWhereType// (extension) | ||
| 3038 | *** //NameableWhereType// (extension) | ||
| 3039 | **** //ItemWhereType// (restriction) | ||
| 3040 | ***** //ReportingCategoryWhereBaseType// (extension) | ||
| 3041 | ****** ReportingCategoryWhereType | ||
| 3042 | |||
| 3043 | Content: | ||
| 3044 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, ReportingCategoryWhere*, (ProvisioningMetadata* | StructuralMetadata*) | ||
| 3045 | |||
| 3046 | Element Documentation: | ||
| 3047 | |||
| 3048 | (% style="width:1127.29px" %) | ||
| 3049 | |**Name**|**Type**|(% style="width:676px" %)**Documentation** | ||
| 3050 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:676px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3051 | |ID|QueryIDType|(% style="width:676px" %)ID is used to match the id of the identified object. | ||
| 3052 | |Name|QueryTextType|(% style="width:676px" %)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. | ||
| 3053 | |Description|QueryTextType|(% style="width:676px" %)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. | ||
| 3054 | |ReportingCategoryWhe re|ReportingCategoryWhereType|(% style="width:676px" %)ReportingCategoryWhere is used to query for [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] matching the parameters supplied. It allows for nested reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] queries so that hierarchical [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] can be queried explicitly by their nested (% style="color:#e74c3c" %)level(%%), although a top (% style="color:#e74c3c" %)level(%%) reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] will always result in a search for [[reporting categories>>doc:sdmx:Glossary.Reporting category.WebHome]] at any (% style="color:#e74c3c" %)level(%%). This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match. | ||
| 3055 | |ProvisioningMetadata|com: StructureUsageReferenceType|(% style="width:676px" %)ProvisioningMetadata is used to query for a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] where the structure usages referenced are referenced by the reporting [[category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 3056 | |StructuralMetadata|com: StructureReferenceType|(% style="width:676px" %)StructuralMetadata is used to query for a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]] where the structures referenced are referenced by the reporting [[category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 3057 | |||
| 3058 | **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. | ||
| 3059 | |||
| 3060 | Content: | ||
| 3061 | DataStructure | ||
| 3062 | |||
| 3063 | Element Documentation: | ||
| 3064 | |||
| 3065 | (% style="width:1052.29px" %) | ||
| 3066 | |**Name**|**Type**|(% style="width:723px" %)**Documentation** | ||
| 3067 | |DataStructure|DataStructureRequestType|(% style="width:723px" %)DataStructure references a data structure either explicitly or through a usage ([[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]) or agreement based on the flow ([[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]). An observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] must be specifies as well as indicators for using explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]], deriving the type from the time series specific [[data set>>doc:sdmx:Glossary.Data set.WebHome]], and processing (% style="color:#e74c3c" %)constraints(%%). The explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is only applicable if the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]; otherwise the value provided will be ignored. The time series option is only applicable if the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]; otherwise the value provided will be ignored. (% style="color:#e74c3c" %)Constraints(%%) will only be applied in the returned schemas if specifically requested. This means that even if the request specifies a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], the returned schema will not take into account the (% style="color:#e74c3c" %)constraints(%%) on that agreement unless the request explicitly requests this. | ||
| 3068 | |||
| 3069 | **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. | ||
| 3070 | |||
| 3071 | Content: | ||
| 3072 | MetadataStructure | ||
| 3073 | |||
| 3074 | Element Documentation: | ||
| 3075 | |||
| 3076 | (% style="width:1105.29px" %) | ||
| 3077 | |**Name**|(% style="width:282px" %)**Type**|(% style="width:619px" %)**Documentation** | ||
| 3078 | |MetadataStructure|(% style="width:282px" %)com: GenericMetadataStructureType|(% style="width:619px" %)MetadataStructure references a metadata structure either explicitly or through it usage ([[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]) or an application of that usage ([[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]). | ||
| 3079 | |||
| 3080 | **DataStructureRequestType: **DataStructureRequestType extends the base DataStructureRequestType to add additional parameters that are necessary when querying for a schema. | ||
| 3081 | |||
| 3082 | Derivation: | ||
| 3083 | |||
| 3084 | * //com:PayloadStructureType// (restriction) | ||
| 3085 | ** //com:DataStructureType// (restriction) | ||
| 3086 | *** com:DataStructureRequestType (extension) | ||
| 3087 | **** DataStructureRequestType | ||
| 3088 | |||
| 3089 | Attributes: | ||
| 3090 | structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?, timeSeries?, processConstraints? | ||
| 3091 | |||
| 3092 | Content: | ||
| 3093 | (com:ProvisionAgrement | com:StructureUsage | com:Structure) | ||
| 3094 | |||
| 3095 | Attribute Documentation: | ||
| 3096 | |||
| 3097 | (% style="width:1112.29px" %) | ||
| 3098 | |**Name**|**Type**|(% style="width:673px" %)**Documentation** | ||
| 3099 | |structureID|xs:ID|(% style="width:673px" %)The structureID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]] is present in the message. | ||
| 3100 | |dimensionAtObservation|com: ObservationDimensionType|(% style="width:673px" %)The dimensionAtObservation is used to reference the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)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. | ||
| 3101 | |explicitMeasures (default: false)|xs:boolean|(% style="width:673px" %)The explicitMeasures indicates whether explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]] are used in the cross sectional format. This is only applicable for the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] as the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) or the flat structure. | ||
| 3102 | |serviceURL|xs:anyURI|(% style="width:673px" %)The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 3103 | |structureURL|xs:anyURI|(% style="width:673px" %)The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 3104 | |timeSeries (default: false)|xs:boolean|(% style="width:673px" %)The timeSeries [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates that the requested schema should derived from the time series specific [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. If the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is anything but the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], this field will be ignored. | ||
| 3105 | |processConstraints (default: false)|xs:boolean|(% style="width:673px" %)The processConstraints [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates that (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or data structure. If this is true, then the (% style="color:#e74c3c" %)constraints(%%) at the requested (% style="color:#e74c3c" %)level(%%) will be processed and the returned schema will take these (% style="color:#e74c3c" %)constraints(%%) into account (i.e. the appropriate [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] will be sub-setted | ||
| 3106 | |||
| 3107 | Element Documentation: | ||
| 3108 | |||
| 3109 | (% style="width:1248.29px" %) | ||
| 3110 | |(% style="width:222px" %)**Name**|(% style="width:345px" %)**Type**|(% style="width:678px" %)**Documentation** | ||
| 3111 | |(% style="width:222px" %)com: ProvisionAgrement|(% style="width:345px" %)com: ProvisionAgreementRe ferenceType|(% style="width:678px" %)ProvisionAgreement references a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] which the data is reported against. | ||
| 3112 | |(% style="width:222px" %)com:StructureUsage|(% style="width:345px" %)com: DataflowReferenceType|(% style="width:678px" %)StructureUsage references a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] which the data is reported against. | ||
| 3113 | |(% style="width:222px" %)com:Structure|(% style="width:345px" %)com: DataStructureReferenceType|(% style="width:678px" %)Structure references the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which defines the structure of the data. | ||
| 3114 | |||
| 3115 | **StructureSetQueryType: **StructureSetQueryType defines the structure of a [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]] 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>>doc:sdmx:Glossary.Structure set.WebHome]] should be returned. | ||
| 3116 | |||
| 3117 | Derivation: | ||
| 3118 | |||
| 3119 | * //StructuralMetadataQueryType// (restriction) | ||
| 3120 | ** StructureSetQueryType | ||
| 3121 | |||
| 3122 | Content: | ||
| 3123 | ReturnDetails, StructureSetWhere | ||
| 3124 | |||
| 3125 | Element Documentation: | ||
| 3126 | |||
| 3127 | (% style="width:1057.29px" %) | ||
| 3128 | |**Name**|**Type**|(% style="width:661px" %)**Documentation** | ||
| 3129 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:661px" %) | ||
| 3130 | |StructureSetWhere|StructureSetWhereType|(% style="width:661px" %)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 (% style="color:#e74c3c" %)mapped(%%) by the set's (% style="color:#e74c3c" %)maps(%%). In any case, the [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]] will be returned according the indicated return detail. | ||
| 3131 | |||
| 3132 | **//StructureSetWhereBaseType//: **StructureSetWhereBaseType is an abstract base type which forms the basis for the StructureSetWhereType. | ||
| 3133 | |||
| 3134 | Derivation: | ||
| 3135 | |||
| 3136 | * //AnnotableWhereType// (extension) | ||
| 3137 | ** //IdentifiableWhereType// (extension) | ||
| 3138 | *** //NameableWhereType// (extension) | ||
| 3139 | **** //VersionableWhereType// (extension) | ||
| 3140 | ***** //MaintainableWhereType// (restriction) | ||
| 3141 | ****** //StructureSetWhereBaseType// | ||
| 3142 | |||
| 3143 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3144 | type? | ||
| 3145 | |||
| 3146 | Content: | ||
| 3147 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 3148 | |||
| 3149 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3150 | |||
| 3151 | (% style="width:1081.29px" %) | ||
| 3152 | |**Name**|(% style="width:288px" %)**Type**|(% style="width:544px" %)**Documentation** | ||
| 3153 | |type (fixed: StructureSet)|(% style="width:288px" %)com: MaintainableTypeCodelistType|(% style="width:544px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 3154 | |||
| 3155 | Element Documentation: | ||
| 3156 | |||
| 3157 | (% style="width:1036.29px" %) | ||
| 3158 | |**Name**|**Type**|(% style="width:719px" %)**Documentation** | ||
| 3159 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:719px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3160 | |URN|xs:anyURI|(% style="width:719px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3161 | |ID|QueryIDType|(% style="width:719px" %)ID is used to match the id of the identified object. | ||
| 3162 | |Name|QueryTextType|(% style="width:719px" %)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. | ||
| 3163 | |Description|QueryTextType|(% style="width:719px" %)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. | ||
| 3164 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:719px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3165 | |VersionTo|com: TimeRangeValueType|(% style="width:719px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3166 | |VersionFrom|com: TimeRangeValueType|(% style="width:719px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3167 | |VersionActive|xs:boolean|(% style="width:719px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3168 | |AgencyID|QueryNestedIDType|(% style="width:719px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3169 | |||
| 3170 | **StructureSetWhereType: **StructureSetWhereType defines the parameters of a [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]] 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 (% style="color:#e74c3c" %)mapped(%%) by the set's (% style="color:#e74c3c" %)maps(%%). | ||
| 3171 | |||
| 3172 | Derivation: | ||
| 3173 | |||
| 3174 | * //AnnotableWhereType// (extension) | ||
| 3175 | ** //IdentifiableWhereType// (extension) | ||
| 3176 | *** //NameableWhereType// (extension) | ||
| 3177 | **** //VersionableWhereType// (extension) | ||
| 3178 | ***** //MaintainableWhereType// (restriction) | ||
| 3179 | ****** //StructureSetWhereBaseType// (extension) | ||
| 3180 | ******* StructureSetWhereType | ||
| 3181 | |||
| 3182 | Attributes: | ||
| 3183 | type? | ||
| 3184 | |||
| 3185 | Content: | ||
| 3186 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, RelatedStructures*, MappedObject* | ||
| 3187 | |||
| 3188 | Attribute Documentation: | ||
| 3189 | |||
| 3190 | (% style="width:1115.29px" %) | ||
| 3191 | |(% style="width:190px" %)**Name**|(% style="width:289px" %)**Type**|(% style="width:634px" %)**Documentation** | ||
| 3192 | |(% style="width:190px" %)type (fixed: StructureSet)|(% style="width:289px" %)com: MaintainableTypeCodelistType|(% style="width:634px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the type of (% style="color:#e74c3c" %)constraint(%%) that is being queried for, with a default of Any, meaning both content and attachment (% style="color:#e74c3c" %)constraints(%%) will be searched. | ||
| 3193 | Element Documentation: | ||
| 3194 | |||
| 3195 | (% style="width:1116.29px" %) | ||
| 3196 | |**Name**|**Type**|(% style="width:692px" %)**Documentation** | ||
| 3197 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:692px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3198 | |URN|xs:anyURI|(% style="width:692px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3199 | |ID|QueryIDType|(% style="width:692px" %)ID is used to match the id of the identified object. | ||
| 3200 | |Name|QueryTextType|(% style="width:692px" %)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. | ||
| 3201 | |Description|QueryTextType|(% style="width:692px" %)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. | ||
| 3202 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:692px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3203 | |VersionTo|com: TimeRangeValueType|(% style="width:692px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3204 | |VersionFrom|com: TimeRangeValueType|(% style="width:692px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3205 | |VersionActive|xs:boolean|(% style="width:692px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3206 | |AgencyID|QueryNestedIDType|(% style="width:692px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3207 | |RelatedStructures|com: StructureOrUsageReferenceType|(% style="width:692px" %)RelatedStructure is used to query for [[structure sets>>doc:sdmx:Glossary.Structure set.WebHome]] where the referenced key families, [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], and [[metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]] are related to another by the [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]]. | ||
| 3208 | |MappedObject|MappedObjectType|(% style="width:692px" %)MappedObject is used to query for [[structure sets>>doc:sdmx:Glossary.Structure set.WebHome]] where the reference object is (% style="color:#e74c3c" %)mapped(%%) in one of the (% style="color:#e74c3c" %)maps(%%) defined by the [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]]. The referenced object can be specified as being either a source, a target, or either in the queried map. | ||
| 3209 | |||
| 3210 | **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>>doc:sdmx:Glossary.Structure set.WebHome]] containing the referenced object in one of the (% style="color:#e74c3c" %)maps(%%) it defines. | ||
| 3211 | |||
| 3212 | Derivation: | ||
| 3213 | |||
| 3214 | * //com:ReferenceType// (restriction) | ||
| 3215 | ** //com:MaintainableReferenceBaseType// (restriction) | ||
| 3216 | *** com:MaintainableReferenceType (restriction) | ||
| 3217 | **** MappedObjectReferenceType (extension) | ||
| 3218 | ***** MappedObjectType | ||
| 3219 | |||
| 3220 | Attributes: | ||
| 3221 | type? | ||
| 3222 | |||
| 3223 | Content: | ||
| 3224 | ( (Ref, URN?) | URN) | ||
| 3225 | |||
| 3226 | Attribute Documentation: | ||
| 3227 | |||
| 3228 | (% style="width:1073.29px" %) | ||
| 3229 | |(% style="width:181px" %)**Name**|(% style="width:176px" %)**Type**|(% style="width:714px" %)**Documentation** | ||
| 3230 | |(% style="width:181px" %)type (default: Any)|(% style="width:176px" %)SourceTargetType|(% style="width:714px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the referenced object should be queried as the source, target, or both of a map. | ||
| 3231 | |||
| 3232 | Element Documentation: | ||
| 3233 | |||
| 3234 | (% style="width:1070.29px" %) | ||
| 3235 | |**Name**|**Type**|(% style="width:770px" %)**Documentation** | ||
| 3236 | |Ref|MappedObjectRefType|(% style="width:770px" %)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. | ||
| 3237 | |URN|xs:anyURI|(% style="width:770px" %)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. | ||
| 3238 | |URN|xs:anyURI|(% style="width:770px" %)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. | ||
| 3239 | |||
| 3240 | **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 (% style="color:#e74c3c" %)version(%%). | ||
| 3241 | |||
| 3242 | Derivation: | ||
| 3243 | |||
| 3244 | * //com:ReferenceType// (restriction) | ||
| 3245 | ** //com:MaintainableReferenceBaseType// (restriction) | ||
| 3246 | *** com:MaintainableReferenceType (restriction) | ||
| 3247 | **** MappedObjectReferenceType | ||
| 3248 | |||
| 3249 | Content: | ||
| 3250 | ( (Ref, URN?) | URN) | ||
| 3251 | |||
| 3252 | Element Documentation: | ||
| 3253 | |||
| 3254 | (% style="width:1005.29px" %) | ||
| 3255 | |**Name**|**Type**|(% style="width:705px" %)**Documentation** | ||
| 3256 | |Ref|MappedObjectRefType|(% style="width:705px" %)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. | ||
| 3257 | |URN|xs:anyURI|(% style="width:705px" %)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. | ||
| 3258 | |URN|xs:anyURI|(% style="width:705px" %)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. | ||
| 3259 | |||
| 3260 | **MappedObjectRefType: **MappedObjectRefType defines a set of reference fields for any type of mappable object. | ||
| 3261 | |||
| 3262 | Derivation: | ||
| 3263 | |||
| 3264 | * //com:RefBaseType// (restriction) | ||
| 3265 | ** //com:MaintainableRefBaseType// (restriction) | ||
| 3266 | *** com:MaintainableRefType (restriction) | ||
| 3267 | **** MappedObjectRefType | ||
| 3268 | |||
| 3269 | Attributes: | ||
| 3270 | agencyID, id, (% style="color:#e74c3c" %)version(%%)?, local?, class, package | ||
| 3271 | |||
| 3272 | Content: | ||
| 3273 | {Empty} | ||
| 3274 | |||
| 3275 | Attribute Documentation: | ||
| 3276 | |||
| 3277 | (% style="width:1102.29px" %) | ||
| 3278 | |**Name**|**Type**|(% style="width:723px" %)**Documentation** | ||
| 3279 | |agencyID|com: NestedNCNameIDType|(% style="width:723px" %)The agencyID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] 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. | ||
| 3280 | |id|com:IDType|(% style="width:723px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies the object being referenced, and is therefore always required. | ||
| 3281 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|(% style="width:723px" %)The (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies the (% style="color:#e74c3c" %)version(%%) of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply. | ||
| 3282 | |local (fixed: false)|xs:boolean|(% style="width:723px" %)The local [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3283 | |class|MappedObjectTypeCodelistType|(% style="width:723px" %)The class [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the class name of the object being referenced. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows any reference to be processed generically from this definition. References derived from this should fix the value of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Representation.WebHome]] should be sub-setted to the appropriate values. | ||
| 3284 | |package|com: PackageTypeCodelistType|(% style="width:723px" %)The package [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the package name for the object being referenced. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows any reference to be processed generically from this definition. References derived from this should fix the value of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Representation.WebHome]] should be sub-setted to the appropriate values. | ||
| 3285 | |||
| 3286 | **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.. | ||
| 3287 | |||
| 3288 | Derivation: | ||
| 3289 | |||
| 3290 | * //StructuralMetadataQueryType// (restriction) | ||
| 3291 | ** StructuresQueryType | ||
| 3292 | |||
| 3293 | Content: | ||
| 3294 | ReturnDetails, StructuresWhere | ||
| 3295 | |||
| 3296 | Element Documentation: | ||
| 3297 | |||
| 3298 | (% style="width:1027.29px" %) | ||
| 3299 | |**Name**|(% style="width:241px" %)**Type**|(% style="width:615px" %)**Documentation** | ||
| 3300 | |ReturnDetails|(% style="width:241px" %)MaintainableReturnDetailsType|(% style="width:615px" %) | ||
| 3301 | |StructuresWhere|(% style="width:241px" %)StructuresWhereType|(% style="width:615px" %)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. | ||
| 3302 | |||
| 3303 | **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. | ||
| 3304 | |||
| 3305 | Derivation: | ||
| 3306 | |||
| 3307 | * //AnnotableWhereType// (extension) | ||
| 3308 | ** //IdentifiableWhereType// (extension) | ||
| 3309 | *** //NameableWhereType// (extension) | ||
| 3310 | **** //VersionableWhereType// (extension) | ||
| 3311 | ***** //MaintainableWhereType// (restriction) | ||
| 3312 | ****** StructuresWhereType | ||
| 3313 | |||
| 3314 | Attributes: | ||
| 3315 | type? | ||
| 3316 | |||
| 3317 | Content: | ||
| 3318 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID? | ||
| 3319 | |||
| 3320 | Attribute Documentation: | ||
| 3321 | |||
| 3322 | (% style="width:1040.29px" %) | ||
| 3323 | |**Name**|**Type**|(% style="width:636px" %)**Documentation** | ||
| 3324 | |type (fixed: Any)|com: MaintainableTypeCodelistType|(% style="width:636px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3325 | |||
| 3326 | Element Documentation: | ||
| 3327 | |||
| 3328 | (% style="width:1037.29px" %) | ||
| 3329 | |**Name**|**Type**|(% style="width:720px" %)**Documentation** | ||
| 3330 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:720px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3331 | |URN|xs:anyURI|(% style="width:720px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3332 | |ID|QueryIDType|(% style="width:720px" %)ID is used to match the id of the identified object. | ||
| 3333 | |Name|QueryTextType|(% style="width:720px" %)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. | ||
| 3334 | |Description|QueryTextType|(% style="width:720px" %)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. | ||
| 3335 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:720px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3336 | |VersionTo|com: TimeRangeValueType|(% style="width:720px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3337 | |VersionFrom|com: TimeRangeValueType|(% style="width:720px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3338 | |VersionActive|xs:boolean|(% style="width:720px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3339 | |AgencyID|QueryNestedIDType|(% style="width:720px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3340 | |||
| 3341 | **//DefinitionSchemeWhereType//: **DefinitionSchemeWhereType is an abstract base type that extends and [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] query to add the ability to query based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%). | ||
| 3342 | |||
| 3343 | Derivation: | ||
| 3344 | |||
| 3345 | * //AnnotableWhereType// (extension) | ||
| 3346 | ** //IdentifiableWhereType// (extension) | ||
| 3347 | *** //NameableWhereType// (extension) | ||
| 3348 | **** //VersionableWhereType// (extension) | ||
| 3349 | ***** //MaintainableWhereType// (extension) | ||
| 3350 | ****** //ItemSchemeWhereType// (extension) | ||
| 3351 | ******* //DefinitionSchemeWhereType// | ||
| 3352 | |||
| 3353 | Attributes: | ||
| 3354 | type? | ||
| 3355 | |||
| 3356 | Content: | ||
| 3357 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, //ItemWhere*//, VtlVersion? | ||
| 3358 | |||
| 3359 | Attribute Documentation: | ||
| 3360 | |||
| 3361 | |**Name**|**Type**|**Documentation** | ||
| 3362 | |type|com: MaintainableTypeCode listType|The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 | (% style="width:1002.29px" %) | ||
| 3367 | |**Name**|**Type**|(% style="width:685px" %)**Documentation** | ||
| 3368 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:685px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3369 | |URN|xs:anyURI|(% style="width:685px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3370 | |ID|QueryIDType|(% style="width:685px" %)ID is used to match the id of the identified object. | ||
| 3371 | |Name|QueryTextType|(% style="width:685px" %)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. | ||
| 3372 | |Description|QueryTextType|(% style="width:685px" %)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. | ||
| 3373 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:685px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3374 | |VersionTo|com: TimeRangeValueType|(% style="width:685px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3375 | |VersionFrom|com: TimeRangeValueType|(% style="width:685px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3376 | |VersionActive|xs:boolean|(% style="width:685px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3377 | |AgencyID|QueryNestedIDType|(% style="width:685px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3378 | |//ItemWhere//|//ItemWhereType//|(% style="width:685px" %)ItemWhere is an abstract substitution head to query for an item within a parent item where or an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] 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>>doc:sdmx:Glossary.Hierarchy.WebHome]] provided. | ||
| 3379 | |VtlVersion|com:VersionQueryType|(% style="width:685px" %)Allows querying based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) number. | ||
| 3380 | |||
| 3381 | **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. | ||
| 3382 | |||
| 3383 | Derivation: | ||
| 3384 | |||
| 3385 | * //StructuralMetadataQueryType// (restriction) | ||
| 3386 | ** TransformationSchemeQueryType | ||
| 3387 | |||
| 3388 | Content: | ||
| 3389 | ReturnDetails, TransformationSchemeWhere | ||
| 3390 | |||
| 3391 | Element Documentation: | ||
| 3392 | |||
| 3393 | (% style="width:1035.29px" %) | ||
| 3394 | |**Name**|**Type**|(% style="width:538px" %)**Documentation** | ||
| 3395 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:538px" %) | ||
| 3396 | |TransformationSchemeWhere|TransformationSchemeWhereType|(% style="width:538px" %)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. | ||
| 3397 | |||
| 3398 | **//TransformationSchemeWhereBaseType//: **TransformationSchemeWhereBaseType is an abstract base type which forms the basis for the TransformationSchemeWhereType. | ||
| 3399 | |||
| 3400 | Derivation: | ||
| 3401 | |||
| 3402 | * //AnnotableWhereType// (extension) | ||
| 3403 | ** //IdentifiableWhereType// (extension) | ||
| 3404 | *** /NameableWhereType//Â (extension)// | ||
| 3405 | **** //VersionableWhereType// (extension) | ||
| 3406 | ***** //MaintainableWhereType// (extension) | ||
| 3407 | ****** //ItemSchemeWhereType// (extension) | ||
| 3408 | ******* //DefinitionSchemeWhereType// (restriction) | ||
| 3409 | ******** //TransformationSchemeWhereBaseType// | ||
| 3410 | |||
| 3411 | Attributes: | ||
| 3412 | type? | ||
| 3413 | |||
| 3414 | Content: | ||
| 3415 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, TransformationWhere*, VtlVersion? | ||
| 3416 | |||
| 3417 | Attribute Documentation: | ||
| 3418 | |||
| 3419 | (% style="width:1034.29px" %) | ||
| 3420 | |(% style="width:192px" %)**Name**|(% style="width:274px" %)**Type**|(% style="width:565px" %)**Documentation** | ||
| 3421 | |(% style="width:192px" %)type (fixed: TransformationScheme)|(% style="width:274px" %)com: MaintainableTypeCodelistType|(% style="width:565px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3422 | |||
| 3423 | Element Documentation: | ||
| 3424 | |||
| 3425 | (% style="width:1035.29px" %) | ||
| 3426 | |**Name**|**Type**|(% style="width:651px" %)**Documentation** | ||
| 3427 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:651px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3428 | |URN|xs:anyURI|(% style="width:651px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3429 | |ID|QueryIDType|(% style="width:651px" %)ID is used to match the id of the identified object. | ||
| 3430 | |Name|QueryTextType|(% style="width:651px" %)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. | ||
| 3431 | |Description|QueryTextType|(% style="width:651px" %)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. | ||
| 3432 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:651px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3433 | |VersionTo|com: TimeRangeValueType|(% style="width:651px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3434 | |VersionFrom|com: TimeRangeValueType|(% style="width:651px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3435 | |VersionActive|xs:boolean|(% style="width:651px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3436 | |AgencyID|QueryNestedIDType|(% style="width:651px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3437 | |TransformationWhere|TransformationWhereType|(% style="width:651px" %)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. | ||
| 3438 | |VtlVersion|com:VersionQueryType|(% style="width:651px" %)Allows querying based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) number. | ||
| 3439 | |||
| 3440 | **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. | ||
| 3441 | |||
| 3442 | Derivation: | ||
| 3443 | |||
| 3444 | * //AnnotableWhereType// (extension) | ||
| 3445 | ** //IdentifiableWhereType// (extension) | ||
| 3446 | *** //NameableWhereType// (extension) | ||
| 3447 | **** //VersionableWhereType// (extension) | ||
| 3448 | ***** //MaintainableWhereType// (extension) | ||
| 3449 | ****** //ItemSchemeWhereType// (extension) | ||
| 3450 | ******* //DefinitionSchemeWhereType// (restriction) | ||
| 3451 | ******** //TransformationSchemeWhereBaseType// (extension) | ||
| 3452 | ********* TransformationSchemeWhereType | ||
| 3453 | |||
| 3454 | Attributes: | ||
| 3455 | type? | ||
| 3456 | |||
| 3457 | Content: | ||
| 3458 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, TransformationWhere*, VtlVersion?, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme?, UserDefinedOperatorScheme? | ||
| 3459 | |||
| 3460 | Attribute Documentation: | ||
| 3461 | |||
| 3462 | (% style="width:1042.29px" %) | ||
| 3463 | |(% style="width:205px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:553px" %)**Documentation** | ||
| 3464 | |(% style="width:205px" %)type (fixed: TransformationScheme)|(% style="width:281px" %)com: MaintainableTypeCodelistType|(% style="width:553px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3465 | |||
| 3466 | Element Documentation: | ||
| 3467 | |||
| 3468 | (% style="width:1165.29px" %) | ||
| 3469 | |**Name**|(% style="width:336px" %)**Type**|(% style="width:600px" %)**Documentation** | ||
| 3470 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|(% style="width:336px" %)AnnotationWhereType|(% style="width:600px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3471 | |URN|(% style="width:336px" %)xs:anyURI|(% style="width:600px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3472 | |ID|(% style="width:336px" %)QueryIDType|(% style="width:600px" %)ID is used to match the id of the identified object. | ||
| 3473 | |Name|(% style="width:336px" %)QueryTextType|(% style="width:600px" %)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. | ||
| 3474 | |Description|(% style="width:336px" %)QueryTextType|(% style="width:600px" %)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. | ||
| 3475 | |(%%)(% style="color:#e74c3c" %)Version|(% style="width:336px" %)com:VersionQueryType|(% style="width:600px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3476 | |VersionTo|(% style="width:336px" %)com: TimeRangeValueType|(% style="width:600px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3477 | |VersionFrom|(% style="width:336px" %)com: TimeRangeValueType|(% style="width:600px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3478 | |VersionActive|(% style="width:336px" %)xs:boolean|(% style="width:600px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3479 | |AgencyID|(% style="width:336px" %)QueryNestedIDType|(% style="width:600px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3480 | |TransformationWhere|(% style="width:336px" %)TransformationWhereType|(% style="width:600px" %)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. | ||
| 3481 | |VtlVersion|(% style="width:336px" %)com:VersionQueryType|(% style="width:600px" %)Allows querying based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) number. | ||
| 3482 | |VtlMappingScheme|(% style="width:336px" %)com: VtlMappingSchemeRefe renceType|(% style="width:600px" %)VtlMappingScheme is used to query for a transformation scheme based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping scheme that is used in the transformations. | ||
| 3483 | |NamePersonalisationScheme|(% style="width:336px" %)com: NamePersonalisationSchemeReferenceType|(% style="width:600px" %)NamePersonalisationScheme is used to query for a transformation scheme based on the name personalisation scheme that is used in the transformations. | ||
| 3484 | |CustomTypeScheme|(% style="width:336px" %)com: CustomTypeSchemeRefe renceType|(% style="width:600px" %)CustomTypeScheme is used to query for a transformation scheme based on the custom type scheme that is used in the transformations. | ||
| 3485 | |RulesetScheme|(% style="width:336px" %)com: RulesetSchemeReferenceType|(% style="width:600px" %)RulesetScheme is used to query for a transformation scheme based on the ruleset scheme that is used in the transformations. | ||
| 3486 | |UserDefinedOperatorScheme|(% style="width:336px" %)com: UserDefinedOperatorS chemeReferenceType|(% style="width:600px" %)UserDefinedOperatorScheme is used to query for a transformation scheme based on the user defined operator scheme that is used in the transformations. | ||
| 3487 | |||
| 3488 | **//TransformationWhereBaseType//: **TransformationWhereBaseType is an abstract base type that forms the basis for the TransformationWhereType. | ||
| 3489 | |||
| 3490 | Derivation: | ||
| 3491 | |||
| 3492 | * //AnnotableWhereType// (extension) | ||
| 3493 | ** //IdentifiableWhereType// (extension) | ||
| 3494 | *** //NameableWhereType// (extension) | ||
| 3495 | **** //ItemWhereType// (restriction) | ||
| 3496 | ***** //TransformationWhereBaseType// | ||
| 3497 | |||
| 3498 | Content: | ||
| 3499 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description? | ||
| 3500 | |||
| 3501 | Element Documentation: | ||
| 3502 | |||
| 3503 | (% style="width:1038.29px" %) | ||
| 3504 | |**Name**|**Type**|(% style="width:762px" %)**Documentation** | ||
| 3505 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:762px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3506 | |ID|QueryIDType|(% style="width:762px" %)ID is used to match the id of the identified object. | ||
| 3507 | |Name|QueryTextType|(% style="width:762px" %)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. | ||
| 3508 | |Description|QueryTextType|(% style="width:762px" %)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. | ||
| 3509 | |||
| 3510 | **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>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] that are used in the expression. | ||
| 3511 | |||
| 3512 | Derivation: | ||
| 3513 | |||
| 3514 | * //AnnotableWhereType// (extension) | ||
| 3515 | ** //IdentifiableWhereType// (extension) | ||
| 3516 | *** //NameableWhereType// (extension) | ||
| 3517 | **** //ItemWhereType// (restriction) | ||
| 3518 | ***** //TransformationWhereBaseType// (extension) | ||
| 3519 | ****** TransformationWhereType | ||
| 3520 | |||
| 3521 | Content: | ||
| 3522 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description?, IdentifiableArtefact* | ||
| 3523 | |||
| 3524 | Element Documentation: | ||
| 3525 | |||
| 3526 | (% style="width:1041.29px" %) | ||
| 3527 | |**Name**|**Type**|(% style="width:693px" %)**Documentation** | ||
| 3528 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:693px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3529 | |ID|QueryIDType|(% style="width:693px" %)ID is used to match the id of the identified object. | ||
| 3530 | |Name|QueryTextType|(% style="width:693px" %)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. | ||
| 3531 | |Description|QueryTextType|(% style="width:693px" %)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. | ||
| 3532 | |IdentifiableArtefact|com: ObjectReferenceType|(% style="width:693px" %)IdentifiableArtefact allows a transformation to be queried based on the [[identifiable artefact>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] it uses in its expression. | ||
| 3533 | |||
| 3534 | **VtlMappingSchemeQueryType: **VtlMappingSchemeQueryType defines the structure of a [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] 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>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping scheme should be returned. | ||
| 3535 | |||
| 3536 | Derivation: | ||
| 3537 | |||
| 3538 | * //StructuralMetadataQueryType// (restriction) | ||
| 3539 | ** VtlMappingSchemeQueryType | ||
| 3540 | |||
| 3541 | Content: | ||
| 3542 | ReturnDetails, VtlMappingSchemeWhere | ||
| 3543 | |||
| 3544 | Element Documentation: | ||
| 3545 | |||
| 3546 | (% style="width:1032.29px" %) | ||
| 3547 | |**Name**|**Type**|(% style="width:587px" %)**Documentation** | ||
| 3548 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:587px" %) | ||
| 3549 | |VtlMappingSchemeWhere|VtlMappingSchemeWhereType|(% style="width:587px" %)VtlMappingSchemeWhere contains the parameters for a [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] 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>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mappings defined within the scheme. | ||
| 3550 | |||
| 3551 | **VtlMappingSchemeWhereType: **VtlMappingSchemeWhereType defines the parameters of a [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping scheme query. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 3552 | |||
| 3553 | Derivation: | ||
| 3554 | |||
| 3555 | * //AnnotableWhereType// (extension) | ||
| 3556 | ** //IdentifiableWhereType// (extension) | ||
| 3557 | *** //NameableWhereType// (extension) | ||
| 3558 | **** //VersionableWhereType// (extension) | ||
| 3559 | ***** //MaintainableWhereType// (extension) | ||
| 3560 | ****** //ItemSchemeWhereType// (restriction) | ||
| 3561 | ******* VtlMappingSchemeWhereType | ||
| 3562 | |||
| 3563 | Attributes: | ||
| 3564 | type? | ||
| 3565 | |||
| 3566 | Content: | ||
| 3567 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, VtlMappingWhere* | ||
| 3568 | |||
| 3569 | Attribute Documentation: | ||
| 3570 | |||
| 3571 | (% style="width:1052.29px" %) | ||
| 3572 | |(% style="width:181px" %)**Name**|(% style="width:283px" %)**Type**|(% style="width:586px" %)**Documentation** | ||
| 3573 | |(% style="width:181px" %)type (fixed: VtlMappingScheme)|(% style="width:283px" %)com: MaintainableTypeCodelistType|(% style="width:586px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3574 | |||
| 3575 | Element Documentation: | ||
| 3576 | |||
| 3577 | (% style="width:1052.29px" %) | ||
| 3578 | |**Name**|**Type**|(% style="width:705px" %)**Documentation** | ||
| 3579 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:705px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3580 | |URN|xs:anyURI|(% style="width:705px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3581 | |ID|QueryIDType|(% style="width:705px" %)ID is used to match the id of the identified object. | ||
| 3582 | |Name|QueryTextType|(% style="width:705px" %)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. | ||
| 3583 | |Description|QueryTextType|(% style="width:705px" %)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. | ||
| 3584 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:705px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3585 | |VersionTo|com: TimeRangeValueType|(% style="width:705px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3586 | |VersionFrom|com: TimeRangeValueType|(% style="width:705px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3587 | |VersionActive|xs:boolean|(% style="width:705px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3588 | |AgencyID|QueryNestedIDType|(% style="width:705px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3589 | |VtlMappingWhere|VtlMappingWhereType|(% style="width:705px" %)VtlMappingWhere is used to query for [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] 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. | ||
| 3590 | |||
| 3591 | **VtlMappingWhereType: **VtlMappingWhereType defines a set of parameters for matching a [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping. All supplied parameters must be matched in order for an object to satisfy the query. | ||
| 3592 | |||
| 3593 | Derivation: | ||
| 3594 | |||
| 3595 | * //AnnotableWhereType// (extension) | ||
| 3596 | ** //IdentifiableWhereType// (extension) | ||
| 3597 | *** //NameableWhereType// (extension) | ||
| 3598 | **** //ItemWhereType// (restriction) | ||
| 3599 | ***** VtlMappingWhereType | ||
| 3600 | |||
| 3601 | Content: | ||
| 3602 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description? | ||
| 3603 | |||
| 3604 | Element Documentation: | ||
| 3605 | |||
| 3606 | (% style="width:1052.29px" %) | ||
| 3607 | |**Name**|**Type**|(% style="width:776px" %)**Documentation** | ||
| 3608 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:776px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3609 | |ID|QueryIDType|(% style="width:776px" %)ID is used to match the id of the identified object. | ||
| 3610 | |Name|QueryTextType|(% style="width:776px" %)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. | ||
| 3611 | |Description|QueryTextType|(% style="width:776px" %)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. | ||
| 3612 | |||
| 3613 | **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. | ||
| 3614 | |||
| 3615 | Derivation: | ||
| 3616 | |||
| 3617 | * //StructuralMetadataQueryType// (restriction) | ||
| 3618 | ** NamePersonalisationSchemeQueryType | ||
| 3619 | |||
| 3620 | Content: | ||
| 3621 | ReturnDetails, NamePersonalisationSchemeWhere | ||
| 3622 | |||
| 3623 | Element Documentation: | ||
| 3624 | |||
| 3625 | (% style="width:1141.29px" %) | ||
| 3626 | |**Name**|**Type**|(% style="width:553px" %)**Documentation** | ||
| 3627 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:553px" %) | ||
| 3628 | |NamePersonalisationSchemeWhere|NamePersonalisationSchemeWhereType|(% style="width:553px" %)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. | ||
| 3629 | |||
| 3630 | **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. | ||
| 3631 | |||
| 3632 | Derivation: | ||
| 3633 | |||
| 3634 | * //AnnotableWhereType// (extension) | ||
| 3635 | ** //IdentifiableWhereType// (extension) | ||
| 3636 | *** //NameableWhereType// (extension) | ||
| 3637 | **** //VersionableWhereType// (extension) | ||
| 3638 | ***** //MaintainableWhereType// (extension) | ||
| 3639 | ****** //ItemSchemeWhereType// (extension) | ||
| 3640 | ******* //DefinitionSchemeWhereType// (restriction) | ||
| 3641 | ******** NamePersonalisationSchemeWhereType | ||
| 3642 | |||
| 3643 | Attributes: | ||
| 3644 | type? | ||
| 3645 | |||
| 3646 | Content: | ||
| 3647 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, NamePersonalisationWhere*, VtlVersion? | ||
| 3648 | |||
| 3649 | Attribute Documentation: | ||
| 3650 | |||
| 3651 | (% style="width:1083.29px" %) | ||
| 3652 | |(% style="width:238px" %)**Name**|(% style="width:330px" %)**Type**|(% style="width:513px" %)**Documentation** | ||
| 3653 | |(% style="width:238px" %)type (fixed: NamePersonalisationScheme)|(% style="width:330px" %)com: MaintainableTypeCodelistType|(% style="width:513px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3654 | |||
| 3655 | Element Documentation: | ||
| 3656 | |||
| 3657 | (% style="width:1074.29px" %) | ||
| 3658 | |**Name**|**Type**|(% style="width:604px" %)**Documentation** | ||
| 3659 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:604px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3660 | |URN|xs:anyURI|(% style="width:604px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3661 | |ID|QueryIDType|(% style="width:604px" %)ID is used to match the id of the identified object. | ||
| 3662 | |Name|QueryTextType|(% style="width:604px" %)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. | ||
| 3663 | |Description|QueryTextType|(% style="width:604px" %)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. | ||
| 3664 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:604px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3665 | |VersionTo|com: TimeRangeValueType|(% style="width:604px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3666 | |VersionFrom|com: TimeRangeValueType|(% style="width:604px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3667 | |VersionActive|xs:boolean|(% style="width:604px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3668 | |AgencyID|QueryNestedIDType|(% style="width:604px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3669 | |NamePersonalisationWhere|NamePersonalisationWhereType|(% style="width:604px" %)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. | ||
| 3670 | |VtlVersion|com:VersionQueryType|(% style="width:604px" %)Allows querying based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) number. | ||
| 3671 | |||
| 3672 | **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. | ||
| 3673 | |||
| 3674 | Derivation: | ||
| 3675 | |||
| 3676 | * //AnnotableWhereType// (extension) | ||
| 3677 | ** //IdentifiableWhereType// (extension) | ||
| 3678 | *** //NameableWhereType// (extension) | ||
| 3679 | **** //ItemWhereType// (restriction) | ||
| 3680 | ***** NamePersonalisationWhereType | ||
| 3681 | |||
| 3682 | Content: | ||
| 3683 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description? | ||
| 3684 | |||
| 3685 | Element Documentation: | ||
| 3686 | |||
| 3687 | (% style="width:1009.29px" %) | ||
| 3688 | |**Name**|**Type**|(% style="width:733px" %)**Documentation** | ||
| 3689 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:733px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3690 | |ID|QueryIDType|(% style="width:733px" %)ID is used to match the id of the identified object. | ||
| 3691 | |Name|QueryTextType|(% style="width:733px" %)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. | ||
| 3692 | |Description|QueryTextType|(% style="width:733px" %)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. | ||
| 3693 | |||
| 3694 | **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. | ||
| 3695 | |||
| 3696 | Derivation: | ||
| 3697 | |||
| 3698 | * //StructuralMetadataQueryType// (restriction) | ||
| 3699 | ** RulesetSchemeQueryType | ||
| 3700 | |||
| 3701 | Content: | ||
| 3702 | ReturnDetails, RulesetSchemeWhere | ||
| 3703 | |||
| 3704 | Element Documentation: | ||
| 3705 | |||
| 3706 | (% style="width:1014.29px" %) | ||
| 3707 | |**Name**|**Type**|(% style="width:594px" %)**Documentation** | ||
| 3708 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:594px" %) | ||
| 3709 | |RulesetSchemeWhere|RulesetSchemeWhereType|(% style="width:594px" %)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. | ||
| 3710 | |||
| 3711 | **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. | ||
| 3712 | |||
| 3713 | Derivation: | ||
| 3714 | |||
| 3715 | * //AnnotableWhereType// (extension) | ||
| 3716 | ** //IdentifiableWhereType// (extension) | ||
| 3717 | *** //NameableWhereType// (extension) | ||
| 3718 | **** //VersionableWhereType// (extension) | ||
| 3719 | ***** //MaintainableWhereType// (extension) | ||
| 3720 | ****** //ItemSchemeWhereType// (extension) | ||
| 3721 | ******* //DefinitionSchemeWhereType// (restriction) | ||
| 3722 | ******** RulesetSchemeWhereType | ||
| 3723 | |||
| 3724 | Attributes: | ||
| 3725 | type? | ||
| 3726 | |||
| 3727 | Content: | ||
| 3728 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, RulesetWhere*, VtlVersion? | ||
| 3729 | |||
| 3730 | Attribute Documentation: | ||
| 3731 | |||
| 3732 | (% style="width:1041.29px" %) | ||
| 3733 | |(% style="width:150px" %)**Name**|(% style="width:330px" %)**Type**|(% style="width:559px" %)**Documentation** | ||
| 3734 | |(% style="width:150px" %)type (fixed: RulesetScheme)|(% style="width:330px" %)com: MaintainableTypeCodelistType|(% style="width:559px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3735 | |||
| 3736 | Element Documentation: | ||
| 3737 | |||
| 3738 | (% style="width:1041.29px" %) | ||
| 3739 | |**Name**|**Type**|(% style="width:717px" %)**Documentation** | ||
| 3740 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:717px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3741 | |URN|xs:anyURI|(% style="width:717px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3742 | |ID|QueryIDType|(% style="width:717px" %)ID is used to match the id of the identified object. | ||
| 3743 | |Name|QueryTextType|(% style="width:717px" %)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. | ||
| 3744 | |Description|QueryTextType|(% style="width:717px" %)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. | ||
| 3745 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:717px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3746 | |VersionTo|com: TimeRangeValueType|(% style="width:717px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3747 | |VersionFrom|com: TimeRangeValueType|(% style="width:717px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3748 | |VersionActive|xs:boolean|(% style="width:717px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3749 | |AgencyID|QueryNestedIDType|(% style="width:717px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3750 | |RulesetWhere|RulesetWhereType|(% style="width:717px" %)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. | ||
| 3751 | |VtlVersion|com:VersionQueryType|(% style="width:717px" %)Allows querying based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) number. | ||
| 3752 | |||
| 3753 | **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. | ||
| 3754 | |||
| 3755 | Derivation: | ||
| 3756 | |||
| 3757 | * //AnnotableWhereType// (extension) | ||
| 3758 | ** //IdentifiableWhereType// (extension) | ||
| 3759 | *** //NameableWhereType// (extension) | ||
| 3760 | **** //ItemWhereType// (restriction) | ||
| 3761 | ***** RulesetWhereType | ||
| 3762 | |||
| 3763 | Content: | ||
| 3764 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description? | ||
| 3765 | |||
| 3766 | Element Documentation: | ||
| 3767 | |||
| 3768 | (% style="width:1017.29px" %) | ||
| 3769 | |**Name**|**Type**|(% style="width:741px" %)**Documentation** | ||
| 3770 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:741px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3771 | |ID|QueryIDType|(% style="width:741px" %)ID is used to match the id of the identified object. | ||
| 3772 | |Name|QueryTextType|(% style="width:741px" %)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. | ||
| 3773 | |Description|QueryTextType|(% style="width:741px" %)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. | ||
| 3774 | |||
| 3775 | **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. | ||
| 3776 | |||
| 3777 | Derivation: | ||
| 3778 | |||
| 3779 | * //StructuralMetadataQueryType// (restriction) | ||
| 3780 | ** UserDefinedOperatorSchemeQueryType | ||
| 3781 | |||
| 3782 | Content: | ||
| 3783 | ReturnDetails, UserDefinedOperatorSchemeWhere | ||
| 3784 | |||
| 3785 | Element Documentation: | ||
| 3786 | |||
| 3787 | (% style="width:1084.29px" %) | ||
| 3788 | |**Name**|**Type**|(% style="width:496px" %)**Documentation** | ||
| 3789 | |ReturnDetails|MaintainableReturnDe tailsType|(% style="width:496px" %) | ||
| 3790 | |UserDefinedOperatorSchemeWhere|UserDefinedOperatorSchemeWhereType|(% style="width:496px" %)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. | ||
| 3791 | |||
| 3792 | **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. | ||
| 3793 | |||
| 3794 | Derivation: | ||
| 3795 | |||
| 3796 | * //AnnotableWhereType// (extension) | ||
| 3797 | ** //IdentifiableWhereType// (extension) | ||
| 3798 | *** //NameableWhereType// (extension) | ||
| 3799 | **** //VersionableWhereType// (extension) | ||
| 3800 | ***** //MaintainableWhereType// (extension) | ||
| 3801 | ****** //ItemSchemeWhereType// (extension) | ||
| 3802 | ******* //DefinitionSchemeWhereType// (restriction) | ||
| 3803 | ******** UserDefinedOperatorSchemeWhereType | ||
| 3804 | |||
| 3805 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3806 | type? | ||
| 3807 | |||
| 3808 | Content: | ||
| 3809 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UserDefinedOperatorWhere*, VtlVersion? | ||
| 3810 | |||
| 3811 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3812 | |||
| 3813 | (% style="width:1028.29px" %) | ||
| 3814 | |(% style="width:238px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:507px" %)**Documentation** | ||
| 3815 | |(% style="width:238px" %)type (fixed: UserDefinedOperatorScheme)|(% style="width:281px" %)com: MaintainableTypeCodelistType|(% style="width:507px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3816 | |||
| 3817 | Element Documentation: | ||
| 3818 | |||
| 3819 | (% style="width:1017.29px" %) | ||
| 3820 | |(% style="width:151px" %)**Name**|(% style="width:215px" %)**Type**|(% style="width:616px" %)**Documentation** | ||
| 3821 | |(% style="width:151px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|(% style="width:215px" %)AnnotationWhereType|(% style="width:616px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3822 | |(% style="width:151px" %)URN|(% style="width:215px" %)xs:anyURI|(% style="width:616px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3823 | |(% style="width:151px" %)ID|(% style="width:215px" %)QueryIDType|(% style="width:616px" %)ID is used to match the id of the identified object. | ||
| 3824 | |(% style="width:151px" %)Name|(% style="width:215px" %)QueryTextType|(% style="width:616px" %)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. | ||
| 3825 | |(% style="width:151px" %)Description|(% style="width:215px" %)QueryTextType|(% style="width:616px" %)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. | ||
| 3826 | |(% style="width:151px" %)(% style="color:#e74c3c" %)Version|(% style="width:215px" %)com:VersionQueryType|(% style="width:616px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3827 | |(% style="width:151px" %)VersionTo|(% style="width:215px" %)com: TimeRangeValueType|(% style="width:616px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3828 | |(% style="width:151px" %)VersionFrom|(% style="width:215px" %)com: TimeRangeValueType|(% style="width:616px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3829 | |(% style="width:151px" %)VersionActive|(% style="width:215px" %)xs:boolean|(% style="width:616px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3830 | |(% style="width:151px" %)AgencyID|(% style="width:215px" %)QueryNestedIDType|(% style="width:616px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3831 | |(% style="width:151px" %)UserDefinedOperatorWhere|(% style="width:215px" %)UserDefinedOperatorWhereType|(% style="width:616px" %)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. | ||
| 3832 | |(% style="width:151px" %)VtlVersion|(% style="width:215px" %)com:VersionQueryType|(% style="width:616px" %)Allows querying based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) number. | ||
| 3833 | |||
| 3834 | **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. | ||
| 3835 | |||
| 3836 | Derivation: | ||
| 3837 | |||
| 3838 | * //AnnotableWhereType// (extension) | ||
| 3839 | ** //IdentifiableWhereType// (extension) | ||
| 3840 | *** //NameableWhereType// (extension) | ||
| 3841 | **** //ItemWhereType// (restriction) | ||
| 3842 | ***** UserDefinedOperatorWhereType | ||
| 3843 | |||
| 3844 | Content: | ||
| 3845 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description? | ||
| 3846 | |||
| 3847 | Element Documentation: | ||
| 3848 | |||
| 3849 | (% style="width:1011.29px" %) | ||
| 3850 | |**Name**|**Type**|(% style="width:732px" %)**Documentation** | ||
| 3851 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:732px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3852 | |ID|QueryIDType|(% style="width:732px" %)ID is used to match the id of the identified object. | ||
| 3853 | |Name|QueryTextType|(% style="width:732px" %)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. | ||
| 3854 | |Description|QueryTextType|(% style="width:732px" %)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. | ||
| 3855 | |||
| 3856 | **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. | ||
| 3857 | |||
| 3858 | Derivation: | ||
| 3859 | |||
| 3860 | * //StructuralMetadataQueryType// (restriction) | ||
| 3861 | ** CustomTypeSchemeQueryType | ||
| 3862 | |||
| 3863 | Content: | ||
| 3864 | ReturnDetails, CustomTypeSchemeWhere | ||
| 3865 | |||
| 3866 | Element Documentation: | ||
| 3867 | |||
| 3868 | (% style="width:1003.29px" %) | ||
| 3869 | |**Name**|**Type**|(% style="width:550px" %)**Documentation** | ||
| 3870 | |ReturnDetails|MaintainableReturnDetailsType|(% style="width:550px" %) | ||
| 3871 | |CustomTypeSchemeWhere|CustomTypeSchemeWhereType|(% style="width:550px" %)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. | ||
| 3872 | |||
| 3873 | **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. | ||
| 3874 | |||
| 3875 | Derivation: | ||
| 3876 | |||
| 3877 | * //AnnotableWhereType// (extension) | ||
| 3878 | ** //IdentifiableWhereType// (extension) | ||
| 3879 | *** //NameableWhereType// (extension) | ||
| 3880 | **** //VersionableWhereType// (extension) | ||
| 3881 | ***** //MaintainableWhereType// (extension) | ||
| 3882 | ****** //ItemSchemeWhereType// (extension) | ||
| 3883 | ******* //DefinitionSchemeWhereType// (restriction) | ||
| 3884 | ******** CustomTypeSchemeWhereType | ||
| 3885 | |||
| 3886 | Attributes: | ||
| 3887 | type? | ||
| 3888 | |||
| 3889 | Content: | ||
| 3890 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, URN?, ID?, Name?, Description?, (% style="color:#e74c3c" %)Version(%%)?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CustomTypeWhere*, VtlVersion? | ||
| 3891 | |||
| 3892 | Attribute Documentation: | ||
| 3893 | |||
| 3894 | (% style="width:1035.29px" %) | ||
| 3895 | |**Name**|**Type**|(% style="width:521px" %)**Documentation** | ||
| 3896 | |type (fixed: CustomTypeScheme)|com: MaintainableTypeCode listType|(% style="width:521px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 3897 | |||
| 3898 | Element Documentation: | ||
| 3899 | |||
| 3900 | (% style="width:1005.29px" %) | ||
| 3901 | |**Name**|**Type**|(% style="width:646px" %)**Documentation** | ||
| 3902 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:646px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3903 | |URN|xs:anyURI|(% style="width:646px" %)URN is used to match the urn of any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object. | ||
| 3904 | |ID|QueryIDType|(% style="width:646px" %)ID is used to match the id of the identified object. | ||
| 3905 | |Name|QueryTextType|(% style="width:646px" %)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. | ||
| 3906 | |Description|QueryTextType|(% style="width:646px" %)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. | ||
| 3907 | |(%%)(% style="color:#e74c3c" %)Version|com:VersionQueryType|(% style="width:646px" %)(% style="color:#e74c3c" %)Version(%%) is used to match the (% style="color:#e74c3c" %)version(%%) of the versioned object. The (% style="color:#e74c3c" %)version(%%) can be specified as either an explicit (% style="color:#e74c3c" %)version(%%) number, or a late bound query where the latest (% style="color:#e74c3c" %)version(%%) of an object will be returned. | ||
| 3908 | |VersionTo|com: TimeRangeValueType|(% style="width:646px" %)VersionTo is used to specify a range which the start date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3909 | |VersionFrom|com: TimeRangeValueType|(% style="width:646px" %)VersionFrom is used to specify a range which the end date of the validity period of (% style="color:#e74c3c" %)version(%%) should fall within to create a successful match. | ||
| 3910 | |VersionActive|xs:boolean|(% style="width:646px" %)VersionActive is used to request object with active or inactive (% style="color:#e74c3c" %)versions(%%), base on the (% style="color:#e74c3c" %)version(%%) validity dates. A value of true indicates that only objects where the current date is within the validity period of the (% style="color:#e74c3c" %)version(%%) will be matched. | ||
| 3911 | |AgencyID|QueryNestedIDType|(% style="width:646px" %)AgencyID is used to match the agency id of the maintained object. | ||
| 3912 | |CustomTypeWhere|CustomTypeWhereType|(% style="width:646px" %)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. | ||
| 3913 | |VtlVersion|com:VersionQueryType|(% style="width:646px" %)Allows querying based on the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) number. | ||
| 3914 | |||
| 3915 | **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. | ||
| 3916 | |||
| 3917 | Derivation: | ||
| 3918 | |||
| 3919 | * //AnnotableWhereType// (extension) | ||
| 3920 | ** //IdentifiableWhereType// (extension) | ||
| 3921 | *** //NameableWhereType// (extension) | ||
| 3922 | **** //ItemWhereType// (restriction) | ||
| 3923 | ***** CustomTypeWhereType | ||
| 3924 | |||
| 3925 | Content: | ||
| 3926 | [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]?, ID?, Name?, Description? | ||
| 3927 | |||
| 3928 | Element Documentation: | ||
| 3929 | |||
| 3930 | (% style="width:1009.29px" %) | ||
| 3931 | |**Name**|**Type**|(% style="width:733px" %)**Documentation** | ||
| 3932 | |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationWhereType|(% style="width:733px" %)[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is a parameter for matching the details of an annotatable object's [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It allows for querying based on the details of an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 3933 | |ID|QueryIDType|(% style="width:733px" %)ID is used to match the id of the identified object. | ||
| 3934 | |Name|QueryTextType|(% style="width:733px" %)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. | ||
| 3935 | |Description|QueryTextType|(% style="width:733px" %)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. | ||
| 3936 | |||
| 3937 | === 2.1.4 Simple Types === | ||
| 3938 | |||
| 3939 | **StructureReturnDetailType: **StructureReturnDetailType contains a set of enumerations that indicate how much detail should be returned for an object. | ||
| 3940 | |||
| 3941 | Derived by restriction of xs:string . | ||
| 3942 | |||
| 3943 | Enumerations: | ||
| 3944 | |||
| 3945 | (% style="width:1009.29px" %) | ||
| 3946 | |**Value**|(% style="width:795px" %)**Documentation** | ||
| 3947 | |Stub|(% style="width:795px" %)Only the identification information and name should be returned. | ||
| 3948 | |CompleteStub|(% style="width:795px" %)Identification information, name, description, and [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]] should be returned. | ||
| 3949 | |Full|(% style="width:795px" %)The entire detail of the object should be returned. | ||
| 3950 | |MatchedItems|(% style="width:795px" %)For an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], only the items matching the item where parameters will be returned. In the case that items are hierarchical, the entire [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] leading to the matched item will have to be returned. | ||
| 3951 | |CascadedMatchedItems|(% style="width:795px" %)For an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], 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>>doc:sdmx:Glossary.Hierarchy.WebHome]] leading to the matched item will have to be returned. | ||
| 3952 | |||
| 3953 | **MaintainableReturnDetailType: **MaintainableReturnDetailType contains a sub set of the enumerations defined in the ReturnDetailType. Enumerations relating specifically to [[item schemes>>doc:sdmx:Glossary.Item scheme.WebHome]] are not included | ||
| 3954 | |||
| 3955 | Derived by restriction of StructureReturnDetailType . | ||
| 3956 | |||
| 3957 | Enumerations: | ||
| 3958 | |||
| 3959 | (% style="width:1011.29px" %) | ||
| 3960 | |(% style="width:273px" %)**Value**|(% style="width:735px" %)**Documentation** | ||
| 3961 | |(% style="width:273px" %)Stub|(% style="width:735px" %)Only the identification information and name should be returned. | ||
| 3962 | |(% style="width:273px" %)CompleteStub|(% style="width:735px" %)Identification information, name, description, and [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]] should be returned. | ||
| 3963 | |(% style="width:273px" %)Full|(% style="width:735px" %)The entire detail of the object should be returned. | ||
| 3964 | |||
| 3965 | **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. | ||
| 3966 | |||
| 3967 | Union of: | ||
| 3968 | AnyQueryType, xs:gMonthDay. | ||
| 3969 | |||
| 3970 | **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. | ||
| 3971 | |||
| 3972 | Derived by restriction of xs:string. | ||
| 3973 | |||
| 3974 | Enumerations: | ||
| 3975 | |||
| 3976 | (% style="width:1012.29px" %) | ||
| 3977 | |(% style="width:235px" %)**Value**|(% style="width:774px" %)**Documentation** | ||
| 3978 | |(% style="width:235px" %)Any|(% style="width:774px" %) | ||
| 3979 | |||
| 3980 | **ConstraintTypeCodelistType: **ConstraintTypeCodelistType defines a list of types for a (% style="color:#e74c3c" %)constraint(%%) for the purpose of querying. | ||
| 3981 | |||
| 3982 | Derived by restriction of com:MaintainableTypeCodelistType . | ||
| 3983 | |||
| 3984 | Enumerations: | ||
| 3985 | |||
| 3986 | (% style="width:1014.29px" %) | ||
| 3987 | |(% style="width:243px" %)**Value**|(% style="width:768px" %)**Documentation** | ||
| 3988 | |(% style="width:243px" %)(% style="color:#e74c3c" %)Constraint|(% style="width:768px" %) | ||
| 3989 | |(% style="width:243px" %)AttachmentConstraint|(% style="width:768px" %) | ||
| 3990 | |(% style="width:243px" %)ContentConstraint|(% style="width:768px" %) | ||
| 3991 | |||
| 3992 | **DataReturnDetailType: **DataReturnDetailType contains a set of enumerations that indicate how much detail should be returned for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 3993 | |||
| 3994 | Derived by restriction of xs:string . | ||
| 3995 | |||
| 3996 | Enumerations: | ||
| 3997 | |||
| 3998 | (% style="width:1016.29px" %) | ||
| 3999 | |**Value**|(% style="width:836px" %)**Documentation** | ||
| 4000 | |Full|(% style="width:836px" %)The entire [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (including all data, documentation, and [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]) will be returned. | ||
| 4001 | |DataOnly|(% style="width:836px" %)Only the observed values and their keys will be returned. [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] and documentation (i.e. [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and therefore Groups, will be excluded. | ||
| 4002 | |SeriesKeyOnly|(% style="width:836px" %)Only the series elements and the values for the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] will be returned. [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], documentation, and observations will be excluded. | ||
| 4003 | |NoData|(% style="width:836px" %)Returns all documentation at the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], Group, and Series (% style="color:#e74c3c" %)level(%%) without any Observations (therefore, Observation (% style="color:#e74c3c" %)level(%%) documentation is not returned). [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] are not returned. | ||
| 4004 | |||
| 4005 | **ObservationActionCodeType: **ObservationActionCodeType enumerates the type of observations to be returned. | ||
| 4006 | |||
| 4007 | Derived by restriction of xs:string . | ||
| 4008 | |||
| 4009 | Enumerations: | ||
| 4010 | |||
| 4011 | (% style="width:1007.29px" %) | ||
| 4012 | |**Value**|(% style="width:774px" %)**Documentation** | ||
| 4013 | |Active|(% style="width:774px" %)Active observations, regardless of when they were added or updated will be returned. | ||
| 4014 | |Added|(% style="width:774px" %)Only newly added observations will be returned. | ||
| 4015 | |Updated|(% style="width:774px" %)Only updated observations will be returned. | ||
| 4016 | |Deleted|(% style="width:774px" %)Only deleted observations will be returned. | ||
| 4017 | |||
| 4018 | **OrganisationSchemeTypeCodeType: **OrganisationSchemeTypeCodeType enumerates the possible types of organisation schemes that can be queried for. | ||
| 4019 | |||
| 4020 | Derived by restriction of com:MaintainableTypeCodelistType . | ||
| 4021 | |||
| 4022 | Enumerations: | ||
| 4023 | |||
| 4024 | (% style="width:1005.29px" %) | ||
| 4025 | |(% style="width:218px" %)**Value**|(% style="width:784px" %)**Documentation** | ||
| 4026 | |(% style="width:218px" %)OrganisationScheme|(% style="width:784px" %) | ||
| 4027 | |(% style="width:218px" %)AgencyScheme|(% style="width:784px" %) | ||
| 4028 | |(% style="width:218px" %)DataConsumerScheme|(% style="width:784px" %) | ||
| 4029 | |(% style="width:218px" %)DataProviderScheme|(% style="width:784px" %) | ||
| 4030 | |(% style="width:218px" %)OrganisationUnitScheme|(% style="width:784px" %) | ||
| 4031 | |||
| 4032 | **InputOutputTypeCodeType: **InputOutputTypeCodeType enumerates the role an object plays in a process step. | ||
| 4033 | |||
| 4034 | Derived by restriction of xs:string . | ||
| 4035 | |||
| 4036 | Enumerations: | ||
| 4037 | |||
| 4038 | (% style="width:1010.29px" %) | ||
| 4039 | |**Value**|(% style="width:783px" %)**Documentation** | ||
| 4040 | |Input|(% style="width:783px" %)Input - referenced object is an input to the process step. | ||
| 4041 | |Output|(% style="width:783px" %)Output - referenced object is an output to the process step. | ||
| 4042 | |Any|(% style="width:783px" %)Any - referenced object is either an input or an output to the process step. | ||
| 4043 | |||
| 4044 | **MappedObjectTypeCodelistType: **MappedObjectTypeCodelistType is a restriction of the MaintainableTypeCodelistType which contains only the object types which can be (% style="color:#e74c3c" %)mapped(%%) in a [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]]. | ||
| 4045 | |||
| 4046 | Derived by restriction of com:ConcreteMaintainableTypeCodelistType . | ||
| 4047 | |||
| 4048 | Enumerations: | ||
| 4049 | |||
| 4050 | (% style="width:1003.29px" %) | ||
| 4051 | |(% style="width:352px" %)**Value**|(% style="width:648px" %)**Documentation** | ||
| 4052 | |(% style="width:352px" %)AgencyScheme|(% style="width:648px" %) | ||
| 4053 | |(% style="width:352px" %)CategoryScheme|(% style="width:648px" %) | ||
| 4054 | |(% style="width:352px" %)[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|(% style="width:648px" %) | ||
| 4055 | |(% style="width:352px" %)ConceptScheme|(% style="width:648px" %) | ||
| 4056 | |(% style="width:352px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:648px" %) | ||
| 4057 | |(% style="width:352px" %)DataConsumerScheme|(% style="width:648px" %) | ||
| 4058 | |(% style="width:352px" %)DataProviderScheme|(% style="width:648px" %) | ||
| 4059 | |(% style="width:352px" %)DataStructure|(% style="width:648px" %) | ||
| 4060 | |(% style="width:352px" %)HierarchicalCodelist|(% style="width:648px" %) | ||
| 4061 | |(% style="width:352px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|(% style="width:648px" %) | ||
| 4062 | |(% style="width:352px" %)MetadataStructure|(% style="width:648px" %) | ||
| 4063 | |(% style="width:352px" %)OrganisationUnitScheme|(% style="width:648px" %) | ||
| 4064 | |(% style="width:352px" %)ReportingTaxonomy|(% style="width:648px" %) | ||
| 4065 | |||
| 4066 | **SourceTargetType: **SourceTargetType is an enumeration to indicate whether an object is the source, target, or either of the two options. | ||
| 4067 | |||
| 4068 | Derived by restriction of xs:string . | ||
| 4069 | |||
| 4070 | Enumerations: | ||
| 4071 | |||
| 4072 | (% style="width:726.294px" %) | ||
| 4073 | |(% style="width:203px" %)**Value**|(% style="width:555px" %)**Documentation** | ||
| 4074 | |(% style="width:203px" %)Any|(% style="width:555px" %) | ||
| 4075 | |(% style="width:203px" %)Source|(% style="width:555px" %) | ||
| 4076 | |(% style="width:203px" %)Target |