Cosmo Tech Platform API
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 4.0.1-SNAPSHOT
- Package version: 1.0.0
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/Cosmo-Tech/cosmotech-api
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import cosmotech_apiInstall 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_apiExecute pytest to run the tests.
Please follow the installation procedure and then run the following:
import cosmotech_api
from cosmotech_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_api.Configuration(
host = "http://localhost"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cosmotech_api.ConnectorApi(api_client)
page = 56 # int | page number to query (first page is at index 0) (optional)
size = 56 # int | amount of result by page (optional)
try:
# List all Connectors
api_response = api_instance.find_all_connectors(page=page, size=size)
print("The response of ConnectorApi->find_all_connectors:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ConnectorApi->find_all_connectors: %s\n" % e)All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ConnectorApi | find_all_connectors | GET /connectors | List all Connectors |
| ConnectorApi | find_connector_by_id | GET /connectors/{connector_id} | Get the details of a connector |
| ConnectorApi | register_connector | POST /connectors | Register a new connector |
| ConnectorApi | unregister_connector | DELETE /connectors/{connector_id} | Unregister a connector |
| DatasetApi | add_dataset_access_control | POST /organizations/{organization_id}/datasets/{dataset_id}/security/access | Add a control access to the Dataset |
| DatasetApi | add_or_replace_dataset_compatibility_elements | POST /organizations/{organization_id}/datasets/{dataset_id}/compatibility | Add Dataset Compatibility elements. |
| DatasetApi | copy_dataset | POST /organizations/{organization_id}/datasets/copy | Copy a Dataset to another Dataset. |
| DatasetApi | create_dataset | POST /organizations/{organization_id}/datasets | Create a new Dataset |
| DatasetApi | create_sub_dataset | POST /organizations/{organization_id}/datasets/{dataset_id}/subdataset | Create a sub-dataset from the dataset in parameter |
| DatasetApi | create_twingraph_entities | POST /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Create new entities in a graph instance |
| DatasetApi | delete_dataset | DELETE /organizations/{organization_id}/datasets/{dataset_id} | Delete a dataset |
| DatasetApi | delete_twingraph_entities | DELETE /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Delete entities in a graph instance |
| DatasetApi | download_twingraph | GET /organizations/{organization_id}/datasets/twingraph/download/{hash} | Download a graph as a zip file |
| DatasetApi | find_all_datasets | GET /organizations/{organization_id}/datasets | List all Datasets |
| DatasetApi | find_dataset_by_id | GET /organizations/{organization_id}/datasets/{dataset_id} | Get the details of a Dataset |
| DatasetApi | get_dataset_access_control | GET /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset |
| DatasetApi | get_dataset_security | GET /organizations/{organization_id}/datasets/{dataset_id}/security | Get the Dataset security information |
| DatasetApi | get_dataset_security_users | GET /organizations/{organization_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list |
| DatasetApi | get_dataset_twingraph_status | GET /organizations/{organization_id}/datasets/{dataset_id}/status | Get the dataset's refresh job status |
| DatasetApi | get_twingraph_entities | GET /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Get entities in a graph instance |
| DatasetApi | link_workspace | POST /organizations/{organization_id}/datasets/{dataset_id}/link | |
| DatasetApi | refresh_dataset | POST /organizations/{organization_id}/datasets/{dataset_id}/refresh | Refresh data on dataset from dataset's source |
| DatasetApi | remove_all_dataset_compatibility_elements | DELETE /organizations/{organization_id}/datasets/{dataset_id}/compatibility | Remove all Dataset Compatibility elements from the Dataset specified |
| DatasetApi | remove_dataset_access_control | DELETE /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Remove the specified access from the given Dataset |
| DatasetApi | rollback_refresh | POST /organizations/{organization_id}/datasets/{dataset_id}/refresh/rollback | Rollback the dataset after a failed refresh |
| DatasetApi | search_datasets | POST /organizations/{organization_id}/datasets/search | Search Datasets by tags |
| DatasetApi | set_dataset_default_security | POST /organizations/{organization_id}/datasets/{dataset_id}/security/default | Set the Dataset default security |
| DatasetApi | twingraph_batch_query | POST /organizations/{organization_id}/datasets/{dataset_id}/batch-query | Run a query on a graph instance and return the result as a zip file in async mode |
| DatasetApi | twingraph_batch_update | POST /organizations/{organization_id}/datasets/{dataset_id}/batch | Async batch update by loading a CSV file on a graph instance |
| DatasetApi | twingraph_query | POST /organizations/{organization_id}/datasets/{dataset_id}/twingraph | Return the result of a query made on the graph instance as a json |
| DatasetApi | unlink_workspace | POST /organizations/{organization_id}/datasets/{dataset_id}/unlink | |
| DatasetApi | update_dataset | PATCH /organizations/{organization_id}/datasets/{dataset_id} | Update a dataset |
| DatasetApi | update_dataset_access_control | PATCH /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset |
| DatasetApi | update_twingraph_entities | PATCH /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Update entities in a graph instance |
| DatasetApi | upload_twingraph | POST /organizations/{organization_id}/datasets/{dataset_id} | Upload data from zip file to dataset's twingraph |
| OrganizationApi | add_organization_access_control | POST /organizations/{organization_id}/security/access | Add a control access to the Organization |
| OrganizationApi | find_all_organizations | GET /organizations | List all Organizations |
| OrganizationApi | find_organization_by_id | GET /organizations/{organization_id} | Get the details of an Organization |
| OrganizationApi | get_all_permissions | GET /organizations/permissions | Get all permissions per components |
| OrganizationApi | get_organization_access_control | GET /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization |
| OrganizationApi | get_organization_permissions | GET /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role |
| OrganizationApi | get_organization_security | GET /organizations/{organization_id}/security | Get the Organization security information |
| OrganizationApi | get_organization_security_users | GET /organizations/{organization_id}/security/users | Get the Organization security users list |
| OrganizationApi | register_organization | POST /organizations | Register a new organization |
| OrganizationApi | remove_organization_access_control | DELETE /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization |
| OrganizationApi | set_organization_default_security | POST /organizations/{organization_id}/security/default | Set the Organization default security |
| OrganizationApi | unregister_organization | DELETE /organizations/{organization_id} | Unregister an organization |
| OrganizationApi | update_organization | PATCH /organizations/{organization_id} | Update an Organization |
| OrganizationApi | update_organization_access_control | PATCH /organizations/{organization_id}/security/access/{identity_id} | Update the specified access to User for an Organization |
| RunApi | delete_run | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run |
| RunApi | get_run | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run |
| RunApi | get_run_logs | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run |
| RunApi | get_run_status | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run |
| RunApi | list_runs | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner |
| RunApi | query_run_data | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data |
| RunApi | send_run_data | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run |
| RunnerApi | add_runner_access_control | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner |
| RunnerApi | create_runner | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner |
| RunnerApi | delete_runner | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner |
| RunnerApi | get_runner | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of an runner |
| RunnerApi | get_runner_access_control | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner |
| RunnerApi | get_runner_permissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role |
| RunnerApi | get_runner_security | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information |
| RunnerApi | get_runner_security_users | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list |
| RunnerApi | list_runners | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners | List all Runners |
| RunnerApi | remove_runner_access_control | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Remove the specified access from the given Organization Runner |
| RunnerApi | set_runner_default_security | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security |
| RunnerApi | start_run | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start | Start a run with runner parameters |
| RunnerApi | stop_run | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop | Stop the last run |
| RunnerApi | update_runner | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update a runner |
| RunnerApi | update_runner_access_control | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Update the specified access to User for a Runner |
| SolutionApi | add_or_replace_parameter_groups | POST /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Add Parameter Groups. Any item with the same ID will be overwritten |
| SolutionApi | add_or_replace_parameters | POST /organizations/{organization_id}/solutions/{solution_id}/parameters | Add Parameters. Any item with the same ID will be overwritten |
| SolutionApi | add_or_replace_run_templates | POST /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Add Run Templates. Any item with the same ID will be overwritten |
| SolutionApi | add_solution_access_control | POST /organizations/{organization_id}/solutions/{solution_id}/security/access | Add a control access to the Solution |
| SolutionApi | create_solution | POST /organizations/{organization_id}/solutions | Register a new solution |
| SolutionApi | delete_solution | DELETE /organizations/{organization_id}/solutions/{solution_id} | Delete a solution |
| SolutionApi | delete_solution_run_template | DELETE /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Remove the specified Solution Run Template |
| SolutionApi | find_all_solutions | GET /organizations/{organization_id}/solutions | List all Solutions |
| SolutionApi | find_solution_by_id | GET /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution |
| SolutionApi | get_solution_access_control | GET /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get a control access for the Solution |
| SolutionApi | get_solution_security | GET /organizations/{organization_id}/solutions/{solution_id}/security | Get the Solution security information |
| SolutionApi | get_solution_security_users | GET /organizations/{organization_id}/solutions/{solution_id}/security/users | Get the Solution security users list |
| SolutionApi | remove_all_run_templates | DELETE /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Remove all Run Templates from the Solution specified |
| SolutionApi | remove_all_solution_parameter_groups | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Remove all Parameter Groups from the Solution specified |
| SolutionApi | remove_all_solution_parameters | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameters | Remove all Parameters from the Solution specified |
| SolutionApi | remove_solution_access_control | DELETE /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Remove the specified access from the given Organization Solution |
| SolutionApi | set_solution_default_security | POST /organizations/{organization_id}/solutions/{solution_id}/security/default | Set the Solution default security |
| SolutionApi | update_solution | PATCH /organizations/{organization_id}/solutions/{solution_id} | Update a solution |
| SolutionApi | update_solution_access_control | PATCH /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update the specified access to User for a Solution |
| SolutionApi | update_solution_run_template | PATCH /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update the specified Solution Run Template |
| WorkspaceApi | add_workspace_access_control | POST /organizations/{organization_id}/workspaces/{workspace_id}/security/access | Add a control access to the Workspace |
| WorkspaceApi | create_workspace | POST /organizations/{organization_id}/workspaces | Create a new workspace |
| WorkspaceApi | delete_all_workspace_files | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files | Delete all Workspace files |
| WorkspaceApi | delete_workspace | DELETE /organizations/{organization_id}/workspaces/{workspace_id} | Delete a workspace |
| WorkspaceApi | delete_workspace_file | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files/delete | Delete a workspace file |
| WorkspaceApi | download_workspace_file | GET /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified |
| WorkspaceApi | find_all_workspace_files | GET /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files |
| WorkspaceApi | find_all_workspaces | GET /organizations/{organization_id}/workspaces | List all Workspaces |
| WorkspaceApi | find_workspace_by_id | GET /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of an workspace |
| WorkspaceApi | get_workspace_access_control | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace |
| WorkspaceApi | get_workspace_permissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role |
| WorkspaceApi | get_workspace_security | GET /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information |
| WorkspaceApi | get_workspace_security_users | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/users | Get the Workspace security users list |
| WorkspaceApi | link_dataset | POST /organizations/{organization_id}/workspaces/{workspace_id}/link | |
| WorkspaceApi | remove_workspace_access_control | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Remove the specified access from the given Organization Workspace |
| WorkspaceApi | set_workspace_default_security | POST /organizations/{organization_id}/workspaces/{workspace_id}/security/default | Set the Workspace default security |
| WorkspaceApi | unlink_dataset | POST /organizations/{organization_id}/workspaces/{workspace_id}/unlink | |
| WorkspaceApi | update_workspace | PATCH /organizations/{organization_id}/workspaces/{workspace_id} | Update a workspace |
| WorkspaceApi | update_workspace_access_control | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Update the specified access to User for a Workspace |
| WorkspaceApi | upload_workspace_file | POST /organizations/{organization_id}/workspaces/{workspace_id}/files | Upload a file for the Workspace |
- ComponentRolePermissions
- Connector
- ConnectorParameter
- ConnectorParameterGroup
- ContainerResourceSizeInfo
- ContainerResourceSizing
- CreatedRun
- Dataset
- DatasetAccessControl
- DatasetCompatibility
- DatasetConnector
- DatasetCopyParameters
- DatasetRole
- DatasetSearch
- DatasetSecurity
- DatasetSourceType
- DatasetTwinGraphHash
- DatasetTwinGraphInfo
- DatasetTwinGraphQuery
- DeleteHistoricalData
- FileUploadMetadata
- FileUploadValidation
- GraphProperties
- IngestionStatusEnum
- IoTypesEnum
- Organization
- OrganizationAccessControl
- OrganizationRole
- OrganizationSecurity
- QueryResult
- ResourceSizeInfo
- Run
- RunContainer
- RunData
- RunDataQuery
- RunLogs
- RunLogsEntry
- RunResourceRequested
- RunState
- RunStatus
- RunStatusNode
- RunTemplate
- RunTemplateOrchestrator
- RunTemplateParameter
- RunTemplateParameterGroup
- RunTemplateParameterValue
- RunTemplateResourceSizing
- RunTemplateStepSource
- Runner
- RunnerAccessControl
- RunnerResourceSizing
- RunnerRole
- RunnerRunTemplateParameterValue
- RunnerSecurity
- RunnerValidationStatus
- SendRunDataRequest
- Solution
- SolutionAccessControl
- SolutionRole
- SolutionSecurity
- SourceInfo
- SubDatasetGraphQuery
- TwinGraphBatchResult
- TwincacheStatusEnum
- Workspace
- WorkspaceAccessControl
- WorkspaceFile
- WorkspaceRole
- WorkspaceSecurity
- WorkspaceSolution
- WorkspaceWebApp
Authentication schemes defined for the API:
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://example.com/authorize
- Scopes: N/A