sphinx-quickstart on Sun Feb 14 11:12:22 2021. You can adapt this file completely to your liking, but it should at least contain the root toctree directive.

Bienvenido a la documentación de MDMPyClient!

Modulos

class MDM(configuracion, translator, init_data=False)

Clase encargada de gestionar todas las peticiones a la API del M&D Manager. Hace uso del fichero de configuración configuracion/configuracion.yaml

Parameters: configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml

codelists

Objeto que contiene todos las codelist de la API y encargado de gestionarlas

Type: Codelists

concept_schemes

Objeto que contiene todos los esquemas de conceptos de la API y encargado de gestionarlos

Type: ConceptSchemes

category_schemes

Objeto que contiene todos los esquemas de categorías de la API y encargado de gestionarlos.

Type: CategorySchemes

dsds

Objeto que contiene todos los DSDs de la API y encargado de gestionarlos.

Type: DSDs

cubes

Objeto que contiene todos los cubos de la API y encargado de gestionarlos.

Type: Cubes

mappings

Objeto que contiene todos los mappings de la API y encargado de gestionarlos.

Type: Mappings

dataflows

Objeto que contiene todos los dataflows de la API y encargado de gestionarlos.

Type: Dataflows

msds

Objeto que contiene todos los MSDs de la API y encargado de gestionarlos.

Type: MSDs

metadataflows

Objeto que contiene todos los metadataflows de la API y encargado de gestionarlos.

Type: Metadataflows

metadatasets

Objeto que contiene todos los metatatasets de la API y encargado de gestionarlos.

Type: Metadatasets

class Codelist(session, configuracion, translator, translator_cache, codelist_id, agency_id, version, names, des, init_data=False)

Clase que representa una codelist del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
id (String) – Identificador de la codelist.
version (String) – Versión de la codelist.
agency_id (String) – Agencia vinculada a la codelist.
(class (des) – Diccionario): Diccionario con los nombres de la codelist en varios idiomas.
(class – String): Diccionario con las descripciones de la codelist en varios idiomas.
init_data (Boolean) – True para traer todos los datos de la codelist, False para no traerlos. Por defecto toma el valor False.

codes

DataFrame con todos los códigos de la lista

Type: DataFrame

class Codelists(session, configuracion, translator, translator_cache, init_data=False)

Clase que representa el conjunto de codelists del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todos los códigos de las listas, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todas las codelists

Type: Diccionario

class ConceptScheme(session, configuracion, translator, translator_cache, cs_id, agency_id, version, names, des, init_data=False)

Clase que representa un esquema de conceptos del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
(class (init_data) – ‘String’): Identificador del esquema de conceptos.
(class – String): Identificador de la agencia vinculada.
(class – String): Version del esquema de conceptos.
(class – Diccionario): Diccionario con los nombres del esquema de conceptos en varios idiomas.
(class – String): Diccionario con las descripciones del esquema de conceptos en varios idiomas.
(class – Boolean): True para traer todos los datos del esquema de conceptos, False para traer solo id, agencia y versión. Por defecto toma el valor False.

concepts

DataFrame con todos los conceptos del esquema

Type: DataFrame

class ConceptSchemes(session, configuracion, translator, translator_cache, init_data=False)

Clase que representa el conjunto de esquemas de conceptos del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todos los conceptos de los esquemas, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los esquemas de conceptos

Type: Diccionario

class CategoryScheme(session, configuracion, translator, translator_cache, category_scheme_id, agency_id, version, names, des, init_data=False)

Clase que representa un esquema de conceptos del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
(class (init_data) – String): Identificador del esquema de categorías.
(class – String): Identificador de la agencia vinculada.
(class – String): Versión del esquema de categorías.
(class – Diccionario): Diccionario con los nombres del esquema de categorías en varios idiomas.
(class – String): Diccionario con las descripciones del esquema de categorías en varios idiomas.
(class – Boolean): True para traer todos los datos del esquema de categorías, False para traer solo id, agencia y versión. Por defecto toma el valor False.

categories

DataFrame con todas las categorías del esquema

Type: DataFrame

class CategorySchemes(session, configuracion, translator, translator_cache, init_data=False)

Clase que representa el conjunto de esquemas de categorías del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todas las categorías de los esquemas, False para no traerlas. Por defecto toma el valor False.

data

Diccionario con todas las codelists

Type: Diccionario

class DSD(session, configuracion, dsd_id, agency_id, version, names, des, init_data=False)

Clase que representa un DSD del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
(class (init_data) – ‘String’): Identificador del DSD.
(class – String): Identificador de la agencia vinculada.
(class – String): Version del DSD.
(class – Diccionario): Diccionario con los nombres del DSD en varios idiomas.
(class – String): Diccionario con las descripciones del DSD en varios idiomas.
(class – Boolean): True para traer todos los datos del DSD, False para traer solo id, agencia y versión. Por defecto toma el valor False.

data

DataFrame con todos los datos del DSD

Type: DataFrame

class DSDs(session, configuracion, init_data=False)

Clase que representa el conjunto de DSDs del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todos los DSDs, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los DSDs

Type: Diccionario

class Cube(session, configuracion, cube_id, code, cat_id, dsd_code, names, init_data=False)

Clase que representa un Cubo del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
(class (init_data) – ‘Integer’): Identificador del cubo.
(class – String): Código del cubo. Coincide con el ID que se le da cuando se crea desde el cliente
(class – Integer): ID de la categoría a la que pertenece el cubo. La categoría perteneciente al esquema de categorías de los cubos en la api se refieren a estas como como ‘dcs’.
(class – Diccionario): Diccionario con los nombres del cubo en varios idiomas.
(class – Boolean): True para traer todos los datos del cubo, False para traer solo id, agencia y versión. Por defecto toma el valor False.

class Cubes(session, configuracion, init_data=False)

Clase que representa el conjunto de cubes del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todos los cubes, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los cubes

Type: Diccionario

class Mapping(session, configuracion, mapping_id, cube_id, name, des, init_data=False)

Clase que representa un mapping del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
id (Integer) – Identificador del mapping.
cube_id (Integer) – Identificador del cubo al que pertenece el mapping.
name (String) – Nombre del mapping.
(class (des) – String): Descripción del mapping.
init_data (Boolean) – True para traer todos los datos del mapping, False para no traerlos. Por defecto toma el valor False.

components

Lista con todos los componentes del mapping.

Type: List

class Mappings(session, configuracion, init_data=False)

Clase que representa el conjunto de mappings del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todos los datos de los mappings, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los mappings

Type: Dicconario

class Dataflow(session, configuracion, code, agency_id, version, dataflow_id, cube_id, names, des, init_data=False)

Clase que representa un dataflow del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
code (String) – Identificador del dataflow.
agency_id (String) – Identificador de la agencia asociada al dataflow.
version (String) – Versión del dataflow.
id (Integer) – Identificador numérico del dataflow.
cube_id (Integer) – Identificador del cubo al que asociado al dataflow.
filter (Diccionario) – Filtros del dataflow.
name (Diccionario) – Nombres del dataflow.
(class (des) – Diccionario): Descripciones del dataflow.
init_data (Boolean) – True para traer todos los datos del dataflow, False para no traerlos. Por defecto toma el valor False.

data

Lista con todos los datos del dataflow.

Type: List

class Dataflows(session, configuracion, translator, translator_cache, init_data=False)

Clase que representa el conjunto de dataflows del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todos los datos dataflows, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los dataflows

Type: Diccionario

class MSD(session, configuracion, msd_id, agency_id, version, names, des, init_data=False)

Clase que representa un MSD del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
msd_id (String) – Identificador del MSD.
agency_id (String) – Identificador de la agencia asociada al MSD.
version (String) – Versión del MSD.
name (Diccionario) – Nombres del MSD.
(class (des) – Diccionario): Descripciones del MSD.
init_data (Boolean) – True para traer todos los datos del MSD, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los datos del MSD.

Type: Diccionario

class MSDs(session, configuracion, init_data=False)

Clase que representa el conjunto de MSDs del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
init_data (Boolean) – True para traer todos los MSDs, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los MSDs

Type: Diccionario

class Metadataflow(session, configuracion, meta_id, agency_id, version, names, des, init_data=False)

Clase que representa un metadataflow del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
meta_id (String) – Identificadordel metadataflow.
agency_id (String) – Identificador de la agencia asociada al metadataflow.
version (String) – Versión del metadataflow.
name (Diccionario) – Nombres del metadataflow.
(class (des) – Diccionario): Descripciones del metadataflow.
init_data (Boolean) – True para traer todos los datos del metadataflow, False para no traerlos. Por defecto toma el valor False.

data

Lista con todos los datos del metadataflow.

Type: List

class Metadataset(session, configuracion, meta_id, names, init_data=False)

Clase que representa un metadataset del M&D Manager.

Parameters

session (requests.session.Session) – Sesión autenticada en la API.
configuracion (Diccionario) – Diccionario del que se obtienen algunos parámetros necesarios como la url de la API. Debe ser inicializado a partir del fichero de configuración configuracion/configuracion.yaml.
id (String) – Identificadordel metadataset
name (Diccionario) – Nombres del metadataset.
init_data (Boolean) – True para traer todos los datos del metadataset, False para no traerlos. Por defecto toma el valor False.

data

Diccionario con todos los datos del metadataset.

Type: Diccionario