POST api/v1/devices/{deviceId}/particle/ReadVariables
Read the variable values from the device. Reads all variables defined on the device. Note that this is a HTTP POST as it is an action to read the variables which results in a new measurement being created for the variable set.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
deviceId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
PartileReadVariablesDtoName | Description | Type | Additional information |
---|---|---|---|
Variables | Collection of ParticleVariableValueDto |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{ "Variables": [ { "Name": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "TimeTakenMilliSeconds": 4.1 }, { "Name": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "TimeTakenMilliSeconds": 4.1 } ] }
application/xml, text/xml
Sample:
<PartileReadVariablesDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Particle.Models"> <Variables> <ParticleVariableValueDto> <Name>sample string 1</Name> <TimeTakenMilliSeconds>4.1</TimeTakenMilliSeconds> <Type>sample string 3</Type> <Value>sample string 2</Value> </ParticleVariableValueDto> <ParticleVariableValueDto> <Name>sample string 1</Name> <TimeTakenMilliSeconds>4.1</TimeTakenMilliSeconds> <Type>sample string 3</Type> <Value>sample string 2</Value> </ParticleVariableValueDto> </Variables> </PartileReadVariablesDto>