Cyan Web API - Version 1

GET api/deviceGroups

            Gets all DeviceGroups.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "deviceGroupId": "8b5628b1-a039-46fa-9015-c95d7885a1eb",
    "tenantId": "57eb52fe-90b9-4a62-b698-537b33054e98",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2026-04-03T04:29:49.0479666+00:00",
    "updatedDateUtc": "2026-04-03T04:29:49.0479666+00:00"
  },
  {
    "deviceGroupId": "8b5628b1-a039-46fa-9015-c95d7885a1eb",
    "tenantId": "57eb52fe-90b9-4a62-b698-537b33054e98",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2026-04-03T04:29:49.0479666+00:00",
    "updatedDateUtc": "2026-04-03T04:29:49.0479666+00:00"
  },
  {
    "deviceGroupId": "8b5628b1-a039-46fa-9015-c95d7885a1eb",
    "tenantId": "57eb52fe-90b9-4a62-b698-537b33054e98",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2026-04-03T04:29:49.0479666+00:00",
    "updatedDateUtc": "2026-04-03T04:29:49.0479666+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDeviceGroupRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <DeviceGroupRepresentation>
    <CreatedDateUtc>2026-04-03T04:29:49.0479666+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-03T04:29:49.0479666+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <DeviceGroupId>8b5628b1-a039-46fa-9015-c95d7885a1eb</DeviceGroupId>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>57eb52fe-90b9-4a62-b698-537b33054e98</TenantId>
  </DeviceGroupRepresentation>
  <DeviceGroupRepresentation>
    <CreatedDateUtc>2026-04-03T04:29:49.0479666+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-03T04:29:49.0479666+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <DeviceGroupId>8b5628b1-a039-46fa-9015-c95d7885a1eb</DeviceGroupId>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>57eb52fe-90b9-4a62-b698-537b33054e98</TenantId>
  </DeviceGroupRepresentation>
  <DeviceGroupRepresentation>
    <CreatedDateUtc>2026-04-03T04:29:49.0479666+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-03T04:29:49.0479666+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <DeviceGroupId>8b5628b1-a039-46fa-9015-c95d7885a1eb</DeviceGroupId>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>57eb52fe-90b9-4a62-b698-537b33054e98</TenantId>
  </DeviceGroupRepresentation>
</ArrayOfDeviceGroupRepresentation>