POST api/v1/devices/deids/getvalues

Retrieves data group element values from the device

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Control

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type	Additional information
facilityTag	Facility tag linked to the desired device to get data from	string	Required
dataGroupType	The data group type	string	Required
dataGroupOrdinal	The data group ordinal	integer	Required
dataElements	List of data group elements to get from the device	Collection of DataElementDTO	Required
fromDeviceParameters	Parameters that may be required when getting from the device; usually an empty string is passed	string	None
toDeviceParameters	Parameters that may be required when sending to the device; usually an empty string is passed	string	None

Request Formats

application/json, text/json

Sample:

{
  "facilityTag": "CYGSITE.UIS::PINE_RD",
  "dataGroupType": "AGAParams",
  "dataGroupOrdinal": 1,
  "dataElements": [
    {
      "byUdc": false,
      "elementId": "Ethane"
    },
    {
      "byUdc": true,
      "elementId": "CFGETHN"
    }
  ],
  "fromDeviceParameters": "",
  "toDeviceParameters": ""
}

Response Information

Resource Description

Name	Description	Type	Additional information
dataElementValues	List of data group element values retrieved from the device	Collection of DataElementValueDTO	Required

Response Formats

application/json, text/json

Sample:

{
  "dataElementValues": [
    {
      "dataElement": {
        "byUdc": false,
        "elementId": "Ethane"
      },
      "value": "1729"
    },
    {
      "dataElement": {
        "byUdc": true,
        "elementId": "CFGETHN"
      },
      "value": "1.618"
    }
  ]
}