ComponentDescriptorControllerApi.md

thingsboard_client.ComponentDescriptorControllerApi

All URIs are relative to //localhost/

Method	HTTP request	Description
get_component_descriptor_by_clazz_using_get	GET /api/component/{componentDescriptorClazz}	getComponentDescriptorByClazz
get_component_descriptors_by_type_using_get	GET /api/components/{componentType}	getComponentDescriptorsByType
get_component_descriptors_by_types_using_get	GET /api/components	getComponentDescriptorsByTypes

get_component_descriptor_by_clazz_using_get

ComponentDescriptor get_component_descriptor_by_clazz_using_get(component_descriptor_clazz)

getComponentDescriptorByClazz

Example

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.ComponentDescriptorControllerApi(thingsboard_client.ApiClient(configuration))
component_descriptor_clazz = 'component_descriptor_clazz_example' # str | componentDescriptorClazz

try:
    # getComponentDescriptorByClazz
    api_response = api_instance.get_component_descriptor_by_clazz_using_get(component_descriptor_clazz)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComponentDescriptorControllerApi->get_component_descriptor_by_clazz_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
component_descriptor_clazz	str	componentDescriptorClazz

Return type

ComponentDescriptor

Authorization

X-Authorization

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_component_descriptors_by_type_using_get

list[ComponentDescriptor] get_component_descriptors_by_type_using_get(component_type)

getComponentDescriptorsByType

Example

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.ComponentDescriptorControllerApi(thingsboard_client.ApiClient(configuration))
component_type = 'component_type_example' # str | componentType

try:
    # getComponentDescriptorsByType
    api_response = api_instance.get_component_descriptors_by_type_using_get(component_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComponentDescriptorControllerApi->get_component_descriptors_by_type_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
component_type	str	componentType

Return type

list[ComponentDescriptor]

Authorization

X-Authorization

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_component_descriptors_by_types_using_get

list[ComponentDescriptor] get_component_descriptors_by_types_using_get(component_types)

getComponentDescriptorsByTypes

Example

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.ComponentDescriptorControllerApi(thingsboard_client.ApiClient(configuration))
component_types = 'component_types_example' # str | componentTypes

try:
    # getComponentDescriptorsByTypes
    api_response = api_instance.get_component_descriptors_by_types_using_get(component_types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComponentDescriptorControllerApi->get_component_descriptors_by_types_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
component_types	str	componentTypes

Return type

list[ComponentDescriptor]

Authorization

X-Authorization

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]