Header
- class pysdmx.model.message.Header(*, id: str = '3abafa52-0310-4858-81d4-400302a44ebf', test: bool = False, prepared: datetime = datetime.datetime(2025, 8, 5, 12, 3, 2, 611332, tzinfo=datetime.timezone.utc), sender: Organisation = Organisation(id='ZZZ'), receiver: Organisation | None = None, source: str | None = None, dataset_action: ActionType | None = None, structure: Dict[str, str] | None = None, dataset_id: str | None = None)
Header for the SDMX messages.
Represents the Header of an SDMX message, containing metadata about the message such as the sender, receiver, and other relevant information.
- id
Unique identifier for the message. (default: generated UUID)
- test
Indicates if the message is a test message. (default: False)
- prepared
Timestamp when the message was prepared. (default: current UTC time)
- sender
Organisation that sent the message. (default: Organisation with id “ZZZ”)
- receiver
Optional Organisation that received the message. (default: None)
- source
Optional source of the message. (default: None)
- dataset_action
Optional action for the dataset (only for SDMX Data messages). (default: None)
- structure
Dimension at observation mapping (dict with short URN as key and Dimension ID as value) (only for SDMX Data Messages) (Overridden by dimension_at_observation argument in writers). (default: None)
- dataset_id
DatasetID defined at SDMX-ML (only for SDMX-ML Data messages). (default: None)
Structure Message
- class pysdmx.model.message.StructureMessage(header: Header | None = None, structures: Sequence[MaintainableArtefact] | None = None)
Message class holds the content of an SDMX Structure Message.
- header
The header of the SDMX message.
- structures
Sequence of MaintainableArtefact objects. They represent the contents of a Structure Message.
- get_agency_schemes()
Returns the AgencySchemes.
- Return type:
List[AgencyScheme]
- get_categorisations()
Returns the Categorisations.
- Return type:
List[Categorisation]
- get_category_schemes()
Returns the CategorySchemes.
- Return type:
List[CategoryScheme]
- get_concept_scheme(short_urn)
Returns a specific Concept Scheme.
- Return type:
- get_concept_schemes()
Returns the Concept Schemes.
- Return type:
List[ConceptScheme]
- get_custom_type_schemes()
Returns the CustomType Schemes.
- Return type:
List[CustomTypeScheme]
- get_data_provider_schemes()
Returns the DataProviderSchemes.
- Return type:
List[DataProviderScheme]
- get_data_structure_definition(short_urn)
Returns a specific DataStructureDefinition.
- Return type:
- get_data_structure_definitions()
Returns the DataStructureDefinitions.
- Return type:
List[DataStructureDefinition]
- get_hierarchy_associations()
Returns the HierarchyAssociations.
- Return type:
List[HierarchyAssociation]
- get_name_personalisation_schemes()
Returns the NamePersonalisationSchemes.
- Return type:
- get_organisation_scheme(short_urn)
Returns a specific OrganisationScheme.
- Return type:
- get_provision_agreements()
Returns the ProvisionAgreements.
- Return type:
List[ProvisionAgreement]
- get_representation_maps()
Returns the RepresentationMaps.
- Return type:
List[Union[MultiRepresentationMap,RepresentationMap]]
- get_ruleset_schemes()
Returns the RulesetSchemes.
- Return type:
List[RulesetScheme]
- get_structure_maps()
Returns the StructureMaps.
- Return type:
List[StructureMap]
- get_transformation_schemes()
Returns the TransformationSchemes.
- Return type:
List[TransformationScheme]
- get_user_defined_operator_schemes()
Returns the UserDefinedOperatorSchemes.
- Return type:
- get_vtl_mapping_schemes()
Returns the VTL Mapping Schemes.
- Return type:
List[VtlMappingScheme]
Message
- class pysdmx.model.message.Message(header: Header | None = None, structures: Sequence[MaintainableArtefact] | None = None, data: Sequence[Dataset] | None = None, submission: Sequence[SubmissionResult] | None = None)
Bases:
StructureMessageMessage class holds the content of SDMX Message.
- header
The header of the SDMX message.
- structures
Sequence of MaintainableArtefact objects.
- data
Sequence of Dataset objects. They represent the contents of a SDMX Data Message in any format.
- submission
Sequence of SubmissionResult objects. They represent the contents of a SDMX Submission Message.
- get_agency_schemes()
Returns the AgencySchemes.
- Return type:
List[AgencyScheme]
- get_categorisations()
Returns the Categorisations.
- Return type:
List[Categorisation]
- get_category_schemes()
Returns the CategorySchemes.
- Return type:
List[CategoryScheme]
- get_concept_scheme(short_urn)
Returns a specific Concept Scheme.
- Return type:
- get_concept_schemes()
Returns the Concept Schemes.
- Return type:
List[ConceptScheme]
- get_custom_type_schemes()
Returns the CustomType Schemes.
- Return type:
List[CustomTypeScheme]
- get_data_provider_schemes()
Returns the DataProviderSchemes.
- Return type:
List[DataProviderScheme]
- get_data_structure_definition(short_urn)
Returns a specific DataStructureDefinition.
- Return type:
- get_data_structure_definitions()
Returns the DataStructureDefinitions.
- Return type:
List[DataStructureDefinition]
- get_hierarchy_associations()
Returns the HierarchyAssociations.
- Return type:
List[HierarchyAssociation]
- get_name_personalisation_schemes()
Returns the NamePersonalisationSchemes.
- Return type:
- get_organisation_scheme(short_urn)
Returns a specific OrganisationScheme.
- Return type:
- get_provision_agreements()
Returns the ProvisionAgreements.
- Return type:
List[ProvisionAgreement]
- get_representation_maps()
Returns the RepresentationMaps.
- Return type:
List[Union[MultiRepresentationMap,RepresentationMap]]
- get_ruleset_schemes()
Returns the RulesetSchemes.
- Return type:
List[RulesetScheme]
- get_structure_maps()
Returns the StructureMaps.
- Return type:
List[StructureMap]
- get_transformation_schemes()
Returns the TransformationSchemes.
- Return type:
List[TransformationScheme]
- get_user_defined_operator_schemes()
Returns the UserDefinedOperatorSchemes.
- Return type:
- get_vtl_mapping_schemes()
Returns the VTL Mapping Schemes.
- Return type:
List[VtlMappingScheme]