SDMX-REST Schema Queries

Note

Additional information about how to build SDMX-REST queries can be found in the following tutorial:

• SDMX-REST services.

Build SDMX-REST schema queries.

class pysdmx.api.qb.schema.SchemaContext(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

The context for which a schema must be generated.

class pysdmx.api.qb.schema.SchemaFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

The SDMX Schema formats.

class pysdmx.api.qb.schema.SchemaQuery(context: SchemaContext, agency_id: str, resource_id: str, version: str = '~', obs_dimension: str | None = None, explicit: bool = False)

A schema query.

Schema queries allow retrieving the definition of data validity for a certain context. The service must take into account the constraints that apply within that context (e.g. dataflow).

context

The context for which a schema must be generated. This determines the constraints that will be taken into consideration.

agency_id

The agency maintaining the context to be considered.

resource_id

The id of the context to be considered.

version

The version of the context to be considered.

obs_dimension

The ID of the dimension at the observation level.

get_url(version, omit_defaults=False)

The URL for the query in the selected SDMX-REST API version.

Return type:

str

validate()

Validate the query.

Return type:

None