PUT api/v1/bots/sparkbots/{id}

Modify ParticleBot details

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

UpdateSparkBotDto
NameDescriptionTypeAdditional information
DisplayName

The friendly displayname for the bot

string

Required

AllowDuplicateMessages

If the bot should be allowed to raise duplicate status messages

boolean

None.

Description

Description of the bot

string

None.

DevicesCheckIntervalMinutes

How often the spark account should be checked for new devices.

integer

None.

AutoAddDevice

If new spark devices should be added as Tinamous devices automatically.

boolean

None.

MeasurementCollectionIntervalMinutes

How often measurements should be collected from the devices (applies to new devices only).

integer

None.

Enabled

boolean

None.

Tags

Tags to assign to the bot

Collection of string

None.

DeviceTags

Tags to assign to devices as they are added.

Collection of string

None.

AllowStatusMessageCommands

Allow status messages to be used to invoke Alexa SmartHome functions

boolean

None.

LimitStatusMessageCommandsToUser

Only allow status message commands from this member/device (Leave null for any member/device)

globally unique identifier

None.

StreamingCollectionEnabled

boolean

None.

VariableCollectionEnabled

boolean

None.

Request Formats

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

Sample:
{
  "DisplayName": "sample string 1",
  "AllowDuplicateMessages": true,
  "Description": "sample string 3",
  "DevicesCheckIntervalMinutes": 4,
  "AutoAddDevice": true,
  "MeasurementCollectionIntervalMinutes": 6,
  "Enabled": true,
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "DeviceTags": [
    "sample string 1",
    "sample string 2"
  ],
  "AllowStatusMessageCommands": true,
  "LimitStatusMessageCommandsToUser": "04455d02-a955-45e9-a330-bb81c163d425",
  "StreamingCollectionEnabled": true,
  "VariableCollectionEnabled": true
}

application/xml, text/xml

Sample:
<UpdateSparkBotDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.SparkBot">
  <AllowDuplicateMessages>true</AllowDuplicateMessages>
  <AllowStatusMessageCommands>true</AllowStatusMessageCommands>
  <AutoAddDevice>true</AutoAddDevice>
  <Description>sample string 3</Description>
  <DeviceTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DeviceTags>
  <DevicesCheckIntervalMinutes>4</DevicesCheckIntervalMinutes>
  <DisplayName>sample string 1</DisplayName>
  <Enabled>true</Enabled>
  <LimitStatusMessageCommandsToUser>04455d02-a955-45e9-a330-bb81c163d425</LimitStatusMessageCommandsToUser>
  <MeasurementCollectionIntervalMinutes>6</MeasurementCollectionIntervalMinutes>
  <StreamingCollectionEnabled>true</StreamingCollectionEnabled>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
  <VariableCollectionEnabled>true</VariableCollectionEnabled>
</UpdateSparkBotDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.