Skip to content

ascentio-tech/thingsboard-swagger-client

BranchesTags

Repository files navigation

thingsboard-swagger-client

For instructions how to authorize requests please visit REST API documentation page.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Package version: 2.3.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit http://thingsboard.io

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

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 thingsboard_client

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 thingsboard_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import thingsboard_client
from thingsboard_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: X-Authorization
configuration = thingsboard_client.Configuration()
configuration.api_key['X-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thingsboard_client.AdminControllerApi(thingsboard_client.ApiClient(configuration))

try:
    # checkUpdates
    api_response = api_instance.check_updates_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminControllerApi->check_updates_using_get: %s\n" % e)

# Configure API key authorization: X-Authorization
configuration = thingsboard_client.Configuration()
configuration.api_key['X-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thingsboard_client.AdminControllerApi(thingsboard_client.ApiClient(configuration))
key = 'key_example' # str | key

try:
    # getAdminSettings
    api_response = api_instance.get_admin_settings_using_get(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminControllerApi->get_admin_settings_using_get: %s\n" % e)

# Configure API key authorization: X-Authorization
configuration = thingsboard_client.Configuration()
configuration.api_key['X-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thingsboard_client.AdminControllerApi(thingsboard_client.ApiClient(configuration))
body = thingsboard_client.AdminSettings() # AdminSettings | adminSettings

try:
    # saveAdminSettings
    api_response = api_instance.save_admin_settings_using_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminControllerApi->save_admin_settings_using_post: %s\n" % e)

# Configure API key authorization: X-Authorization
configuration = thingsboard_client.Configuration()
configuration.api_key['X-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thingsboard_client.AdminControllerApi(thingsboard_client.ApiClient(configuration))
body = thingsboard_client.AdminSettings() # AdminSettings | adminSettings

try:
    # sendTestMail
    api_instance.send_test_mail_using_post(body)
except ApiException as e:
    print("Exception when calling AdminControllerApi->send_test_mail_using_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to //localhost/

Class Method HTTP request Description
AdminControllerApi check_updates_using_get GET /api/admin/updates checkUpdates
AdminControllerApi get_admin_settings_using_get GET /api/admin/settings/{key} getAdminSettings
AdminControllerApi save_admin_settings_using_post POST /api/admin/settings saveAdminSettings
AdminControllerApi send_test_mail_using_post POST /api/admin/settings/testMail sendTestMail
AlarmControllerApi ack_alarm_using_post POST /api/alarm/{alarmId}/ack ackAlarm
AlarmControllerApi clear_alarm_using_post POST /api/alarm/{alarmId}/clear clearAlarm
AlarmControllerApi delete_alarm_using_delete DELETE /api/alarm/{alarmId} deleteAlarm
AlarmControllerApi get_alarm_by_id_using_get GET /api/alarm/{alarmId} getAlarmById
AlarmControllerApi get_alarm_info_by_id_using_get GET /api/alarm/info/{alarmId} getAlarmInfoById
AlarmControllerApi get_alarms_using_get GET /api/alarm/{entityType}/{entityId} getAlarms
AlarmControllerApi get_highest_alarm_severity_using_get GET /api/alarm/highestSeverity/{entityType}/{entityId} getHighestAlarmSeverity
AlarmControllerApi save_alarm_using_post POST /api/alarm saveAlarm
AssetControllerApi assign_asset_to_customer_using_post POST /api/customer/{customerId}/asset/{assetId} assignAssetToCustomer
AssetControllerApi assign_asset_to_public_customer_using_post POST /api/customer/public/asset/{assetId} assignAssetToPublicCustomer
AssetControllerApi delete_asset_using_delete DELETE /api/asset/{assetId} deleteAsset
AssetControllerApi get_asset_by_id_using_get GET /api/asset/{assetId} getAssetById
AssetControllerApi get_asset_types_using_get GET /api/asset/types getAssetTypes
AssetControllerApi get_assets_by_ids_using_get GET /api/assets getAssetsByIds
AssetControllerApi get_customer_assets_using_get GET /api/customer/{customerId}/assets getCustomerAssets
AssetControllerApi get_tenant_assets_using_get GET /api/tenant/assets getTenantAssets
AssetControllerApi save_asset_using_post POST /api/asset saveAsset
AssetControllerApi unassign_asset_from_customer_using_delete DELETE /api/customer/asset/{assetId} unassignAssetFromCustomer
AuditLogControllerApi get_audit_logs_by_customer_id_using_get GET /api/audit/logs/customer/{customerId} getAuditLogsByCustomerId
AuditLogControllerApi get_audit_logs_by_entity_id_using_get GET /api/audit/logs/entity/{entityType}/{entityId} getAuditLogsByEntityId
AuditLogControllerApi get_audit_logs_by_user_id_using_get GET /api/audit/logs/user/{userId} getAuditLogsByUserId
AuditLogControllerApi get_audit_logs_using_get GET /api/audit/logs getAuditLogs
AuthControllerApi change_password_using_post POST /api/auth/changePassword changePassword
AuthControllerApi check_activate_token_using_get GET /api/noauth/activate checkActivateToken
AuthControllerApi check_reset_token_using_get GET /api/noauth/resetPassword checkResetToken
AuthControllerApi get_user_using_get GET /api/auth/user getUser
AuthControllerApi request_reset_password_by_email_using_post POST /api/noauth/resetPasswordByEmail requestResetPasswordByEmail
ComponentDescriptorControllerApi get_component_descriptor_by_clazz_using_get GET /api/component/{componentDescriptorClazz} getComponentDescriptorByClazz
ComponentDescriptorControllerApi get_component_descriptors_by_type_using_get GET /api/components/{componentType} getComponentDescriptorsByType
ComponentDescriptorControllerApi get_component_descriptors_by_types_using_get GET /api/components getComponentDescriptorsByTypes
CustomerControllerApi delete_customer_using_delete DELETE /api/customer/{customerId} deleteCustomer
CustomerControllerApi get_customer_by_id_using_get GET /api/customer/{customerId} getCustomerById
CustomerControllerApi get_customer_title_by_id_using_get GET /api/customer/{customerId}/title getCustomerTitleById
CustomerControllerApi get_customers_using_get GET /api/customers getCustomers
CustomerControllerApi get_short_customer_info_by_id_using_get GET /api/customer/{customerId}/shortInfo getShortCustomerInfoById
CustomerControllerApi get_tenant_customer_using_get GET /api/tenant/customers getTenantCustomer
CustomerControllerApi save_customer_using_post POST /api/customer saveCustomer
DashboardControllerApi add_dashboard_customers_using_post POST /api/dashboard/{dashboardId}/customers/add addDashboardCustomers
DashboardControllerApi assign_dashboard_to_customer_using_post POST /api/customer/{customerId}/dashboard/{dashboardId} assignDashboardToCustomer
DashboardControllerApi assign_dashboard_to_public_customer_using_post POST /api/customer/public/dashboard/{dashboardId} assignDashboardToPublicCustomer
DashboardControllerApi delete_dashboard_using_delete DELETE /api/dashboard/{dashboardId} deleteDashboard
DashboardControllerApi get_customer_dashboards_using_get GET /api/customer/{customerId}/dashboards getCustomerDashboards
DashboardControllerApi get_dashboard_by_id_using_get GET /api/dashboard/{dashboardId} getDashboardById
DashboardControllerApi get_dashboard_info_by_id_using_get GET /api/dashboard/info/{dashboardId} getDashboardInfoById
DashboardControllerApi get_max_datapoints_limit_using_get GET /api/dashboard/maxDatapointsLimit getMaxDatapointsLimit
DashboardControllerApi get_server_time_using_get GET /api/dashboard/serverTime getServerTime
DashboardControllerApi get_tenant_dashboards_using_get GET /api/tenant/dashboards getTenantDashboards
DashboardControllerApi get_tenant_dashboards_using_get1 GET /api/tenant/{tenantId}/dashboards getTenantDashboards
DashboardControllerApi remove_dashboard_customers_using_post POST /api/dashboard/{dashboardId}/customers/remove removeDashboardCustomers
DashboardControllerApi save_dashboard_using_post POST /api/dashboard saveDashboard
DashboardControllerApi unassign_dashboard_from_customer_using_delete DELETE /api/customer/{customerId}/dashboard/{dashboardId} unassignDashboardFromCustomer
DashboardControllerApi unassign_dashboard_from_public_customer_using_delete DELETE /api/customer/public/dashboard/{dashboardId} unassignDashboardFromPublicCustomer
DashboardControllerApi update_dashboard_customers_using_post POST /api/dashboard/{dashboardId}/customers updateDashboardCustomers
DeviceControllerApi assign_device_to_customer_using_post POST /api/customer/{customerId}/device/{deviceId} assignDeviceToCustomer
DeviceControllerApi assign_device_to_public_customer_using_post POST /api/customer/public/device/{deviceId} assignDeviceToPublicCustomer
DeviceControllerApi delete_device_using_delete DELETE /api/device/{deviceId} deleteDevice
DeviceControllerApi get_customer_devices_using_get GET /api/customer/{customerId}/devices getCustomerDevices
DeviceControllerApi get_device_by_id_using_get GET /api/device/{deviceId} getDeviceById
DeviceControllerApi get_device_credentials_by_device_id_using_get GET /api/device/{deviceId}/credentials getDeviceCredentialsByDeviceId
DeviceControllerApi get_device_types_using_get GET /api/device/types getDeviceTypes
DeviceControllerApi get_devices_by_ids_using_get GET /api/devices getDevicesByIds
DeviceControllerApi get_tenant_devices_using_get GET /api/tenant/devices getTenantDevices
DeviceControllerApi save_device_credentials_using_post POST /api/device/credentials saveDeviceCredentials
DeviceControllerApi save_device_using_post POST /api/device saveDevice
DeviceControllerApi unassign_device_from_customer_using_delete DELETE /api/customer/device/{deviceId} unassignDeviceFromCustomer
EntityRelationControllerApi delete_relation_using_delete DELETE /api/relation deleteRelation
EntityRelationControllerApi find_by_to_using_get GET /api/relations findByTo
EntityRelationControllerApi find_info_by_to_using_get GET /api/relations/info findInfoByTo
EntityRelationControllerApi get_relation_using_get GET /api/relation getRelation
EntityViewControllerApi assign_entity_view_to_customer_using_post POST /api/customer/{customerId}/entityView/{entityViewId} assignEntityViewToCustomer
EntityViewControllerApi assign_entity_view_to_public_customer_using_post POST /api/customer/public/entityView/{entityViewId} assignEntityViewToPublicCustomer
EntityViewControllerApi delete_entity_view_using_delete DELETE /api/entityView/{entityViewId} deleteEntityView
EntityViewControllerApi find_by_query_using_post3 POST /api/entityViews findByQuery
EntityViewControllerApi get_customer_entity_views_using_get GET /api/customer/{customerId}/entityViews getCustomerEntityViews
EntityViewControllerApi get_entity_view_by_id_using_get GET /api/entityView/{entityViewId} getEntityViewById
EntityViewControllerApi get_entity_view_types_using_get GET /api/entityView/types getEntityViewTypes
EntityViewControllerApi get_tenant_entity_views_using_get GET /api/tenant/entityViews getTenantEntityViews
EntityViewControllerApi save_entity_view_using_post POST /api/entityView saveEntityView
EntityViewControllerApi unassign_entity_view_from_customer_using_delete DELETE /api/customer/entityView/{entityViewId} unassignEntityViewFromCustomer
EventControllerApi get_events_using_get GET /api/events/{entityType}/{entityId}/{eventType} getEvents
EventControllerApi get_events_using_get1 GET /api/events/{entityType}/{entityId} getEvents
RpcControllerApi handle_one_way_device_rpc_request_using_post POST /api/plugins/rpc/oneway/{deviceId} handleOneWayDeviceRPCRequest
RpcControllerApi handle_two_way_device_rpc_request_using_post POST /api/plugins/rpc/twoway/{deviceId} handleTwoWayDeviceRPCRequest
RuleChainControllerApi delete_rule_chain_using_delete DELETE /api/ruleChain/{ruleChainId} deleteRuleChain
RuleChainControllerApi get_latest_rule_node_debug_input_using_get GET /api/ruleNode/{ruleNodeId}/debugIn getLatestRuleNodeDebugInput
RuleChainControllerApi get_rule_chain_by_id_using_get GET /api/ruleChain/{ruleChainId} getRuleChainById
RuleChainControllerApi get_rule_chain_meta_data_using_get GET /api/ruleChain/{ruleChainId}/metadata getRuleChainMetaData
RuleChainControllerApi get_rule_chains_using_get GET /api/ruleChains getRuleChains
RuleChainControllerApi save_rule_chain_meta_data_using_post POST /api/ruleChain/metadata saveRuleChainMetaData
RuleChainControllerApi save_rule_chain_using_post POST /api/ruleChain saveRuleChain
RuleChainControllerApi set_root_rule_chain_using_post POST /api/ruleChain/{ruleChainId}/root setRootRuleChain
RuleChainControllerApi test_script_using_post POST /api/ruleChain/testScript testScript
TelemetryControllerApi delete_entity_attributes_using_delete DELETE /api/plugins/telemetry/{deviceId}/{scope} deleteEntityAttributes
TelemetryControllerApi delete_entity_attributes_using_delete1 DELETE /api/plugins/telemetry/{entityType}/{entityId}/{scope} deleteEntityAttributes
TelemetryControllerApi delete_entity_timeseries_using_delete DELETE /api/plugins/telemetry/{entityType}/{entityId}/timeseries/delete deleteEntityTimeseries
TelemetryControllerApi get_attribute_keys_by_scope_using_get GET /api/plugins/telemetry/{entityType}/{entityId}/keys/attributes/{scope} getAttributeKeysByScope
TelemetryControllerApi get_attribute_keys_using_get GET /api/plugins/telemetry/{entityType}/{entityId}/keys/attributes getAttributeKeys
TelemetryControllerApi get_attributes_by_scope_using_get GET /api/plugins/telemetry/{entityType}/{entityId}/values/attributes/{scope} getAttributesByScope
TelemetryControllerApi get_attributes_using_get GET /api/plugins/telemetry/{entityType}/{entityId}/values/attributes getAttributes
TelemetryControllerApi get_latest_timeseries_using_get GET /api/plugins/telemetry/{entityType}/{entityId}/values/timeseries getLatestTimeseries
TelemetryControllerApi get_timeseries_keys_using_get GET /api/plugins/telemetry/{entityType}/{entityId}/keys/timeseries getTimeseriesKeys
TelemetryControllerApi save_entity_attributes_v2_using_post POST /api/plugins/telemetry/{entityType}/{entityId}/attributes/{scope} saveEntityAttributesV2
TelemetryControllerApi save_entity_telemetry_using_post POST /api/plugins/telemetry/{entityType}/{entityId}/timeseries/{scope} saveEntityTelemetry
TelemetryControllerApi save_entity_telemetry_with_ttl_using_post POST /api/plugins/telemetry/{entityType}/{entityId}/timeseries/{scope}/{ttl} saveEntityTelemetryWithTTL
TenantControllerApi delete_tenant_using_delete DELETE /api/tenant/{tenantId} deleteTenant
TenantControllerApi get_tenant_by_id_using_get GET /api/tenant/{tenantId} getTenantById
TenantControllerApi get_tenants_using_get GET /api/tenants getTenants
TenantControllerApi save_tenant_using_post POST /api/tenant saveTenant
UserControllerApi delete_user_using_delete DELETE /api/user/{userId} deleteUser
UserControllerApi get_activation_link_using_get GET /api/user/{userId}/activationLink getActivationLink
UserControllerApi get_customer_users_using_get GET /api/customer/{customerId}/users getCustomerUsers
UserControllerApi get_tenant_admins_using_get GET /api/tenant/{tenantId}/users getTenantAdmins
UserControllerApi get_user_by_id_using_get GET /api/user/{userId} getUserById
UserControllerApi get_user_token_using_get GET /api/user/{userId}/token getUserToken
UserControllerApi is_user_token_access_enabled_using_get GET /api/user/tokenAccessEnabled isUserTokenAccessEnabled
UserControllerApi save_user_using_post POST /api/user saveUser
UserControllerApi send_activation_email_using_post POST /api/user/sendActivationMail sendActivationEmail
WidgetTypeControllerApi delete_widget_type_using_delete DELETE /api/widgetType/{widgetTypeId} deleteWidgetType
WidgetTypeControllerApi get_bundle_widget_types_using_get GET /api/widgetTypes getBundleWidgetTypes
WidgetTypeControllerApi get_widget_type_by_id_using_get GET /api/widgetType/{widgetTypeId} getWidgetTypeById
WidgetTypeControllerApi get_widget_type_using_get GET /api/widgetType getWidgetType
WidgetsBundleControllerApi delete_widgets_bundle_using_delete DELETE /api/widgetsBundle/{widgetsBundleId} deleteWidgetsBundle
WidgetsBundleControllerApi get_widgets_bundle_by_id_using_get GET /api/widgetsBundle/{widgetsBundleId} getWidgetsBundleById
WidgetsBundleControllerApi get_widgets_bundles_using_get1 GET /api/widgetsBundles getWidgetsBundles
WidgetsBundleControllerApi save_widgets_bundle_using_post POST /api/widgetsBundle saveWidgetsBundle

Documentation For Models

Documentation For Authorization

X-Authorization

  • Type: API key
  • API key parameter name: X-Authorization
  • Location: HTTP header

Author

[email protected]

About

Thingsboard REST API client generated with swagger-codegen

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

2 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages