metacore_obs_api.DeviceShadowApi

All URIs are relative to https://api.teke.li/api/v1/obs

Method	HTTP request	Description
getdevice_shadow	GET /device_shadow	Retrieves one or more device_shadow
getdevice_shadow_item	GET /device_shadow/{device-shadowId}	Retrieves a device-shadow document
patchdevice_shadow_item	PATCH /device_shadow/{device-shadowId}	Updates a device-shadow document
postdevice_shadow	POST /device_shadow	Stores one or more device_shadow.
putdevice_shadow_item	PUT /device_shadow/{device-shadowId}	Replaces a device-shadow document

getdevice_shadow

InlineResponse2001 getdevice_shadow(where=where, sort=sort, page=page, max_results=max_results)

Retrieves one or more device_shadow

Example

Api Key Authentication (ApiKeyHeaderAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
where = 'where_example' # str | the filters query parameter (ex.: {\"number\": 10}) (optional)
sort = 'sort_example' # str | the sort query parameter (ex.: \"city,-lastname\") (optional)
page = 1 # int | the pages query parameter (optional)
max_results = 25 # int | the max results query parameter (optional)

try:
    # Retrieves one or more device_shadow
    api_response = api_instance.getdevice_shadow(where=where, sort=sort, page=page, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->getdevice_shadow: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
where = 'where_example' # str | the filters query parameter (ex.: {\"number\": 10}) (optional)
sort = 'sort_example' # str | the sort query parameter (ex.: \"city,-lastname\") (optional)
page = 1 # int | the pages query parameter (optional)
max_results = 25 # int | the max results query parameter (optional)

try:
    # Retrieves one or more device_shadow
    api_response = api_instance.getdevice_shadow(where=where, sort=sort, page=page, max_results=max_results)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->getdevice_shadow: %s\n" % e)

Parameters

Name	Type	Description	Notes
where	str	the filters query parameter (ex.: {"number": 10})	[optional]
sort	str	the sort query parameter (ex.: "city,-lastname")	[optional]
page	int	the pages query parameter	[optional]
max_results	int	the max results query parameter	[optional]

Return type

InlineResponse2001

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	An array of device_shadow	-
0	An error message	-

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

getdevice_shadow_item

DeviceShadow getdevice_shadow_item(device_shadow_id)

Retrieves a device-shadow document

Example

Api Key Authentication (ApiKeyHeaderAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow_id = 'device_shadow_id_example' # str | 

try:
    # Retrieves a device-shadow document
    api_response = api_instance.getdevice_shadow_item(device_shadow_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->getdevice_shadow_item: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow_id = 'device_shadow_id_example' # str | 

try:
    # Retrieves a device-shadow document
    api_response = api_instance.getdevice_shadow_item(device_shadow_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->getdevice_shadow_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_shadow_id	str

Return type

DeviceShadow

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	device-shadow document fetched successfully	-
0	An error message	-

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

patchdevice_shadow_item

patchdevice_shadow_item(device_shadow_id, if_match, device_shadow)

Updates a device-shadow document

Example

Api Key Authentication (ApiKeyHeaderAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow_id = 'device_shadow_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
device_shadow = metacore_obs_api.DeviceShadow() # DeviceShadow | A device-shadow or list of device-shadow documents

try:
    # Updates a device-shadow document
    api_instance.patchdevice_shadow_item(device_shadow_id, if_match, device_shadow)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->patchdevice_shadow_item: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow_id = 'device_shadow_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
device_shadow = metacore_obs_api.DeviceShadow() # DeviceShadow | A device-shadow or list of device-shadow documents

try:
    # Updates a device-shadow document
    api_instance.patchdevice_shadow_item(device_shadow_id, if_match, device_shadow)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->patchdevice_shadow_item: %s\n" % e)

Parameters

Name	Type	Description
device_shadow_id	str
if_match	str	Current value of the _etag field
device_shadow	DeviceShadow	A device-shadow or list of device-shadow documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	device-shadow document updated successfully	-
0	An error message	-

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

postdevice_shadow

postdevice_shadow(device_shadow)

Stores one or more device_shadow.

Example

Api Key Authentication (ApiKeyHeaderAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow = metacore_obs_api.DeviceShadow() # DeviceShadow | A device-shadow or list of device-shadow documents

try:
    # Stores one or more device_shadow.
    api_instance.postdevice_shadow(device_shadow)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->postdevice_shadow: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow = metacore_obs_api.DeviceShadow() # DeviceShadow | A device-shadow or list of device-shadow documents

try:
    # Stores one or more device_shadow.
    api_instance.postdevice_shadow(device_shadow)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->postdevice_shadow: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_shadow	DeviceShadow	A device-shadow or list of device-shadow documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	operation has been successful	-
0	An error message	-

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

putdevice_shadow_item

putdevice_shadow_item(device_shadow_id, if_match, device_shadow)

Replaces a device-shadow document

Example

Api Key Authentication (ApiKeyHeaderAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow_id = 'device_shadow_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
device_shadow = metacore_obs_api.DeviceShadow() # DeviceShadow | A device-shadow or list of device-shadow documents

try:
    # Replaces a device-shadow document
    api_instance.putdevice_shadow_item(device_shadow_id, if_match, device_shadow)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->putdevice_shadow_item: %s\n" % e)

Api Key Authentication (ApiKeyQueryAuth):

from __future__ import print_function
import time
import metacore_obs_api
from metacore_obs_api.rest import ApiException
from pprint import pprint
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyHeaderAuth
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
configuration = metacore_obs_api.Configuration()
# Configure API key authorization: ApiKeyQueryAuth
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Defining host is optional and default to https://api.teke.li/api/v1/obs
configuration.host = "https://api.teke.li/api/v1/obs"
# Create an instance of the API class
api_instance = metacore_obs_api.DeviceShadowApi(metacore_obs_api.ApiClient(configuration))
device_shadow_id = 'device_shadow_id_example' # str | 
if_match = 'if_match_example' # str | Current value of the _etag field
device_shadow = metacore_obs_api.DeviceShadow() # DeviceShadow | A device-shadow or list of device-shadow documents

try:
    # Replaces a device-shadow document
    api_instance.putdevice_shadow_item(device_shadow_id, if_match, device_shadow)
except ApiException as e:
    print("Exception when calling DeviceShadowApi->putdevice_shadow_item: %s\n" % e)

Parameters

Name	Type	Description
device_shadow_id	str
if_match	str	Current value of the _etag field
device_shadow	DeviceShadow	A device-shadow or list of device-shadow documents

Return type

void (empty response body)

Authorization

ApiKeyHeaderAuth, ApiKeyQueryAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	device-shadow document replaced successfully	-
0	An error message	-

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

Files

DeviceShadowApi.md

Latest commit

History

DeviceShadowApi.md

File metadata and controls

metacore_obs_api.DeviceShadowApi

getdevice_shadow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getdevice_shadow_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchdevice_shadow_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postdevice_shadow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

putdevice_shadow_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details