Execute Smart Device Actions

Description

A smart device optionally provides actions that can be executed remotely. The type provides the details of the actions, such as the name of the action and the parameters (that may required or optional) whose type is specified in the same way as the configuration properties of a smart device.

Resource URL

https://app1pub.smappee.net/dev/v3/servicelocation/[SERVICELOCATIONID]/smartdevices/[SMARTDEVICEUUID]/actions/[NAME]

HTTP method

POST

HTTP header

Authorization: Bearer [ACCESS_TOKEN]

 [ACCESS_TOKEN] being the access token received from the Get token or Refresh token authentication calls.

Parameters

Parameter

Type

Description

SERVICELOCATIONID

Path Parameter

The actual id of an accessible service location (see Get Servicelocations)

SMARTDEVICEUUID

Path Parameter

The actual lid of a BESS smart device available at the specified service location (see Get Smart Devices )

NAME

Path Parameter

The name of the action

Http body

[ { "spec": { "name": "[1st PARAMTER NAME]", "species": "Integer", }, "values": [ { "Integer": 70 } ] }, { "spec": { "name": "[2nd PARAMTER NAME]", "species": "BigDecimal", }, "values": [ { "Integer": 3.14 } ] } ]

Example

https://app1pub.smappee.net/dev/v3/servicelocation/10236/smartdevices/6791ace2-017e-11ef-8af2-02e2e76ae149/actions/setPowerSetPoint

Result

Nothing is returned

Versioning

Version 1 (v1)

Not supported.

Version 2 (v2)

Not supported

Version 3 (v3)

This was introduced in this version.

 



Content