Expand description
SDMX-JSON Structure Message format, 2.0.0 (aligned with SDMX 3.0.0)
This module implements SDMX-JSON Structure Message 2.0.0. The Structure Message format is used for describing objects in RESTful API services to make data more easily discoverable and consumable.
JSON files in this format are implemented in the top-level root type,
StructureMessage.
They can be deserialized from a &str, a &[u8],
and a Value.
Structs§
- Agency
Scheme - The item scheme for an agency.
- Attribute
- A characteristic of an object or entity.
- Attribute
List - A list of attributes in the data structure definition.
- Attribute
Relationship Dataflow - A type of relationship where the attribute value varies per dataflow.
- Attribute
Relationship Dimensions - A type of relationship where the attribute references dimensions in the data structure definition. The attribute can either be a group, series/section, or an observational attribute.
- Attribute
Relationship Groups - A type of relationship where the attribute references a unique group identifier.
- Attribute
Relationship Observations - A type of relationship where the attribute value may vary with any of the local dimensions, and thus is dependent upon the observed value.
- Categorization
- Describes what something (the source) falls under (the target).
- Category
Scheme - The item scheme for a category.
- Codelist
- The item scheme for a codelist.
- Common
Artefact Type - Properties that all SDMX artefacts share.
- Component
Value Set - The structure for providing values for data attributes, measures, or metadata attributes.
- Concept
Scheme - The item scheme for a concept.
- Constraint
Attachment - A collection of references to data-constrainable artefacts.
- Core
Representation - A core representation for a concept.
- Cube
Region - A subset of data within multi-dimensional data.
- Cube
Region Key - A set of values for a dimension that defines a data cube region.
- Custom
Type Scheme - The item scheme for a custom type.
- Data
- The associated data with a structure message.
- Data
Component Value - A simple value for a component.
- Data
Component Value Set - The structure for providing values for data attributes, measures, or metadata attributes.
- Data
Constraint - A subset of the definition of the allowable (or available) content of a dataset.
- Data
Consumer Scheme - The item scheme for a data consumer.
- DataKey
- A region which defines a distinct full or partial data key.
- Data
KeySet - A collection of full or partial data keys (dimension values).
- Data
KeyValue - A dimension value for the purpose of defining a distinct data key.
- Data
Provider Scheme - The item scheme for a data provider.
- Data
Structure - A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
- Data
Structure Components - A structure of the grouping to the sets of structural concepts that have a defined structural role in the data structure definition.
- Dataflow
- The structure of data that will be provided for different reference periods.
- Dimension
- A dimension which represents a statistical series, such as a time series.
- Dimension
List - Defines the order in which child dimensions will appear in data formats.
- Enumeration
Format - A restricted version of
Formatthat only allows facets and text types applicable to codes. - Format
- The information for describing a range of data formats restricted to the representations allowed for all components except for target objects.
- GeoGrid
Codelist - The item scheme for a geographic grid codelist.
- Geography
Codelist - The item scheme for a geography codelist.
- Group
- Specifies attribute values which have the same value based on some common dimensionality.
- IsoConcept
Reference - A reference to an ISO 11179 concept.
- Item
- An abstract generic item within an item scheme.
- Local
Representation - The data representation of an attribute.
- Measure
- A concept that quantifies the size, amount or degree of something.
- Measure
List - Describes the structure of the measure descriptor for a data structure definition.
- Metadata
Attribute - A metadata characteristic of an object or entity.
- Metadata
Attribute Enumeration - An enumeration-based local representation of a metadata attribute
- Metadata
Attribute Format - A format-based local representation of a metadata attribute
- Metadata
Attribute List - A set of metadata attributes that can be defined as a hierarchy.
- Metadata
Attribute Usage - Defines how a metadata attribute is used within a data structure.
- Metadata
Attribute Value Set - Describes the vaues provided for a metadata attribute.
- Metadata
Constraint - A subset of the definition of the allowable (or available) content of a metadata set.
- Metadata
Constraint Attachment - A collection of references to metadata-constrainable artefacts.
- Metadata
Provider Scheme - The item scheme for a metadata provider.
- Metadata
Structure - A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
- Metadata
Structure Components - A set of components that makeup the metadata structure.
- Metadata
Target Region - Describes the report structure and the metadata target from that structure on which the region is based.
- Name
Personalization Scheme - The item scheme for name personalization.
- Organization
Unit Scheme - The item scheme for an organization unit.
- Queryable
Data Source - A data source which accepts a standard SDMX query message and responds appropriately.
- Release
Calendar - The timing of releases of the constrained data.
- Reporting
Taxonomy - The item scheme for a reporting taxonomy.
- Ruleset
Scheme - The item scheme for a ruleset.
- Simple
Component Value - A simple value for a component.
- Structure
Message - The top-level type of a JSON file that conforms to the SDMX-JSON Structure Message format.
- Time
After Period - Time
Before Period - Time
Between Period - Time
Dimension - A statistical series representing time.
- Time
Dimension Format - A representation of a time dimension, which may contain sentinel values.
- Time
Period Range - A time period that describes whether a period is inclusive in a range.
- Transformation
Scheme - The item scheme for a transformation.
- User
Defined Operators Scheme - The item scheme for a user defined operator.
- VtlMapping
Scheme - The item scheme for a VTL (Validation and Transformation Language) mapping.
Enums§
- Attribute
Relationship - The association between an attribute and other data structure definition components.
- Cascade
Values - Indicates whether a value should be cascaded.
- Metadata
Attribute Representation - The possible local representations of a metadata attribute
- Occurrence
- The max occurrences of something, which can either be an unsigned integer or unbounded (can occur without any upper limit).
- Role
- The purpose of a constraint, which informs the constraint if the data is actually present, or if it defines what data is allowed.
- String
OrDcv - A string or data component value.
- String
OrScv - A string or simple component value.
- Time
Data Type - The specific data type of a time dimension.
- Time
Range Value - A time period value expressed as a range.
- Usage
- Indicates whether something is required or optional.
Traits§
- Artefact
- A primitive type defined within the SDMX Informational Model specification.
- Item
Scheme - A primitive type which may or may not contain zero or more items, where said items may either be a subset or full collection.