POST api/v1/devices/{deviceId}/particle/Invoke/{methodName}

Invoke a method on the particle device.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
deviceId

The device Id (Tinamous Device Id) of the device.

 globally unique identifier

Required
methodName

The method to invoke. Must exist as a method on the Particle.io device.

 string

Required

Body Parameters

Parameters to pass to the particle method

InvokeFunctionParametersDto
NameDescriptionTypeAdditional information
Parameters

string

None.

Request Formats

application/json, text/json, application/senml+json

Sample: 
{
  "Parameters": "sample string 1"
}

application/xml, text/xml

Sample: 
<InvokeFunctionParametersDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Particle.Models">
  <Parameters>sample string 1</Parameters>
</InvokeFunctionParametersDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InvokeResponseDto
NameDescriptionTypeAdditional information
Response

integer

None.

Response Formats

application/json, text/json, application/senml+json

Sample: 
{
  "Response": 1
}

application/xml, text/xml

Sample: 
<InvokeResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Particle.Models">
  <Response>1</Response>
</InvokeResponseDto>