Cyan Web API - Version 1


GET api/devices/{deviceId}

            Gets a single device resource within a tenant.
            

Request Information

Parameters

NameDescriptionAdditional information
deviceId
The deviceId to locate.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "deviceId": "fe719c15-1ca7-4baa-ae52-2e644d9faa58",
  "tenantId": "5e8ab0bb-871a-4855-ad29-8eea2164c193",
  "deviceGroupId": "1011aa0d-62e5-4077-97b8-b732ecf086d0",
  "name": "sample string 4",
  "description": "sample string 5",
  "manufacturerDeviceId": "sample string 6",
  "manufacturer": "sample string 7",
  "model": "sample string 8",
  "versionInfo": "sample string 9",
  "phoneNumber": "sample string 10",
  "isBlocked": true,
  "connectedDateUtc": "2025-04-21T01:43:27.9773806+00:00",
  "imei": "sample string 12",
  "macAddress": "sample string 13",
  "serialNumber": "sample string 14",
  "bluetoothName": "sample string 15",
  "createdDateUtc": "2025-04-21T01:43:27.9773806+00:00",
  "updatedDateUtc": "2025-04-21T01:43:27.9773806+00:00"
}

application/xml, text/xml

Sample:
<DeviceRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2025-04-21T01:43:27.9773806+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-21T01:43:27.9773806+00:00</UpdatedDateUtc>
  <BluetoothName>sample string 15</BluetoothName>
  <ConnectedDateUtc>2025-04-21T01:43:27.9773806+00:00</ConnectedDateUtc>
  <Description>sample string 5</Description>
  <DeviceGroupId>1011aa0d-62e5-4077-97b8-b732ecf086d0</DeviceGroupId>
  <DeviceId>fe719c15-1ca7-4baa-ae52-2e644d9faa58</DeviceId>
  <Imei>sample string 12</Imei>
  <IsBlocked>true</IsBlocked>
  <MacAddress>sample string 13</MacAddress>
  <Manufacturer>sample string 7</Manufacturer>
  <ManufacturerDeviceId>sample string 6</ManufacturerDeviceId>
  <Model>sample string 8</Model>
  <Name>sample string 4</Name>
  <PhoneNumber>sample string 10</PhoneNumber>
  <SerialNumber>sample string 14</SerialNumber>
  <TenantId>5e8ab0bb-871a-4855-ad29-8eea2164c193</TenantId>
  <VersionInfo>sample string 9</VersionInfo>
</DeviceRepresentation>