This is an OmniCore Model and State Management server.
- API version: 1.8.11
- Package version: 1.8.11
- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen For more information, please visit http://www.korewireless.com
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/korewireless/OmniCore-Python-SDK.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/korewireless/OmniCore-Python-SDK.git
)
Then import the package:
import OmniCore
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 OmniCore
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import OmniCore
from OmniCore.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.korewireless.com
# See configuration.py for a list of all supported configuration parameters.
configuration = OmniCore.Configuration(
host = "https://api.korewireless.com"
)
# 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.
# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Configure Bearer authorization (JWT): bearerAuth
configuration = OmniCore.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with OmniCore.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = OmniCore.DeviceApi(api_client)
subscription_id = 'subscription_id_example' # str | Subscription ID
registry_id = 'registry_id_example' # str | Registry ID
bind = OmniCore.BindRequest() # BindRequest | application/json
try:
api_response = api_instance.bind_device(subscription_id, registry_id, bind)
print("The response of DeviceApi->bind_device:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceApi->bind_device: %s\n" % e)
All URIs are relative to https://api.korewireless.com
Class | Method | HTTP request | Description |
---|---|---|---|
DeviceApi | bind_device | POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/bindDeviceToGateway | |
DeviceApi | bind_devices | POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/bindDevicesToGateway | |
DeviceApi | block_device_communcation | PUT /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/communication | |
DeviceApi | create_device | POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices | |
DeviceApi | delete_device | DELETE /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} | |
DeviceApi | get_config | GET /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/configVersions | |
DeviceApi | get_device | GET /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} | |
DeviceApi | get_devices | GET /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices | |
DeviceApi | get_devices_last_seen | GET /omnicore/subscriptions/{subscriptionId}/devices | |
DeviceApi | get_states | GET /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/states | |
DeviceApi | send_command_to_device | POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/sendCommandToDevice | |
DeviceApi | un_bind_device | POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/unbindDeviceFromGateway | |
DeviceApi | un_bind_devices | POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/unbindDevicesFromGateway | |
DeviceApi | update_configuration_to_device | POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateConfigurationToDevice | |
DeviceApi | update_custom_onboard_request | POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateCustomOnboardRequest | |
DeviceApi | update_device | PATCH /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} | |
MetricsApi | get_metrics | GET /omnicore/subscriptions/{subscriptionId}/metrics | |
RegistryApi | create_registry | POST /omnicore/subscriptions/{subscriptionId}/registries | |
RegistryApi | delete_registry | DELETE /omnicore/subscriptions/{subscriptionId}/registries/{registryId} | |
RegistryApi | get_registries | GET /omnicore/subscriptions/{subscriptionId}/registries | |
RegistryApi | get_registry | GET /omnicore/subscriptions/{subscriptionId}/registries/{registryId} | |
RegistryApi | send_broadcast_to_devices | POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/sendBroadcastToDevice | |
RegistryApi | update_registry | PATCH /omnicore/subscriptions/{subscriptionId}/registries/{registryId} | |
SinkApi | create_sink | POST /omnicore/subscriptions/{subscriptionId}/sinks | |
SinkApi | delete_sink | DELETE /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId} | |
SinkApi | get_a_sink | GET /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId} | |
SinkApi | get_sinks | GET /omnicore/subscriptions/{subscriptionId}/sinks | Get All Sinks |
VaultApi | create_vault_configuration | POST /vault/subscriptions/{subscriptionid}/configurations | |
VaultApi | create_vault_key | POST /vault/subscriptions/{subscriptionid}/encryptionkeys | |
VaultApi | delete_configuration | DELETE /vault/subscriptions/{subscriptionid}/configurations/{configid} | |
VaultApi | delete_vault_key | DELETE /vault/subscriptions/{subscriptionid}/encryptionkeys/{keyid} | |
VaultApi | enable_encryption | POST /vault/subscriptions/{subscriptionid}/encryption | |
VaultApi | get_exports | GET /vault/subscriptions/{subscriptionid}/exports | |
VaultApi | get_registry_data | GET /vault/subscriptions/{subscriptionid}/folders | |
VaultApi | get_replays | GET /vault/subscriptions/{subscriptionid}/replays | |
VaultApi | get_vault_audit | GET /vault/subscriptions/{subscriptionid}/audit | |
VaultApi | get_vault_configurations | GET /vault/subscriptions/{subscriptionid}/configurations | |
VaultApi | get_vault_files | GET /vault/subscriptions/{subscriptionid}/registry/{registryid}/files | |
VaultApi | get_vault_keys | GET /vault/subscriptions/{subscriptionid}/encryptionkeys | |
VaultApi | get_vault_metrics | GET /vault/subscriptions/{subscriptionid}/metrics | |
VaultApi | get_vault_status | GET /vault/subscriptions/{subscriptionid}/status | |
VaultApi | set_retention | POST /vault/subscriptions/{subscriptionid}/retention | |
VaultApi | start_export | POST /vault/subscriptions/{subscriptionid}/exports | |
VaultApi | start_replay | POST /vault/subscriptions/{subscriptionid}/replays |
- Audit
- AuditResult
- BindRequest
- BindRequestIdsGateway
- BlockCommunicationBody
- Config
- Configurations
- CreateConfiguration
- CreateVaultKeyBody
- CustomOnboard
- Device
- DeviceCommand
- DeviceConfig
- DeviceConfiguration
- DeviceCredential
- DeviceOnline
- DeviceRegistry
- DeviceState
- EnableEncryptionBody
- ErrorFrame
- ErrorStatus
- EventNotificationConfig
- ExportDetail
- FileDetail
- FileDetails
- Folder
- FolderData
- Frame
- GatewayConfig
- GenericErrorResponse
- GetExportsResponse
- GetKeysResponse
- GetReplaysResponse
- HttpConfig
- Info
- ListDeviceConfigVersionsResponse
- ListDeviceRegistries
- ListDeviceStatesResponse
- ListDevicesOnlineResponse
- ListDevicesResponse
- ListSinks
- LogLevel
- Metrics
- MetricsData
- MetricsDetails
- MetricsLogs
- MetricsResponse
- MetricsResponseDetails
- MqttConfig
- NotificationConfig
- OperationMetrics
- Policy
- PublicKeyCertificate
- PublicKeyCredential
- RegistryCredential
- Replay
- ReplayBody
- SetRetentionBody
- Sink
- StartExportBody
- VaultConfiguration
- VaultEncryptionKey
- VaultStatus
- VaultStatusDetails
- X509CertificateDetails
- Type: Bearer authentication (JWT)
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header