Skip to content

Latest commit

 

History

History
212 lines (149 loc) · 6.56 KB

DeviceStatesApi.md

File metadata and controls

212 lines (149 loc) · 6.56 KB
Raw

swagger_client.DeviceStatesApi

All URIs are relative to http://localhost:8088/ari

Method HTTP request Description
device_states_device_name_delete DELETE /deviceStates/{deviceName} Destroy a device-state controlled by ARI.
device_states_device_name_get GET /deviceStates/{deviceName} Retrieve the current state of a device.
device_states_device_name_put PUT /deviceStates/{deviceName} Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
device_states_get GET /deviceStates List all ARI controlled device states.

device_states_device_name_delete

device_states_device_name_delete(device_name)

Destroy a device-state controlled by ARI.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DeviceStatesApi(swagger_client.ApiClient(configuration))
device_name = 'device_name_example' # str | Name of the device

try:
    # Destroy a device-state controlled by ARI.
    api_instance.device_states_device_name_delete(device_name)
except ApiException as e:
    print("Exception when calling DeviceStatesApi->device_states_device_name_delete: %s\n" % e)

Parameters

Name Type Description Notes
device_name str Name of the device

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

device_states_device_name_get

DeviceState device_states_device_name_get(device_name)

Retrieve the current state of a device.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DeviceStatesApi(swagger_client.ApiClient(configuration))
device_name = 'device_name_example' # str | Name of the device

try:
    # Retrieve the current state of a device.
    api_response = api_instance.device_states_device_name_get(device_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceStatesApi->device_states_device_name_get: %s\n" % e)

Parameters

Name Type Description Notes
device_name str Name of the device

Return type

DeviceState

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

device_states_device_name_put

device_states_device_name_put(device_name, device_state)

Change the state of a device controlled by ARI. (Note - implicitly creates the device state).

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DeviceStatesApi(swagger_client.ApiClient(configuration))
device_name = 'device_name_example' # str | Name of the device
device_state = 'device_state_example' # str | Device state value

try:
    # Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
    api_instance.device_states_device_name_put(device_name, device_state)
except ApiException as e:
    print("Exception when calling DeviceStatesApi->device_states_device_name_put: %s\n" % e)

Parameters

Name Type Description Notes
device_name str Name of the device
device_state str Device state value

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

device_states_get

list[DeviceState] device_states_get()

List all ARI controlled device states.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DeviceStatesApi(swagger_client.ApiClient(configuration))

try:
    # List all ARI controlled device states.
    api_response = api_instance.device_states_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceStatesApi->device_states_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[DeviceState]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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