API Reference¤
Info
cmem-client is organized as a package of modules, each documenting one part
of the Corporate Memory API. Browse them in the table below or in the
navigation on the left. New to the package? Start with the
client module, the main entry point to the API.
| Module | Description |
|---|---|
| auth_provider.abc | Abstract base class and factory for authentication providers. |
| auth_provider.client_credentials | Client Credentials OAuth 2.0 flow authentication provider. |
| auth_provider.password | Resource Owner Password OAuth 2.0 flow authentication provider. |
| auth_provider.prefetched_token | Prefetched token authentication provider. |
| auth_provider.provided_token | Provided token authentication provider. |
| client | Main API client for eccenca Corporate Memory. |
| components.deployment | Corporate Memory deployment status component. |
| components.graph_store | Corporate Memory DataPlatform (explore) graph store management. |
| components.marketplace | eccenca Marketplace server integration. |
| components.sparql_wrapper | SPARQL Wrapper for eccenca Corporate Memory |
| components.workspace | Corporate Memory DataIntegration (build) workspace management. |
| config | Configuration management for the Corporate Memory client. |
| exceptions | Custom exception classes for the cmem_client package. |
| logging_utils | Logging utilities. |
| models.access_condition | Access control and authorization models for Corporate Memory. |
| models.base | Base model classes for all cmem_client data models. |
| models.common | Shared domain models used across multiple resource types. |
| models.credentials | Models for the OAuth2 credentials. |
| models.dataset | Corporate Memory dataset models for data integration. |
| models.error | Error response models for Corporate Memory API error handling. |
| models.graph | RDF graph models for Corporate Memory knowledge graphs. |
| models.graph_import | Graph import models for Corporate Memory. |
| models.graph_insight | Graph Insight models for Corporate Memory. |
| models.item | ImportItem base class and inherited classes |
| models.keycloak_client | Keycloak client models. |
| models.logging_config | Models for the configuration of the logging module |
| models.marshalling_plugins | Marshalling Plugin models |
| models.package | Marketplace package models. |
| models.project | Corporate Memory project models and metadata. |
| models.python_install | Result models for Python package installation and plugin management operations. |
| models.python_package | Python package models. |
| models.query_catalog | Models for query catalog operations. |
| models.resource | A file resource model |
| models.scheduler | Scheduler models |
| models.status | Models for Corporate Memory aggregated status information. |
| models.task | Task models for the DataIntegration task endpoint. |
| models.token | Authentication token models for OAuth 2.0 flows. |
| models.url | HTTP URL validation and manipulation utilities. |
| models.user | Keycloak user and group models. |
| models.validation | Validation models for SHACL batch validation processes. |
| models.variable | Corporate Memory project variable models for data integration. |
| models.vocabulary | Vocabulary models for Corporate Memory vocabulary catalog. |
| models.workflow | Workflow models |
| models.workspace_config | Corporate Memory Explore workspace configuration models. |
| models.workspace_plugin | Workspace plugin model. |
| models.workspace_status | Corporate Memory DataIntegration workspace status models. |
| repositories.access_conditions | Repository for the access conditions of Corporate Memory. |
| repositories.base.abc | Abstract base classes and configuration for CMEM repositories. |
| repositories.base.paged_list | Repository implementation for paginated API endpoints. |
| repositories.base.plain_list | Repository implementation for simple list API endpoints. |
| repositories.base.task_search | Repository implementation for Corporate Memory task search endpoints. |
| repositories.client_accounts | Repository for the Keycloak OpenID Connect client accounts of a deployment. |
| repositories.datasets | Repository for managing datasets in Corporate Memory. |
| repositories.files | Repository for the file resources of DataIntegration projects. |
| repositories.graph_imports | Repository for the owl:imports relations between named graphs. |
| repositories.graph_insights | Repository for the Graph Insights snapshots of Corporate Memory. |
| repositories.graphs | Repository for managing named graphs in Corporate Memory. |
| repositories.marketplace_packages | Repository for the marketplace packages installed in Corporate Memory. |
| repositories.projects | Repository for managing DataIntegration projects. |
| repositories.protocols.create_item | Protocol interface for repository item creation operations. |
| repositories.protocols.delete_item | Protocol interface for repository item deletion operations. |
| repositories.protocols.export_item | Protocol interface for repository item export operations. |
| repositories.protocols.import_item | Protocol interface for repository item import operations. |
| repositories.protocols.update_item | Protocol interface for repository item update operations. |
| repositories.python_packages | Repository for the Python packages installed in DataIntegration. |
| repositories.queries | Repository for managing queries from the Corporate Memory query catalog. |
| repositories.schedulers | Repository for the workflow schedulers of DataIntegration. |
| repositories.user_accounts | Repository for the Keycloak user accounts of a Corporate Memory deployment. |
| repositories.validations | Repository for the SHACL validation batches of Corporate Memory. |
| repositories.variables | Repository for the variables of DataIntegration projects. |
| repositories.vocabularies | Repository for managing vocabularies in Corporate Memory. |
| repositories.workflows | Repository for the workflows of DataIntegration projects. |
| repositories.workspace_configs | Repository for the custom workspace configurations of DataIntegration. |