QueryBuilder

SDMX API v1

class sdmxthon.webservices.query_builder.SdmxWs1

Bases: SdmxWebservice

Generic Sdmx Ws 1 implementation for queries that do not change

CONSTRAINTS_MODE_OPTIONS = ['exact', 'available']
CONSTRAINTS_REFERENCES_OPTIONS = ['none', 'all', 'datastructure', 'conceptscheme', 'codelist', 'dataproviderscheme', 'dataflow']
DATA_DETAIL_OPTIONS = ['full', 'dataonly', 'serieskeysonly', 'nodata']
DATA_HISTORY_OPTIONS = ['true', 'false']
REFERENCES_OPTIONS = ['none', 'parents', 'parentsandsiblings', 'children', 'descendants', 'all', 'datastructure', 'metadatastructure', 'categoryscheme', 'conceptscheme', 'codelist', 'hierarchicalcodelist', 'organisationscheme', 'agencyscheme', 'dataproviderscheme', 'dataconsumerscheme', 'organisationunitscheme', 'dataflow', 'metadataflow', 'reportingtaxonomy', 'provisionagreement', 'structureset', 'process', 'categorisation', 'contentconstraint', 'actualconstraint', 'allowedconstraint', 'attachmentconstraint', 'transformationscheme', 'rulesetscheme', 'userdefinedoperatorscheme', 'customtypescheme', 'namepersonalisationscheme', 'namealiassccheme']
STRUCTURE_DETAIL_OPTIONS = ['full', 'allstubs', 'referencestubs', 'referencepartial', 'allcompletestubs', 'referencecompletestubs']
build_query(query, agency_id=None, resources=None, version=None, references=None, detail=None) → str
build_query_with_item(query, agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str
common_schemas_queries(context, agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)
get_actual_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the actual constraints

Parameters:

  • agency_id – The agency id of the actual constraints

  • resources – The resources to query

  • version – The version of the actual constraints

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_agencies(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get agencies

Parameters:

  • agency_id – The agency id of the agencies

  • resources – The resources to query

  • version – The version of the agencies

  • item_id – The id of the item of the agencies

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_agency_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get agency schemes

Parameters:

  • agency_id – The agency id of the agency schemes

  • resources – The resources to query

  • version – The version of the agency schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_agency_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the agency schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the agency schemes

  • resources (str) – The resources to query

  • version (str) – The version of the agency schemes

  • item_id (str) – The id of the item of the agency schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_allowed_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the allowed constraints

Parameters:

  • agency_id – The agency id of the allowed constraints

  • resources – The resources to query

  • version – The version of the allowed constraints

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_attachment_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the attachment constraints

Parameters:

  • agency_id – The agency id of the attachment constraints

  • resources – The resources to query

  • version – The version of the attachment constraints

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_categories(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get categories

Parameters:

  • agency_id – The agency id of the categories

  • resources – The resources to query

  • version – The version of the categories

  • item_id – The id of the item of the categories

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_categorisation(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the categorisations

Parameters:

  • agency_id – The agency id of the categorisations

  • resources – The resources to query

  • version – The version of the categorisations

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_category_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get category schemes

Parameters:

  • agency_id – The agency id of the category schemes

  • resources – The resources to query

  • version – The version of the category schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_category_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the category schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the category schemes

  • resources (str) – The resources to query

  • version (str) – The version of the category schemes

  • item_id (str) – The id of the item of the category schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_category_scheme_map(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the category scheme maps (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the category scheme maps

  • resources (str) – The resources to query

  • version (str) – The version of the category scheme maps

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_code_list(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get codelists

Parameters:

  • agency_id – The agency id of the codelists

  • resources – The resources to query

  • version – The version of the codelists

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_codelist_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the code lists in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the code lists

  • resources (str) – The resources to query

  • version (str) – The version of the code lists

  • item_id (str) – The id of the item of the code lists

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_codes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get codes

Parameters:

  • agency_id – The agency id of the codes

  • resources – The resources to query

  • version – The version of the codes

  • item_id – The id of the item of the codes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_concept_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get concept schemes

Parameters:

  • agency_id – The agency id of the concept schemes

  • resources – The resources to query

  • version – The version of the concept schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_concept_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the concept schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the concept schemes

  • resources (str) – The resources to query

  • version (str) – The version of the concept schemes

  • item_id (str) – The id of the item of the concept schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_concept_scheme_map(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the concept scheme maps (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the concept scheme maps

  • resources (str) – The resources to query

  • version (str) – The version of the concept scheme maps

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_concepts(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get concepts

Parameters:

  • agency_id – The agency id of the concepts

  • resources – The resources to query

  • version – The version of the concepts

  • item_id – The id of the item of the concepts

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_constraint_all_contexts(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get the constraints

Parameters:

  • agency_id (str) – The agency id of the constraints (all possible contexts)

  • resources (str) – The resources to query

  • version (str) – The version of the constraints (all possible contexts)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id (str) – The component id of the constraints (all possible contexts)

  • c (str) – Filter data by component value

  • mode (str) – The mode parameter (exact, available)

  • references (str) – The references parameter (none, all, datastructure, conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after (str) – Data filtered by the last update date

get_constraint_dataflows(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get the constraints (dataflow)

Parameters:

  • agency_id (str) – The agency id of the constraints (dataflow)

  • resources (str) – The resources to query

  • version (str) – The version of the constraints (dataflow)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id (str) – The component id of the constraints (dataflow)

  • c (str) – Filter data by component value

  • mode (str) – The mode parameter (exact, available)

  • references (str) – The references parameter (none, all, datastructure, conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after (str) – Data filtered by the last update date

get_constraint_datastructures(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get the constraints (datastructure)

Parameters:

  • agency_id (str) – The agency id of the constraints (datastructure)

  • resources (str) – The resources to query

  • version (str) – The version of the constraints (datastructure)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id (str) – The component id of the constraints (datastructure)

  • c (str) – Filter data by component value

  • mode (str) – The mode parameter (exact, available)

  • references (str) – The references parameter (none, all, datastructure, conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after (str) – Data filtered by the last update date

get_constraint_provision_agreements(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get the constraints (provision agreement)

Parameters:

  • agency_id (str) – The agency id of the constraints (provision agreement)

  • resources (str) – The resources to query

  • version (str) – The version of the constraints (provision agreement)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id (str) – The component id of the constraints (provision agreement)

  • c (str) – Filter data by component value

  • mode (str) – The mode parameter (exact, available)

  • references (str) – The references parameter (none, all, datastructure, conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after (str) – Data filtered by the last update date

get_constraints(flow, key=None, provider=None, component_id=None, mode=None, references=None, start_period=None, end_period=None, updated_after=None)

Returns URL and params to get the constraints

Parameters:

  • flow – The id of the dataflow

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • provider – The provider of the data

  • component_id – The component id of the data

  • mode – The mode parameter (exact, available)

  • references – The references parameter (‘none’, ‘all’, ‘datastructure’, ‘conceptscheme’, ‘codelist’, ‘dataproviderscheme’, ‘dataflow’)

  • start_period – The start period of the dataflow

  • end_period – The end period of the dataflow

  • updated_after – Data filtered by the last update date

Returns:

The URL and params formatted

get_content_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the content constraints

Parameters:

  • agency_id – The agency id of the content constraints

  • resources – The resources to query

  • version – The version of the content constraints

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_custom_type_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get user custom type schemes

Parameters:

  • agency_id – The agency id of the custom type schemes

  • resources – The resources to query

  • version – The version of the custom type schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_custom_type_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the custom type schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the custom type schemes

  • resources (str) – The resources to query

  • version (str) – The version of the custom type schemes

  • item_id (str) – The id of the item of the custom type schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_custom_type_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get custom type schemes

Parameters:

  • agency_id – The agency id of the custom type schemes

  • resources – The resources to query

  • version – The version of the custom type schemes

  • item_id – The id of the item of the custom type schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_data(flow, key=None, provider=None, start_period=None, end_period=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, detail=None, include_history=None) → str

Returns URL and params to get data

Parameters:

  • flow – The id of the dataflow

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • provider – The provider of the data

  • start_period – Start period of the data

  • end_period – End period of the data query

  • updated_after – Data filtered by the last update date

  • first_n_observations – Number of first observations to be returned per key (int)

  • last_n_observations – Number of last observations to be returned per key (int)

  • dimension_at_observation – The dimension at observation

  • detail – The detail parameter (‘full’, ‘dataonly’, ‘serieskeysonly’, ‘nodata’)

  • include_history – Value to include history (true, false)

Returns:

The URL and params formatted

get_data_all_contexts(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data (all possible contexts)

Parameters:

  • agency_id (str) – The agency id of data (all possible contexts)

  • resources (str) – The resources to query

  • version (str) – The version of the data (all possible contexts)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c (str) – Filter data by component value

  • updated_after (str) – Data filtered by the last update date

  • first_n_observations (int) – Number of first observations to be returned per key

  • last_n_observations (int) – Number of last observations to be returned per key

  • dimension_at_observation (str) – The dimension at observation of the data (all possible contexts)

  • attributes (str) – Attributes of the data (all possible contexts)

  • measures (str) – The measures of the data (all possible contexts)

  • include_history (str) – The include history of the data (by all possible contexts) (true, false)

get_data_constraint(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the data constraint (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the data constraint

  • resources (str) – The resources to query

  • version (str) – The version of the data constraint

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_data_consumer_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get data consumer schemes

Parameters:

  • agency_id – The agency id of the data consumer schemes

  • resources – The resources to query

  • version – The version of the data consumer schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_data_consumer_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the data consumer schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the data consumer schemes

  • resources (str) – The resources to query

  • version (str) – The version of the data consumer schemes

  • item_id (str) – The id of the item of the data consumer schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_data_consumers(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get data consumers

Parameters:

  • agency_id – The agency id of the data consumers

  • resources – The resources to query

  • version – The version of the data consumers

  • item_id – The id of the item of the data consumers

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_data_dataflows(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data (dataflow)

Parameters:

  • agency_id (str) – The agency id of the data (dataflow)

  • resources (str) – The resources to query

  • version (str) – The version of the data (dataflow)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c (str) – Filter data by component value

  • updated_after (str) – Data filtered by the last update date

  • first_n_observations (int) – Number of first observations to be returned per key

  • last_n_observations (int) – Number of last observations to be returned per key

  • dimension_at_observation (str) – The dimension at observation of the data (dataflow)

  • attributes (str) – Attributes of the dataflow

  • measures (str) – The measures of the dataflow

  • include_history (str) – The include history of the data (by dataflow) (true, false)

get_data_datastructures(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data (datastructure)

Parameters:

  • agency_id (str) – The agency id of the data (datastructure)

  • resources (str) – The resources to query

  • version (str) – The version of the data (datastructure)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c (str) – Filter data by component value

  • updated_after (str) – Data filtered by the last update date

  • first_n_observations (int) – Number of first observations to be returned per key

  • last_n_observations (int) – Number of last observations to be returned per key

  • dimension_at_observation (str) – The dimension at observation of the data (datastructure)

  • attributes (str) – Attributes of the data (datastructure)

  • measures (str) – The measures of the data (datastructure)

  • include_history (str) – The include history of the data (by datastructure) (true, false)

get_data_flows(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get dataflows

Parameters:

  • agency_id – The agency id of the dataflows

  • resources – The resources to query

  • version – The version of the dataflows

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_data_provider_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get data provider schemes

Parameters:

  • agency_id – The agency id of the data provider schemes

  • resources – The resources to query

  • version – The version of the data provider schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_data_provider_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the data provider schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the data provider schemes

  • resources (str) – The resources to query

  • version (str) – The version of the data provider schemes

  • item_id (str) – The id of the item of the data provider schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_data_providers(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get data providers

Parameters:

  • agency_id – The agency id of the data providers

  • resources – The resources to query

  • version – The version of the data providers

  • item_id – The id of the item of the data providers

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_data_provision_agreements(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data (provision agreement)

Parameters:

  • agency_id (str) – The agency id of the data (provision agreement)

  • resources (str) – The resources to query

  • version (str) – The version of the data (provision agreement)

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c (str) – Filter data by component value

  • updated_after (str) – Data filtered by the last update date

  • first_n_observations (int) – Number of first observations to be returned per key

  • last_n_observations (int) – Number of last observations to be returned per key

  • dimension_at_observation (str) – The dimension at observation of the data (provision agreement)

  • attributes (str) – Attributes of the data (provision agreement)

  • measures (str) – The measures of the data (provision agreement)

  • include_history (str) – The include history of the data (by provision agreement) (true, false)

get_dsds(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the data structures definitions

Parameters:

  • agency_id – The agency id of the data structures

  • resources – The resources to query

  • version – The version of the data structures

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_hierarchical_codelist(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get hierarchical codelists

Parameters:

  • agency_id – The agency id of the hierarchical codelists

  • resources – The resources to query

  • version – The version of the hierarchical codelists

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_hierarchies(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get hierarchies

Parameters:

  • agency_id – The agency id of the hierarchies

  • resources – The resources to query

  • version – The version of the hierarchies

  • item_id – The id of the item of the hierarchies

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_hierarchy(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the hierarchy (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the hierarchy

  • resources (str) – The resources to query

  • version (str) – The version of the hierarchy

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_hierarchy_association(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the hierarchy association (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the hierarchy association

  • resources (str) – The resources to query

  • version (str) – The version of the hierarchy association

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_mdsds(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the metadata structures definitions

Parameters:

  • agency_id – The agency id of the metadata structures

  • resources – The resources to query

  • version – The version of the metadata structures

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’)

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_meta_data_flows(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the metadata flows

Parameters:

  • agency_id – The agency id of the metadata flows

  • resources – The resources to query

  • version – The version of the metadata flows

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’)

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_metadata_agency_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get agency schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the agency schemes

  • resources (str) – The resources to query

  • version (str) – The version of the agency schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_categorisations(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get categorisations in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the categorisations

  • resources (str) – The resources to query

  • version (str) – The version of the categorisations

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_category_scheme_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get category scheme maps in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the category scheme maps

  • resources (str) – The resources to query

  • version (str) – The version of the category scheme maps

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_category_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get category schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the category schemes

  • resources (str) – The resources to query

  • version (str) – The version of the category schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_code_lists(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get codelists in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the codelists

  • resources (str) – The resources to query

  • version (str) – The version of the code lists

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_concept_scheme_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get concept scheme maps in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the concept scheme maps

  • resources (str) – The resources to query

  • version (str) – The version of the concept scheme maps

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_concept_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get concept schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the concept schemes

  • resources (str) – The resources to query

  • version (str) – The version of the concept schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_constraint(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the metadata constraint (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the metadata constraint

  • resources (str) – The resources to query

  • version (str) – The version of the metadata constraint

  • references (str) – The references parameter of SdmxWs2p0 (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_metadata_custom_type_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get custom type schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the custom type schemes

  • resources (str) – The resources to query

  • version (str) – The version of the custom type schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_data_constraints(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data constraints in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the data constraints

  • resources (str) – The resources to query

  • version (str) – The version of the data constraints

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_data_consumer_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data consumer schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the data consumer schemes

  • resources (str) – The resources to query

  • version (str) – The version of the data consumer schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_data_provider_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data provider schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the data provider schemes

  • resources (str) – The resources to query

  • version (str) – The version of the data provider schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_dataflows(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get dataflows in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the dataflows

  • resources (str) – The resources to query

  • version (str) – The version of the dataflows

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_dsds(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data structures in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the data structures

  • resources (str) – The resources to query

  • version (str) – The version of the data structures

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_hierarchies(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get hierarchies in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the hierarchies

  • resources (str) – The resources to query

  • version (str) – The version of the hierarchies

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_hierarchy_associations(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get hierarchy associations in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the hierarchy associations

  • resources (str) – The resources to query

  • version (str) – The version of the hierarchy associations

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_mdsds(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get metadata structures in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the metadata structures

  • resources (str) – The resources to query

  • version (str) – The version of the metadata structures

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_metadata_constraints(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get metadata constraints in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the metadata constraints

  • resources (str) – The resources to query

  • version (str) – The version of the metadata constraints

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_metadata_flows(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get metadata flows in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the metadata flows

  • resources (str) – The resources to query

  • version (str) – The version of the metadata flows

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_metadataflow_query(agency_id=None, resources=None, version=None, provider_id=None, detail=None) → str

Returns URL and params to get metadata flows in Metadata queries (by metadataflow) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the metadata flows

  • resources (str) – The resources to query

  • version (str) – The version of the metadata flows

  • provider_id (str) – The provider of metadata

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_metadataset_query(agency_id=None, resources=None, version=None, provider_id=None, detail=None) → str

Returns URL and params to get metadata sets in Metadata queries (by metadatasets) (V2.0.0)

Parameters:

  • provider_id (str) – The provider of metadata

  • resources (str) – The resources to query

  • version (str) – The version of the metadata sets

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_name_personalisation_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get name personalisation scheme in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the name personalisation scheme

  • resources (str) – The resources to query

  • version (str) – The version of the name personalisation scheme

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_organisation_scheme_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get organisation scheme maps in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the organisation scheme maps

  • resources (str) – The resources to query

  • version (str) – The version of the organisation scheme maps

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_organisation_unit_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get organisation unit schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the organisation unit schemes

  • resources (str) – The resources to query

  • version (str) – The version of the organisation unit schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_processes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get processes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the processes

  • resources (str) – The resources to query

  • version (str) – The version of the processes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_provision_agreements(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get provision agreements in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the provision agreements

  • resources (str) – The resources to query

  • version (str) – The version of the provision agreements

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_reporting_taxonomy_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get reporting taxonomy maps in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the reporting taxonomy maps

  • resources (str) – The resources to query

  • version (str) – The version of the reporting taxonomy maps

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_representation_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get representation maps in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the representation maps

  • resources (str) – The resources to query

  • version (str) – The version of the representation maps

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_ruleset_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get ruleset schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the ruleset schemes

  • resources (str) – The resources to query

  • version (str) – The version of the ruleset schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_structure_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get structure maps in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the structure maps

  • resources (str) – The resources to query

  • version (str) – The version of the structure maps

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_structure_sets(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get structure sets in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the structure sets

  • resources (str) – The resources to query

  • version (str) – The version of the structure sets

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_transformation_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get transformation schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the transformation schemes

  • resources (str) – The resources to query

  • version (str) – The version of the transformation schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_user_defined_operator_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get user defined operator schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the user defined operator schemes

  • resources (str) – The resources to query

  • version (str) – The version of the user defined operator schemes

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_value_lists(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get value lists in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the value lists

  • resources (str) – The resources to query

  • version (str) – The version of the value lists

  • detail (str) – The detail parameter (allstubs, full)

get_metadata_vtl_mapping_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get vtl mapping schemes in Metadata queries (by structure) (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the vtl mapping schemes

  • resources (str) – The resources to query

  • version (str) – The version of the vtl mapping schemes

  • detail (str) – The detail parameter (allstubs, full)

get_name_alias_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get name alias schemes

Parameters:

  • agency_id – The agency id of the name alias schemes

  • resources – The resources to query

  • version – The version of the name alias schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_name_alias_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get name alias schemes

Parameters:

  • agency_id – The agency id of the name alias schemes

  • resources – The resources to query

  • version – The version of the name alias schemes

  • item_id – The id of the item of the name alias schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_name_personalisation_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get name personalisation schemes

Parameters:

  • agency_id – The agency id of the name personalisation schemes

  • resources – The resources to query

  • version – The version of the name personalisation schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_name_personalisation_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the name personalisation schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the name personalisation schemes

  • resources (str) – The resources to query

  • version (str) – The version of the name personalisation schemes

  • item_id (str) – The id of the item of the name personalisation schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_name_personalisation_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get name personalisation schemes

Parameters:

  • agency_id – The agency id of the name personalisation schemes

  • resources – The resources to query

  • version – The version of the name personalisation schemes

  • item_id – The id of the item of the name personalisation schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_organisation_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get organisation schemes

Parameters:

  • agency_id – The agency id of the organisation schemes

  • resources – The resources to query

  • version – The version of the organisation schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_organisation_scheme_map(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the organisation scheme maps (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the organisation scheme maps

  • resources (str) – The resources to query

  • version (str) – The version of the organisation scheme maps

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_organisation_unit_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get organisation unit schemes

Parameters:

  • agency_id – The agency id of the organisation unit schemes

  • resources – The resources to query

  • version – The version of the organisation unit schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_organisation_unit_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the organisation unit schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the organisation unit schemes

  • resources (str) – The resources to query

  • version (str) – The version of the organisation unit schemes

  • item_id (str) – The id of the item of the organisation unit schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_organisation_unit_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get organisation unit schemes

Parameters:

  • agency_id – The agency id of the organisation unit schemes

  • resources – The resources to query

  • version – The version of the organisation unit schemes

  • item_id – The id of the item of the organisation unit schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_organisations(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get organisations

Parameters:

  • agency_id – The agency id of the organisations

  • resources – The resources to query

  • version – The version of the organisations

  • item_id – The id of the item of the organisations

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_process(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the processes

Parameters:

  • agency_id – The agency id of the processes

  • resources – The resources to query

  • version – The version of the processes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_provision_agreements(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the provision agreements

Parameters:

  • agency_id – The agency id of the provision agreements

  • resources – The resources to query

  • version – The version of the provision agreements

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_reporting_taxonomy_map(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the reporting taxonomy maps (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the reporting taxonomy maps

  • resources (str) – The resources to query

  • version (str) – The version of the reporting taxonomy maps

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_representation_map(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the representation maps (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the representation maps

  • resources (str) – The resources to query

  • version (str) – The version of the representation maps

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_ruleset_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get ruleset schemes

Parameters:

  • agency_id – The agency id of the ruleset schemes

  • resources – The resources to query

  • version – The version of the ruleset schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_ruleset_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the ruleset schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the ruleset schemes

  • resources (str) – The resources to query

  • version (str) – The version of the ruleset schemes

  • item_id (str) – The id of the item of the ruleset schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_ruleset_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get ruleset schemes

Parameters:

  • agency_id – The agency id of the ruleset schemes

  • resources – The resources to query

  • version – The version of the ruleset schemes

  • item_id – The id of the item of the ruleset schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_schema_dataflows(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (dataflow)

Parameters:

  • agency_id (str) – The agency id of the schema (dataflow)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (dataflow)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed

get_schema_datastructures(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (datastructure)

Parameters:

  • agency_id (str) – The agency id of the schema (datastructure)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (datastructure)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed

get_schema_meta_dataflows(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (metadataflow)

Parameters:

  • agency_id (str) – The agency id of the schema (metadataflow)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (metadataflow)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed

get_schema_meta_datastructures(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (metadatastructure)

Parameters:

  • agency_id (str) – The agency id of the schema (metadatastructure)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (metadatastructure)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed

get_schema_provision_agreements(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (provision agreement)

Parameters:

  • agency_id (str) – The agency id of the schema (provision agreement)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (provision agreement)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed

get_schemas_dataflow(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (dataflow)

Parameters:

  • agency_id – The id of the schema (dataflow)

  • resources – The resources to query

  • version – The version of the schema (dataflow)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (true, false)

Returns:

The URL and params formatted

get_schemas_datastructure(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (datastructure)

Parameters:

  • agency_id – The id of the schema (datastructure)

  • resources – The resources to query

  • version – The version of the schema (datastructure)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (true, false)

Returns:

The URL and params formatted

get_schemas_meta_dataflow(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (metadataflow)

Parameters:

  • agency_id – The id of the schema (metadataflow)

  • resources – The resources to query

  • version – The version of the schema (metadataflow)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (true, false)

get_schemas_meta_datastructure(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (metadatastructure)

Parameters:

  • agency_id – The id of the schema (metadatastructure)

  • resources – The resources to query

  • version – The version of the schema (metadatastructure)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (true, false)

Returns:

The URL and params formatted

get_schemas_provision_agreement(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (provision agreement)

Parameters:

  • agency_id – The id of the schema (provision agreement)

  • resources – The resources to query

  • version – The version of the schema (provision agreement)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (true, false)

get_structure(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the structures

Parameters:

  • agency_id – The agency id of the structures

  • resources – The resources to query

  • version – The version of the structures

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_structure_map(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the structure maps (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the structure maps

  • resources (str) – The resources to query

  • version (str) – The version of the structuremap

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_structure_sets(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the structure sets

Parameters:

  • agency_id – The agency id of the structure sets

  • resources – The resources to query

  • version – The version of the structure sets

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_transformation_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get transformation schemes

Parameters:

  • agency_id – The agency id of the transformation schemes

  • resources – The resources to query

  • version – The version of the transformation schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_transformation_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the transformation schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the transformation schemes

  • resources (str) – The resources to query

  • version (str) – The version of the transformation schemes

  • item_id (str) – The id of the item of the transformation schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_transformation_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get transformation schemes

Parameters:

  • agency_id – The agency id of the transformation schemes

  • resources – The resources to query

  • version – The version of the transformation schemes

  • item_id – The id of the item of the transformation schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_user_defined_operator_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get user defined operator schemes

Parameters:

  • agency_id – The agency id of the user defined operator schemes

  • resources – The resources to query

  • version – The version of the user defined operator schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_user_defined_operator_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the user defined operator schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the user defined operator schemes

  • resources (str) – The resources to query

  • version (str) – The version of the user defined operator schemes

  • item_id (str) – The id of the item of the user defined operator schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_user_defined_operator_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get user defined operator schemes

Parameters:

  • agency_id – The agency id of the user defined operator schemes

  • resources – The resources to query

  • version – The version of the user defined operator schemes

  • item_id – The id of the item of the user defined operator schemes

  • references – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail – The detail parameter (‘allstubs’, ‘referencestubs’, ‘referencepartial’, ‘allcompletestubs’, ‘referencecompletestubs’, ‘full’)

Returns:

The URL and params formatted

get_value_list(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the value lists (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the value lists

  • resources (str) – The resources to query

  • version (str) – The version of the value lists

  • references (str) – The references parameter of SdmxWs2p0 (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_value_list_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the value lists in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the value lists

  • resources (str) – The resources to query

  • version (str) – The version of the value lists

  • item_id (str) – The id of the item of the value lists

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_vtl_mapping_scheme(agency_id, resources, version, references=None, detail=None) → str

Returns URL and params to get the vtl mapping schemes (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the vtl mapping schemes

  • resources (str) – The resources to query

  • version (str) – The version of the vtl mapping schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

get_vtl_mapping_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the vtl mapping schemes in Item Scheme Queries (V2.0.0)

Parameters:

  • agency_id (str) – The agency id of the vtl mapping schemes

  • resources (str) – The resources to query

  • version (str) – The version of the vtl mapping schemes

  • item_id (str) – The id of the item of the vtl mapping schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘ancestors’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchy’, ‘hierarchyassociation’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘dataconstraint’, ‘metadataconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiasscheme’, ‘valuelist’, ‘structuremap’, ‘representationmap’, ‘conceptscheme’, ‘categoryschememap’, ‘organisationschememap’, ‘reportingtaxonomymap’)

  • detail (str) – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

SDMX API v2

class sdmxthon.webservices.query_builder.SdmxWs2p0

Bases: SdmxWebservice

SDMX Web Service 2.0 specification

Parameters:

  • REFERENCES_OPTIONS (list[str]) – The allowed values for the references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme, namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • STRUCTURE_DETAIL_OPTIONS (list[str]) – The allowed values for the detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

  • DATA_DETAIL_OPTIONS (list[str]) – The allowed values for the detail parameter

CONSTRAINTS_MODE_OPTIONS = ['exact', 'available']
CONSTRAINTS_REFERENCES_OPTIONS = ['none', 'all', 'datastructure', 'conceptscheme', 'codelist', 'dataproviderscheme', 'dataflow']
DATA_HISTORY_OPTIONS = ['true', 'false']
METADATA_STRUCTURE_DETAIL_OPTIONS = ['full', 'allstubs']
REFERENCES_OPTIONS = ['none', 'parents', 'parentsandsiblings', 'ancestors', 'children', 'descendants', 'all', 'datastructure', 'metadatastructure', 'categoryscheme', 'conceptscheme', 'codelist', 'hierarchy', 'hierarchyassociation', 'agencyscheme', 'dataproviderscheme', 'dataconsumerscheme', 'organisationunitscheme', 'dataflow', 'metadataflow', 'reportingtaxonomy', 'provisionagreement', 'structureset', 'process', 'categorisation', 'dataconstraint', 'metadataconstraint', 'transformationscheme', 'rulesetscheme', 'userdefinedoperatorscheme', 'customtypescheme', 'namepersonalisationscheme', 'namealiasscheme', 'valuelist', 'structuremap', 'representationmap', 'conceptscheme', 'categoryschememap', 'organisationschememap', 'reportingtaxonomymap']
SCHEMA_EXPLICIT_MEASURE = ['true', 'false']
STRUCTURE_DETAIL_OPTIONS = ['full', 'allstubs', 'referencestubs', 'allcompletestubs', 'referencecompletestubs', 'referencepartial', 'raw']
common_constraints_queries(context, agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)
common_data_queries(context, agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)
common_item_scheme_queries(item_scheme_type, agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str
common_metadata_structure_queries(structure_type, agency_id=None, resources=None, version=None, detail=None) → str
common_schema_queries(context, agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)
common_structure_queries(structure_type, agency_id=None, resources=None, version=None, references=None, detail=None) → str
get_actual_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the actual constraints

Parameters:

  • agency_id (str) – The agency id of the actual constraints

  • resources (str) – The resources to query

  • version (str) – The version of the actual constraints

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_agencies(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the agencies

Parameters:

  • agency_id (str) – The agency id of the agencies

  • resources (str) – The resources to query

  • version (str) – The version of the agencies

  • item_id (str) – The id of the item of the agencies

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_agency_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get agency schemes

Parameters:

  • agency_id – The agency id of agency schemes

  • resources – The resources to query

  • version – The version of the agency schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_agency_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get agency schemes in item scheme queries

Parameters:

  • agency_id – The agency id of agency schemes

  • resources – The resources to query

  • version – The version of the agency schemes

  • item_id – The id of the item of the agency schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_allowed_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the allowed constraints

Parameters:

  • agency_id (str) – The agency id of the allowed constraints

  • resources (str) – The resources to query

  • version (str) – The version of the allowed constraints

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_attachment_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the attachment constraints

Parameters:

  • agency_id (str) – The agency id of the attachment constraints

  • resources (str) – The resources to query

  • version (str) – The version of the attachment constraints

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_categories(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the categories

Parameters:

  • agency_id (str) – The agency id of the categories

  • resources (str) – The resources to query

  • version (str) – The version of the categories

  • item_id (str) – The id of the item of the categories

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_categorisation(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get categorisations

Parameters:

  • agency_id – The agency id of categorisations

  • resources – The resources to query

  • version – The version of the categorisations

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_category_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get category schemes

Parameters:

  • agency_id – The agency id of category schemes

  • resources – The resources to query

  • version – The version of the category schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_category_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get category schemes in item scheme queries

Parameters:

  • agency_id – The agency id of category schemes

  • resources – The resources to query

  • version – The version of the category schemes

  • item_id – The id of the item of the category schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_category_scheme_map(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get category scheme maps

Parameters:

  • agency_id – The agency id of category scheme maps

  • resources – The resources to query

  • version – The version of the category scheme maps

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_code_list(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get codelists

Parameters:

  • agency_id – The agency id of codelists

  • resources – The resources to query

  • version – The version of the codelists

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_codelist_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get codelists in item scheme queries

Parameters:

  • agency_id – The agency id of codelists

  • resources – The resources to query

  • version – The version of the codelists

  • item_id – The id of the item of the codelists

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_codes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the codes

Parameters:

  • agency_id (str) – The agency id of the codes

  • resources (str) – The resources to query

  • version (str) – The version of the codes

  • item_id (str) – The id of the item of the codes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_concept_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get concept schemes

Parameters:

  • agency_id – The agency id of concept schemes

  • resources – The resources to query

  • version – The version of the concept schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_concept_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get concept schemes

Parameters:

  • agency_id – The agency id of concept schemes in item scheme queries

  • resources – The resources to query

  • version – The version of the concept schemes

  • item_id – The id of the item of the concept schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_concept_scheme_map(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get concept scheme maps

Parameters:

  • agency_id – The agency id of concept scheme maps

  • resources – The resources to query

  • version – The version of the concept scheme maps

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_concepts(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the concepts

Parameters:

  • agency_id (str) – The agency id of the concepts

  • resources (str) – The resources to query

  • version (str) – The version of the concepts

  • item_id (str) – The id of the item of the concepts

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_constraint_all_contexts(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get constraints

Parameters:

  • agency_id – The id of the constraint (all possible contexts)

  • resources – The resources to query

  • version – The version of the constraint (all possible contexts)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id – The id of the dimension of constraint (all possible contexts)

  • c – Filter data by component value

  • version – The version of the constraint (all possible contexts)

  • mode – The mode parameter (exact, available)

  • references – The references parameter (none, all, datastructure,conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after – Data filtered by the last update date

Returns:

The URL and params formatted

get_constraint_dataflows(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get constraints

Parameters:

  • agency_id – The id of the constraint (dataflow)

  • resources – The resources to query

  • version – The version of the constraint (dataflow)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id – The id of the dimension of constraint (dataflow)

  • c – Filter data by component value

  • version – The version of the constraint (dataflow)

  • mode – The mode parameter (exact, available)

  • references – The references parameter (none, all, datastructure,conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after – Data filtered by the last update date

Returns:

The URL and params formatted

get_constraint_datastructures(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get constraints

Parameters:

  • agency_id – The id of the constraint (datastructure)

  • resources – The resources to query

  • version – The version of the constraint (datastructure)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id – The id of the dimension of constraint (datastructure)

  • c – Filter data by component value

  • version – The version of the constraint (datastructure)

  • mode – The mode parameter (exact, available)

  • references – The references parameter (none, all, datastructure,conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after – Data filtered by the last update date

Returns:

The URL and params formatted

get_constraint_provision_agreements(agency_id=None, resources=None, version=None, key=None, component_id=None, c=None, mode=None, references=None, updated_after=None)

Returns URL and params to get constraints

Parameters:

  • agency_id – The id of the constraint (provision agreement)

  • resources – The resources to query

  • version – The version of the constraint (provision agreement)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • component_id – The id of the dimension of constraint (provision agreement)

  • c – Filter data by component value

  • version – The version of the constraint (provision agreement)

  • mode – The mode parameter (exact, available)

  • references – The references parameter (none, all, datastructure,conceptscheme, codelist, dataproviderscheme, dataflow)

  • updated_after – Data filtered by the last update date

Returns:

The URL and params formatted

get_constraints(flow, key=None, provider=None, component_id=None, mode=None, references=None, start_period=None, end_period=None, updated_after=None)

Returns URL and params to get the constraints

Parameters:

  • flow (str) – The id of the dataflow

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • provider (str) – The provider of the constraints

  • component_id (str) – The component id of the constraints

  • mode (str) – The mode parameter (exact, available)

  • references (str) – The references parameter (none, all, datastructure, conceptscheme, codelist, dataproviderscheme, dataflow)

  • start_period (str) – The start period of the constraints

  • end_period (str) – The end period of the constraints

  • updated_after (str) – Data filtered by the last update date

get_content_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the content constraints

Parameters:

  • agency_id (str) – The agency id of the content constraints

  • resources (str) – The resources to query

  • version (str) – The version of the content constraints

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_custom_type_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get custom type schemes

Parameters:

  • agency_id – The agency id of custom type schemes

  • resources – The resources to query

  • version – The version of the custom type schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_custom_type_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get custom type schemes in item scheme queries

Parameters:

  • agency_id – The agency id of custom type schemes

  • resources – The resources to query

  • version – The version of the custom type schemes

  • item_id – The id of the item of the custom type schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_custom_type_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the custom type schemes

Parameters:

  • agency_id (str) – The agency id of the custom type schemes

  • resources (str) – The resources to query

  • version (str) – The version of the custom type schemes

  • item_id (str) – The id of the item of the custom type schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_data(flow, key=None, provider=None, start_period=None, end_period=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, detail=None, include_history=None) → str

Returns URL and params to get data

Parameters:

  • flow (str) – The id of the dataflow

  • key (str) – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • provider (str) – The provider of the data

  • start_period (str) – The start period of the data

  • end_period (str) – The end period of the data

  • updated_after (str) – Data filtered by the last update date

  • first_n_observations (int) – Number of first observations to be returned per key

  • last_n_observations (int) – Number of last observations to be returned per key

  • dimension_at_observation (str) – The dimension at observation of the data

  • detail – The detail parameter (full, referencestubs, referencepartial, allstubs, allcompletestubs, referencecompletestubs)

  • include_history (str) – The include history of the data (true, false)

get_data_all_contexts(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data

Parameters:

  • agency_id – The id of the data (all possible contexts)

  • resources – The resources to query

  • version – The version of the data (all possible contexts)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c – Filter data by component value

  • updated_after – Data filtered by the last update date

  • first_n_observations – Number of first observations to be returned per key

  • last_n_observations – Number of last observations to be returned per key

  • dimension_at_observation – The dimension at observation

  • attributes – Attributes of the data (all possible contexts)

  • measures – Measures of the data (all possible contexts)

  • include_history – Value to include history (true, false)

Returns:

The URL and params formatted

get_data_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get data constraints

Parameters:

  • agency_id – The agency id of data constraints

  • resources – The resources to query

  • version – The version of the data constraints

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_data_consumer_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get data consumer schemes

Parameters:

  • agency_id – The agency id of data consumer schemes

  • resources – The resources to query

  • version – The version of the data consumer schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_data_consumer_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get data consumer schemes in item scheme queries

Parameters:

  • agency_id – The agency id of data consumer schemes

  • resources – The resources to query

  • version – The version of the data consumer schemes

  • item_id – The id of the item of the data consumer schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_data_consumers(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the data consumers

Parameters:

  • agency_id (str) – The agency id of the data consumers

  • resources (str) – The resources to query

  • version (str) – The version of the data consumers

  • item_id (str) – The id of the item of the data consumers

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_data_dataflows(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data

Parameters:

  • agency_id – The id of the data (dataflow)

  • resources – The resources to query

  • version – The version of the data (dataflow)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c – Filter data by component value

  • updated_after – Data filtered by the last update date

  • first_n_observations – Number of first observations to be returned per key

  • last_n_observations – Number of last observations to be returned per key

  • dimension_at_observation – The dimension at observation

  • attributes – Attributes of the data (dataflow)

  • measures – Measures of the data (dataflow)

  • include_history – Value to include history (true, false)

Returns:

The URL and params formatted

get_data_datastructures(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data

Parameters:

  • agency_id – The id of the data (datastructure)

  • resources – The resources to query

  • version – The version of the data (datastructure)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c – Filter data by component value

  • updated_after – Data filtered by the last update date

  • first_n_observations – Number of first observations to be returned per key

  • last_n_observations – Number of last observations to be returned per key

  • dimension_at_observation – The dimension at observation

  • attributes – Attributes of the data (datastructure)

  • measures – Measures of the data (datastructure)

  • include_history – Value to include history (true, false)

Returns:

The URL and params formatted

get_data_flows(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get dataflows

Parameters:

  • agency_id – The agency id of the dataflows

  • resources – The resources to query

  • version – The version of the dataflows

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_data_provider_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get data provider schemes

Parameters:

  • agency_id – The agency id of data provider schemes

  • resources – The resources to query

  • version – The version of the data provider schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_data_provider_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get data provider schemes in item scheme queries

Parameters:

  • agency_id – The agency id of data provider schemes

  • resources – The resources to query

  • version – The version of the data provider schemes

  • item_id – The id of the item of the data provider schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_data_providers(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the data providers

Parameters:

  • agency_id (str) – The agency id of the data providers

  • resources (str) – The resources to query

  • version (str) – The version of the data providers

  • item_id (str) – The id of the item of the data providers

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_data_provision_agreements(agency_id=None, resources=None, version=None, key=None, c=None, updated_after=None, first_n_observations=None, last_n_observations=None, dimension_at_observation=None, attributes=None, measures=None, include_history=None)

Returns URL and params to get data

Parameters:

  • agency_id – The id of the data (provision agreement)

  • resources – The resources to query

  • version – The version of the data (provision agreement)

  • key – The key is constructed as a dot (‘.’) separated list of dimension filtered values.

  • c – Filter data by component value

  • updated_after – Data filtered by the last update date

  • first_n_observations – Number of first observations to be returned per key

  • last_n_observations – Number of last observations to be returned per key

  • dimension_at_observation – The dimension at observation

  • attributes – Attributes of the data (provision agreement)

  • measures – Measures of the data (provision agreement)

  • include_history – Value to include history (true, false)

Returns:

The URL and params formatted

get_dsds(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get datastructure

Parameters:

  • agency_id – The agency id of the data structure definitions

  • resources – The resources to query

  • version – The version of the data structure definitions

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_hierarchical_codelist(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the hierarchical code lists

Parameters:

  • agency_id (str) – The agency id of the hierarchical code lists

  • resources (str) – The resources to query

  • version (str) – The version of the hierarchical code lists

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_hierarchies(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the hierarchies

Parameters:

  • agency_id (str) – The agency id of the hierarchies

  • resources (str) – The resources to query

  • version (str) – The version of the hierarchies

  • item_id (str) – The id of the item of the hierarchies

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_hierarchy(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get hierarchies

Parameters:

  • agency_id – The agency id of hierarchies

  • resources – The resources to query

  • version – The version of the hierarchies

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_hierarchy_association(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get hierarchy associations

Parameters:

  • agency_id – The agency id of hierarchy associations

  • resources – The resources to query

  • version – The version of the hierarchy associations

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_mdsds(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get metadata structure definitions

Parameters:

  • agency_id – The agency id of metadata structure definitions

  • resources – The resources to query

  • version – The version of the metadata structure definitions

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_meta_data_flows(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get metadata flows

Parameters:

  • agency_id – The agency id of metadata flows

  • resources – The resources to query

  • version – The version of the metadata flows

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_metadata_agency_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get agency schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the agency schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the agency schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_categorisations(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get categorisations in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the categorisations in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the categorisations in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_category_scheme_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get category scheme maps in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the category scheme maps in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the category scheme maps in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_category_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get category schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the category schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the category schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_code_lists(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get codelists in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the codelists in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the codelists in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_concept_scheme_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get concept scheme maps in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the concept scheme maps in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the concept scheme maps in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_concept_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get concept schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the concept schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the concept schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_constraint(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get metadata constraints

Parameters:

  • agency_id – The agency id of metadata constraints

  • resources – The resources to query

  • version – The version of the metadata constraints

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_metadata_custom_type_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get custom type schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the custom type schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the custom type schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_data_constraints(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data constraints in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the data constraints in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the data constraints in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_data_consumer_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data consumer schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the data consumer schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the data consumer schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_data_provider_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data provider schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the data provider schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the data provider schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_dataflows(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get dataflows in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the dataflows in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the dataflows in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_dsds(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get data structure definitions in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the data structure definitions in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the data structure definitions in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_hierarchies(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get hierarchies in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the hierarchies in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the hierarchies in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_hierarchy_associations(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get hierarchy associations in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the hierarchy associations in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the hierarchy associations in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_mdsds(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get metadata structure definitions in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the metadata structure definitions in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the metadata structure definitions in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_metadata_constraints(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get metadata constraints in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the metadata constraints in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the metadata constraints in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_metadata_flows(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get metadata flows in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the metadata flows in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the metadata flows in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_metadataflow_query(agency_id=None, resources=None, version=None, provider_id=None, detail=None) → str

Returns URL and params to get metadata (by metadataflow)

Parameters:

  • agency_id – The agency id of the metadata (by metadataflow)

  • resources – The resources to query

  • version – The version of the metadata (by metadataflow)

  • provider_id – The provider of metadata

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_metadataset_query(provider_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get metadata (by metadatasets)

Parameters:

  • provider_id – The provider of metadata

  • resources – The resources to query

  • version – The version of the metadata (by metadatasets)

  • provider_id – The provider of metadata

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_name_personalisation_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get name personalisation schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the name personalisation schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the name personalisation schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_organisation_scheme_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get organisation scheme maps in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the organisation scheme maps in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the organisation scheme maps in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_organisation_unit_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get organisation unit schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the organisation unit schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the organisation unit schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_processes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get processes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the processes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the processes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_provision_agreements(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get provision agreements in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the provision agreements in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the provision agreements in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_reporting_taxonomy_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get reporting taxonomy maps in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the reporting taxonomy maps in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the reporting taxonomy maps in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_representation_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get representation maps in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the representation maps in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the representation maps in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_ruleset_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get ruleset schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the ruleset schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the ruleset schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_structure_maps(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get structure maps in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the structure maps in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the structure maps in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_structure_sets(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get structure sets in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the structure sets in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the structure sets in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_transformation_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get transformation schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the transformation schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the transformation schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_user_defined_operator_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get user defined operator schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the user defined operator schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the user defined operator schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_value_lists(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get value lists in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the value lists in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the value lists in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_metadata_vtl_mapping_schemes(agency_id=None, resources=None, version=None, detail=None) → str

Returns URL and params to get vtl mapping schemes in metadata queries (by structure)

Parameters:

  • agency_id – The agency id of the vtl mapping schemes in metadata queries (by structure)

  • resources – The resources to query

  • version – The version of the vtl mapping schemes in metadata queries (by structure)

  • detail – The detail parameter (full, allstubs)

Returns:

The URL and params formatted

get_name_alias_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the name alias schemes

Parameters:

  • agency_id (str) – The agency id of the name alias schemes

  • resources (str) – The resources to query

  • version (str) – The version of the name alias schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_name_alias_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the name alias schemes

Parameters:

  • agency_id (str) – The agency id of the name alias schemes

  • resources (str) – The resources to query

  • version (str) – The version of the name alias schemes

  • item_id (str) – The id of the item of the name alias schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_name_personalisation_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get name personalisation schemes

Parameters:

  • agency_id – The agency id of name personalisation schemes

  • resources – The resources to query

  • version – The version of the name personalisation schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_name_personalisation_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get name personalisation schemes in item scheme queries

Parameters:

  • agency_id – The agency id of name personalisation schemes

  • resources – The resources to query

  • version – The version of the name personalisation schemes

  • item_id – The id of the item of the name personalisation schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_name_personalisation_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the name personalisation schemes

Parameters:

  • agency_id (str) – The agency id of the name personalisation schemes

  • resources (str) – The resources to query

  • version (str) – The version of the name personalisation schemes

  • item_id (str) – The id of the item of the name personalisation schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_organisation_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the organisation schemes

Parameters:

  • agency_id (str) – The agency id of the organisation schemes

  • resources (str) – The resources to query

  • version (str) – The version of the organisation schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_organisation_scheme_map(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get organisation scheme maps

Parameters:

  • agency_id – The agency id of organisation scheme maps

  • resources – The resources to query

  • version – The version of the organisation scheme maps

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_organisation_unit_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get organisation unit schemes

Parameters:

  • agency_id – The agency id of organisation unit schemes

  • resources – The resources to query

  • version – The version of the organisation unit schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_organisation_unit_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get organisation unit schemes in item scheme queries

Parameters:

  • agency_id – The agency id of organisation unit schemes

  • resources – The resources to query

  • version – The version of the organisation unit schemes

  • item_id – The id of the item of the data provider schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_organisation_unit_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the organisation unit schemes

Parameters:

  • agency_id (str) – The agency id of the organisation unit schemes

  • resources (str) – The resources to query

  • version (str) – The version of the organisation unit schemes

  • item_id (str) – The id of the item of the organisation unit schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_organisations(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the organisations

Parameters:

  • agency_id (str) – The agency id of the organisations

  • resources (str) – The resources to query

  • version (str) – The version of the organisations

  • item_id (str) – The id of the item of the organisations

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_process(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get processes

Parameters:

  • agency_id – The agency id of processes

  • resources – The resources to query

  • version – The version of the processes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_provision_agreements(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get provision agreements

Parameters:

  • agency_id – The agency id of provision agreements

  • resources – The resources to query

  • version – The version of the provision agreements

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_reporting_taxonomy_map(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get reporting taxonomy maps

Parameters:

  • agency_id – The agency id of reporting taxonomy maps

  • resources – The resources to query

  • version – The version of the reporting taxonomy maps

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_representation_map(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get representation maps

Parameters:

  • agency_id – The agency id of representation maps

  • resources – The resources to query

  • version – The version of the representation maps

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_ruleset_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get ruleset schemes

Parameters:

  • agency_id – The agency id of ruleset schemes

  • resources – The resources to query

  • version – The version of the ruleset schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_ruleset_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get ruleset schemes in item scheme queries

Parameters:

  • agency_id – The agency id of ruleset schemes

  • resources – The resources to query

  • version – The version of the ruleset schemes

  • item_id – The id of the item of the ruleset schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_ruleset_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the ruleset schemes

Parameters:

  • agency_id (str) – The agency id of the ruleset schemes

  • resources (str) – The resources to query

  • version (str) – The version of the ruleset schemes

  • item_id (str) – The id of the item of the ruleset schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_schema_dataflows(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (dataflow)

Parameters:

  • agency_id – The id of the schema (dataflow)

  • resources – The resources to query

  • version – The version of the schema (dataflow)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (false, true)

Returns:

The URL and params formatted

get_schema_datastructures(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (datastructure)

Parameters:

  • agency_id – The id of the schema (datastructure)

  • resources – The resources to query

  • version – The version of the schema (datastructure)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (false, true)

Returns:

The URL and params formatted

get_schema_meta_dataflows(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (metadataflow)

Parameters:

  • agency_id – The id of the schema (metadataflow)

  • resources – The resources to query

  • version – The version of the schema (metadataflow)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (false, true)

Returns:

The URL and params formatted

get_schema_meta_datastructures(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (metadatastructure)

Parameters:

  • agency_id – The id of the schema (metadatastructure)

  • resources – The resources to query

  • version – The version of the schema (metadatastructure)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (false, true)

Returns:

The URL and params formatted

get_schema_provision_agreements(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get schema (provision agreement)

Parameters:

  • agency_id – The id of the schema (provision agreement)

  • resources – The resources to query

  • version – The version of the schema (provision agreement)

  • dimension_at_observation – The dimension at observation

  • explicit_measure – Indicates whether observations are strongly typed (false, true)

Returns:

The URL and params formatted

get_schemas_dataflow(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (dataflow)

Parameters:

  • agency_id (str) – The agency id of the schema (dataflow)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (dataflow)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed (true, false)

get_schemas_datastructure(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (datastructure)

Parameters:

  • agency_id (str) – The agency id of the schema (datastructure)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (datastructure)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed (true, false)

get_schemas_meta_dataflow(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (metadataflow)

Parameters:

  • agency_id (str) – The agency id of the schema (metadataflow)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (metadataflow)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed (true, false)

get_schemas_meta_datastructure(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (metadatastructure)

Parameters:

  • agency_id (str) – The agency id of the schema (metadatastructure)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (metadatastructure)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed (true, false)

get_schemas_provision_agreement(agency_id=None, resources=None, version=None, dimension_at_observation=None, explicit_measure=None)

Returns URL and params to get the schema (provision agreement)

Parameters:

  • agency_id (str) – The agency id of the schema (provision agreement)

  • resources (str) – The resources to query

  • version (str) – The version of the schema (provision agreement)

  • dimension_at_observation (str) – The dimension at observation

  • explicit_measure (str) – Indicates whether observations are strongly typed (true, false)

get_structure(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get the structures

Parameters:

  • agency_id (str) – The agency id of the structures

  • resources (str) – The resources to query

  • version (str) – The version of the structures

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_structure_map(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get structure maps

Parameters:

  • agency_id – The agency id of structure maps

  • resources – The resources to query

  • version – The version of the structure maps

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_structure_sets(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get structure sets

Parameters:

  • agency_id – The agency id of structure sets

  • resources – The resources to query

  • version – The version of the structure sets

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_transformation_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get transformation schemes

Parameters:

  • agency_id – The agency id of transformation schemes

  • resources – The resources to query

  • version – The version of the transformation schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_transformation_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get transformation schemes in item scheme queries

Parameters:

  • agency_id – The agency id of transformation schemes

  • resources – The resources to query

  • version – The version of the transformation schemes

  • item_id – The id of the item of the transformation schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_transformation_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the transformation schemes

Parameters:

  • agency_id (str) – The agency id of the transformation schemes

  • resources (str) – The resources to query

  • version (str) – The version of the transformation schemes

  • item_id (str) – The id of the item of the transformation schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_user_defined_operator_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get user defined operator schemes

Parameters:

  • agency_id – The agency id of user defined operator schemes

  • resources – The resources to query

  • version – The version of the user defined operator schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_user_defined_operator_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get user defined operator schemes in item scheme queries

Parameters:

  • agency_id – The agency id of user defined operator schemes

  • resources – The resources to query

  • version – The version of the user defined operator schemes

  • item_id – The id of the item of the user defined operator schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_user_defined_operator_schemes(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get the user defined operator schemes

Parameters:

  • agency_id (str) – The agency id of the user defined operator schemes

  • resources (str) – The resources to query

  • version (str) – The version of the user defined operator schemes

  • item_id (str) – The id of the item of the user defined operator schemes

  • references (str) – The references parameter (‘none’, ‘parents’, ‘parentsandsiblings’, ‘children’, ‘descendants’, ‘all’, ‘datastructure’, ‘metadatastructure’, ‘categoryscheme’, ‘conceptscheme’, ‘codelist’, ‘hierarchicalcodelist’, ‘organisationscheme’, ‘agencyscheme’, ‘dataproviderscheme’, ‘dataconsumerscheme’, ‘organisationunitscheme’, ‘dataflow’, ‘metadataflow’, ‘reportingtaxonomy’, ‘provisionagreement’, ‘structureset’, ‘process’, ‘categorisation’, ‘contentconstraint’, ‘actualconstraint’, ‘allowedconstraint’, ‘attachmentconstraint’, ‘transformationscheme’, ‘rulesetscheme’, ‘userdefinedoperatorscheme’, ‘customtypescheme’, ‘namepersonalisationscheme’, ‘namealiassccheme’)

  • detail (str) – The detail parameter (allstubs, referencestubs, referencepartial, allcompletestubs, referencecompletestubs, full)

get_value_list(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get value lists

Parameters:

  • agency_id – The agency id of value lists

  • resources – The resources to query

  • version – The version of the value lists

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_value_list_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get value lists in item scheme queries

Parameters:

  • agency_id – The agency id of value lists

  • resources – The resources to query

  • version – The version of the value lists

  • item_id – The id of the item of the value lists

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_vtl_mapping_scheme(agency_id=None, resources=None, version=None, references=None, detail=None) → str

Returns URL and params to get vtl mapping schemes

Parameters:

  • agency_id – The agency id of vtl mapping schemes

  • resources – The resources to query

  • version – The version of the vtl mapping schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted

get_vtl_mapping_scheme_item(agency_id=None, resources=None, version=None, item_id=None, references=None, detail=None) → str

Returns URL and params to get vtl mapping schemes in item scheme queries

Parameters:

  • agency_id – The agency id of vtl mapping schemes

  • resources – The resources to query

  • version – The version of the vtl mapping schemes

  • item_id – The id of the item of the vtl mapping schemes

  • references – The references parameter (none, parents, parentsandsiblings, ancestors, children, descendants, all, datastructure, metadatastructure, categoryscheme, conceptscheme, codelist, hierarchy, hierarchyassociation, agencyscheme, dataproviderscheme, dataconsumerscheme, organisationunitscheme, dataflow, metadataflow, reportingtaxonomy, provisionagreement, structureset, process, categorisation, dataconstraint, metadataconstraint, transformationscheme, rulesetscheme, userdefinedoperatorscheme, customtypescheme,namepersonalisationscheme, namealiasscheme, valuelist, structuremap, representationmap, conceptscheme, categoryschememap, organisationschememap, reportingtaxonomymap)

  • detail – The detail parameter (full, allstubs, referencestubs, allcompletestubs, referencecompletestubs, referencepartial, raw)

Returns:

The URL and params formatted