POST api/v1/devices/datagroups/properties

Retrieves a data group property value for a device

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Device Definition Service (DDS)	string	Required
deviceId	The device ID to retrieve a datagroup property for	string	Required
dataGroupType	The data group type	string	Required
dataGroupOrdinal	The data group ordinal	integer	Required
dataGroupProperty	Enumeration of the data group property ID to request the value for	DataGroupProperty	Required

Request Formats

application/json, text/json

Sample:

{
  "siteService": "CYGSITE.DDS",
  "deviceId": "ANTIER_RD",
  "dataGroupType": "BasicPoll",
  "dataGroupOrdinal": 0,
  "dataGroupProperty": "Description"
}

Response Information

Resource Description

Name	Description	Type	Additional information
value	Value of the specified property	string	None

Response Formats

application/json, text/json

Sample:

{
  "value": "Basic Poll"
}