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

Get a specific SparkBot by id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ParticleBotDto
NameDescriptionTypeAdditional information
AutoAddDevice

boolean

None.

TokenExpiresOn

date

None.

HasTokenExpired

boolean

None.

ParticleAccount

string

None.

Devices

Collection of ParticleDeviceSummaryDto

None.

Id

User Id

globally unique identifier

None.

Name

The users name

string

None.

UserName

UserName (used to login with)

string

None.

FullUserName

User Id and Account name

string

None.

BotType

The type of bot.

string

None.

DisplayName

Users first and last name

string

None.

DevicesCheckIntervalMinutes

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

integer

None.

MeasurementCollectionIntervalMinutes

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

integer

None.

Links

Collection of links appropriate for the user

Collection of LinkDto

None.

Actions

Collection of LinkDto

None.

Description

string

None.

Enabled

boolean

None.

Response Formats

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

Sample:
{
  "AutoAddDevice": true,
  "TokenExpiresOn": "2017-08-20T15:17:57.5270301+00:00",
  "HasTokenExpired": true,
  "ParticleAccount": "sample string 4",
  "Devices": [
    {
      "Id": "2e27087f-a419-4ce5-8681-3f4b97f247e1",
      "UserName": "sample string 2",
      "ParticleDeviceId": "sample string 3",
      "ParticleDeviceType": 4,
      "ParticleDeviceTypeName": "sample string 5",
      "Name": "sample string 6",
      "Associated": true,
      "Links": [],
      "Actions": []
    },
    {
      "Id": "2e27087f-a419-4ce5-8681-3f4b97f247e1",
      "UserName": "sample string 2",
      "ParticleDeviceId": "sample string 3",
      "ParticleDeviceType": 4,
      "ParticleDeviceTypeName": "sample string 5",
      "Name": "sample string 6",
      "Associated": true,
      "Links": [],
      "Actions": []
    }
  ],
  "Id": "fd8628a5-80b3-47b2-a3fb-a384d0725c30",
  "Name": "sample string 6",
  "UserName": "sample string 7",
  "FullUserName": "sample string 8",
  "BotType": "sample string 9",
  "DisplayName": "sample string 10",
  "DevicesCheckIntervalMinutes": 11,
  "MeasurementCollectionIntervalMinutes": 12,
  "Links": [
    {
      "Href": "sample string 1",
      "Rel": "sample string 2",
      "Action": "sample string 3"
    },
    {
      "Href": "sample string 1",
      "Rel": "sample string 2",
      "Action": "sample string 3"
    }
  ],
  "Actions": [
    {
      "Href": "sample string 1",
      "Rel": "sample string 2",
      "Action": "sample string 3"
    },
    {
      "Href": "sample string 1",
      "Rel": "sample string 2",
      "Action": "sample string 3"
    }
  ],
  "Description": "sample string 13",
  "Enabled": true
}

application/xml, text/xml

Sample:
<ParticleBotDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.SparkBot">
  <Actions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
  </Actions>
  <BotType xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 9</BotType>
  <Description xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 13</Description>
  <DevicesCheckIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">11</DevicesCheckIntervalMinutes>
  <DisplayName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 10</DisplayName>
  <Enabled xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">true</Enabled>
  <FullUserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 8</FullUserName>
  <Id xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">fd8628a5-80b3-47b2-a3fb-a384d0725c30</Id>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
  </Links>
  <MeasurementCollectionIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">12</MeasurementCollectionIntervalMinutes>
  <Name xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 6</Name>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 7</UserName>
  <AutoAddDevice>true</AutoAddDevice>
  <Devices xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Bots.Models">
    <d2p1:ParticleDeviceSummaryDto>
      <d2p1:Actions xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <d2p1:Associated>true</d2p1:Associated>
      <d2p1:Id>2e27087f-a419-4ce5-8681-3f4b97f247e1</d2p1:Id>
      <d2p1:Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <d2p1:Name>sample string 6</d2p1:Name>
      <d2p1:ParticleDeviceId>sample string 3</d2p1:ParticleDeviceId>
      <d2p1:ParticleDeviceType>4</d2p1:ParticleDeviceType>
      <d2p1:ParticleDeviceTypeName>sample string 5</d2p1:ParticleDeviceTypeName>
      <d2p1:UserName>sample string 2</d2p1:UserName>
    </d2p1:ParticleDeviceSummaryDto>
    <d2p1:ParticleDeviceSummaryDto>
      <d2p1:Actions xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <d2p1:Associated>true</d2p1:Associated>
      <d2p1:Id>2e27087f-a419-4ce5-8681-3f4b97f247e1</d2p1:Id>
      <d2p1:Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <d2p1:Name>sample string 6</d2p1:Name>
      <d2p1:ParticleDeviceId>sample string 3</d2p1:ParticleDeviceId>
      <d2p1:ParticleDeviceType>4</d2p1:ParticleDeviceType>
      <d2p1:ParticleDeviceTypeName>sample string 5</d2p1:ParticleDeviceTypeName>
      <d2p1:UserName>sample string 2</d2p1:UserName>
    </d2p1:ParticleDeviceSummaryDto>
  </Devices>
  <HasTokenExpired>true</HasTokenExpired>
  <ParticleAccount>sample string 4</ParticleAccount>
  <TokenExpiresOn>2017-08-20T15:17:57.5270301+00:00</TokenExpiresOn>
</ParticleBotDto>