cosmotech-modeling-api 12.2.0

Cosmo Tech Modeling API

cosmotech-modeling-api

Cosmo Tech Modeling API (12.2.0-40480.6d6a465d)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 12.2.0
• Package version: 12.2.0
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/cosmo-tech/cosmotech-modeling-api-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/cosmo-tech/cosmotech-modeling-api-python-client.git)

Then import the package:

import cosmotech_modeling_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import cosmotech_modeling_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import cosmotech_modeling_api
from cosmotech_modeling_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_modeling_api.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with cosmotech_modeling_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_modeling_api.ConceptualModelApi(api_client)
    project_id = 'project_id_example' # str | The project identifier
    body = None # object | Conceptual model content

    try:
        # Check the semantic of a submitted conceptual model
        api_response = api_instance.check_conceptual_model_semantic_errors(project_id, body)
        print("The response of ConceptualModelApi->check_conceptual_model_semantic_errors:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConceptualModelApi->check_conceptual_model_semantic_errors: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ConceptualModelApi	check_conceptual_model_semantic_errors	POST /projects/{projectId}/conceptualModels/semantic	Check the semantic of a submitted conceptual model
ConceptualModelApi	create_category	POST /projects/{projectId}/conceptualModels/{conceptualModelId}/categories	Create a new category
ConceptualModelApi	create_conceptual_model	POST /projects/{projectId}/conceptualModels/{conceptualModelId}	Create a new conceptual model
ConceptualModelApi	create_data_type	POST /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes	Create a new data type
ConceptualModelApi	create_entity	POST /projects/{projectId}/conceptualModels/{conceptualModelId}/entities	Create a new entity
ConceptualModelApi	create_environment	POST /projects/{projectId}/conceptualModels/{conceptualModelId}/environments	Create a new environment
ConceptualModelApi	delete_category	DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/categories/{categoryId}	Delete a category
ConceptualModelApi	delete_conceptual_model	DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}	Delete a conceptal model
ConceptualModelApi	delete_data_type	DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes/{dataTypeId}	Delete a data type
ConceptualModelApi	delete_entity	DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/entities/{entityId}	Delete an entity
ConceptualModelApi	delete_environment	DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/environments/{environmentId}	Delete an environment
ConceptualModelApi	get_category	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/categories/{categoryId}	Get a category definition
ConceptualModelApi	get_conceptual_model	GET /projects/{projectId}/conceptualModels/{conceptualModelId}	Get the content of a conceptual model
ConceptualModelApi	get_conceptual_model_semantic_errors	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/semantic	Check the semantic of a submitted conceptual model
ConceptualModelApi	get_data_type	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes/{dataTypeId}	Get a data type definition
ConceptualModelApi	get_entity	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/entities/{entityId}	Get an entity definition
ConceptualModelApi	get_environment	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/environments/{environmentId}	Get an environment definition
ConceptualModelApi	list_categories	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/categories	Get the list of categories of a model
ConceptualModelApi	list_conceptual_models	GET /projects/{projectId}/conceptualModels	List the conceptual models of a project
ConceptualModelApi	list_data_types	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes	Get the list of data types of a model
ConceptualModelApi	list_entities	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/entities	Get the list of entities of a model
ConceptualModelApi	list_environments	GET /projects/{projectId}/conceptualModels/{conceptualModelId}/environments	Get the list of environments of a model
ConceptualModelApi	replace_category	PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/categories/{categoryId}	Replace a category definition
ConceptualModelApi	replace_conceptual_model	PUT /projects/{projectId}/conceptualModels/{conceptualModelId}	Replace the content of a conceptual model
ConceptualModelApi	replace_data_type	PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes/{dataTypeId}	Replace a data type definition
ConceptualModelApi	replace_entity	PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/entities/{entityId}	Replace an entity definition
ConceptualModelApi	replace_environment	PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/environments/{environmentId}	Replace an environment definition
ConceptualModelApi	update_conceptual_model	PATCH /projects/{projectId}/conceptualModels/{conceptualModelId}	Update the content of a conceptual model
FileApi	create_project_file	POST /projects/{projectId}/files/raw	Create a new project file
FileApi	delete_project_file	DELETE /projects/{projectId}/files/raw	Delete a project file
FileApi	get_project_file	GET /projects/{projectId}/files/raw	Get the content of a project file
FileApi	list_project_files	GET /projects/{projectId}/files	List all files of a project
FileApi	replace_project_file	PUT /projects/{projectId}/files/raw	Replace a project file
MetaApi	about	GET /about	Retrieve API info
MetaApi	get_openapi	GET /openapi.yaml	Get the OpenAPI description file
MetaApi	get_schema	GET /schemas/{schemaId}	Get a schema content
MetaApi	list_schemas	GET /schemas	List all known JSON schemas
ProjectApi	create_project	POST /projects	Create new a project
ProjectApi	delete_project	DELETE /projects/{projectId}	Delete a project
ProjectApi	delete_project_archive	DELETE /projects/{projectId}/archive	Delete the project archive
ProjectApi	get_project	GET /projects/{projectId}	List a project details
ProjectApi	get_project_archive	GET /projects/{projectId}/archive	Get the current project archive
ProjectApi	list_projects	GET /projects	List all projects
ProjectApi	replace_project_archive	PUT /projects/{projectId}/archive	Upload a replacement project source archive
ProjectApi	update_project	PATCH /projects/{projectId}	Update a project
ProjectApi	upload_project_archive	POST /projects/{projectId}/archive	Upload the initial project source archive
ProjectBuildApi	build_project	POST /projects/{projectId}/builds	Build a project
ProjectBuildApi	delete_project_build	DELETE /projects/{projectId}/builds/{buildId}	Delete a project build
ProjectBuildApi	get_project_build	GET /projects/{projectId}/builds/{buildId}	List a project build details
ProjectBuildApi	get_project_build_logs	GET /projects/{projectId}/builds/{buildId}/logs	Get a project build logs
ProjectBuildApi	get_project_build_package	GET /projects/{projectId}/builds/{buildId}/package	Get the produced built package
ProjectBuildApi	list_project_builds	GET /projects/{projectId}/builds	List all builds of a project
SimulatorApi	check_simulator_semantic_errors	POST /projects/{projectId}/simulators/semantic	Check the semantic of a submitted simulator
SimulatorApi	create_probe	POST /projects/{projectId}/simulators/{simulatorId}/probes	Create a new probe
SimulatorApi	create_simulator	POST /projects/{projectId}/simulators/{simulatorId}	Create a new simulator
SimulatorApi	delete_probe	DELETE /projects/{projectId}/simulators/{simulatorId}/probes/{probeId}	Delete a probe
SimulatorApi	delete_simulator	DELETE /projects/{projectId}/simulators/{simulatorId}	Delete a simulator
SimulatorApi	get_probe	GET /projects/{projectId}/simulators/{simulatorId}/probes/{probeId}	Get a probe definition
SimulatorApi	get_simulator	GET /projects/{projectId}/simulators/{simulatorId}	Get the content of a simulator
SimulatorApi	get_simulator_semantic_errors	GET /projects/{projectId}/simulators/{simulatorId}/semantic	Check the semantic of a submitted simulator
SimulatorApi	list_probes	GET /projects/{projectId}/simulators/{simulatorId}/probes	Get the list of probes of a simulator
SimulatorApi	list_simulators	GET /projects/{projectId}/simulators	List the simulators of a project
SimulatorApi	replace_probe	PUT /projects/{projectId}/simulators/{simulatorId}/probes/{probeId}	Replace a probe definition
SimulatorApi	replace_simulator	PUT /projects/{projectId}/simulators/{simulatorId}	Replace the content of a simulator
SimulatorApi	update_simulator	PATCH /projects/{projectId}/simulators/{simulatorId}	Update the content of a simulator
TransformationsApi	check_transformations_semantic_errors	POST /projects/{projectId}/transformations/semantic	Check the semantic of a submitted transformations
TransformationsApi	create_operation	POST /projects/{projectId}/transformations/{transformationsId}/operations	Create a new operation
TransformationsApi	create_transformations	POST /projects/{projectId}/transformations/{transformationsId}	Create a new transformations
TransformationsApi	delete_operation	DELETE /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}	Delete an operation
TransformationsApi	delete_transformations	DELETE /projects/{projectId}/transformations/{transformationsId}	Delete a transformations
TransformationsApi	get_building_workspace_for_operation	GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}/buildingWorkspace	Get the building workspace on which an operation can work
TransformationsApi	get_operation	GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}	Get an operation definition
TransformationsApi	get_resulting_model	GET /projects/{projectId}/transformations/{transformationsId}/resultingModel	Get the final resulting model of a transformations resource
TransformationsApi	get_resulting_model_after_operation	GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}/resultingModel	Get the resulting model after a specific operation of a transformations resource
TransformationsApi	get_semantic_errors_for_resulting_model_after_operation	GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}/resultingModel/semantic	Get the semantic errors of a resulting model after a specific operations of transformations
TransformationsApi	get_transformations	GET /projects/{projectId}/transformations/{transformationsId}	Get the content of a transformations
TransformationsApi	get_transformations_semantic_errors	GET /projects/{projectId}/transformations/{transformationsId}/semantic	Check the semantic of a submitted transformations
TransformationsApi	list_operations	GET /projects/{projectId}/transformations/{transformationsId}/operations	Get the list of operations of a transformations
TransformationsApi	list_transformations	GET /projects/{projectId}/transformations	List the transformations of a project
TransformationsApi	replace_operation	PUT /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}	Replace an operation definition
TransformationsApi	replace_transformations	PUT /projects/{projectId}/transformations/{transformationsId}	Replace the content of a transformations
TransformationsApi	update_transformations	PATCH /projects/{projectId}/transformations/{transformationsId}	Update the content of a transformations

Documentation For Models

• AboutInfo
• AboutInfoVersion
• ProblemDetails
• ProblemDetailsSemanticErrors
• Project
• ProjectBuild
• ProjectBuildRequest
• ProjectBuildRequestBuildConfig
• ProjectBuildRequestDockerSimulatorImage
• ProjectBuildStatus
• ProjectRequest
• SemanticError
• SemanticErrorNodes

Documentation For Authorization

Endpoints do not require authorization.

Author

[e-mail]