POST api/v1/devices/datagroups/getTransactions

Retrieves transaction data for a device and data group, optionally with reference information

CygNet Access Requirements

    CygNet ACS security: BRDGAPI ACCESS 1

    CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

NameDescriptionTypeAdditional information
siteService

CygNet site and service (Site.Service) of the Device Definition Service (DDS)

 string

Required
deviceId

The device ID to retrieve transaction data for

 string

Required
dataGroupType

The data group type

 string

Required
dataGroupOrdinal

The data group ordinal

 integer

Required
options

Specifies whether to get transactions with: data and references, data (no references), or no data (header only)

 TransactionGetOptions

Required

Request Formats

application/json, text/json

Sample: 
{
  "siteService": "CYGSITE.DDS",
  "deviceId": "EM107",
  "dataGroupType": "AGAParams",
  "dataGroupOrdinal": 1,
  "options": "WithDataAndRefs"
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
transactions

List of data group transactions

 Collection of DataGroupTransactionDTO

None

Response Formats

application/json, text/json

Sample: 
{
  "transactions": [
    {
      "header": {
        "deviceId": "EM107",
        "facilityId": "EM107",
        "dataGroupType": "BasicPoll",
        "dataGroupOrdinal": 0,
        "dataBaseKey": "0000000123B0000004C0001275",
        "timestamp": "2019-05-06T10:21:33.651-07:00",
        "type": "Get",
        "userId": "DOMAIN\\user.name",
        "statusCode": "Succeeded",
        "statusMessage": "Succeeded",
        "majorVersion": 2,
        "minorVersion": 2,
        "dataSize": 2497,
        "headerSize": 300,
        "indexItem": "",
        "appDefined1": 0,
        "appDefined2": 0,
        "appDefined3": 0,
        "appDefined4": 0,
        "hasPartialData": false,
        "compressSize": 753,
        "blobCount": 1
      },
      "transactionDataXml": "<dgData xmlns:dt=\"urn:schemas-microsoft-com:datatypes\"><ItemCnt dt:dt=\"i4\" desc=\"Number of items\">41</ItemCnt><RespLen dt:dt=\"i4\" desc=\"Response length\">139</RespLen><InDIs dt:dt=\"i4\" desc=\"DIs installed\">0</InDIs><InTDIs dt:dt=\"i4\" desc=\"TDIs installed\">0</InTDIs><InAIs dt:dt=\"i4\" desc=\"AIs installed\">8</InAIs><InMtrRns dt:dt=\"i4\" desc=\"Meter runs installed\">4</InMtrRns><InPIs dt:dt=\"i4\" desc=\"PIs installed\">1</InPIs><InPIDs dt:dt=\"i4\" desc=\"PIDs installed\">0</InPIDs><InTanks dt:dt=\"i4\" desc=\"Tanks installed\">0</InTanks><InAOs dt:dt=\"i4\" desc=\"AOs installed\">1</InAOs><InTDOs dt:dt=\"i4\" desc=\"TDOs installed\">1</InTDOs><InDOs dt:dt=\"i4\" desc=\"DOs installed\">0</InDOs><DiagPnt65 dt:dt=\"r4\" desc=\"Diagnostic65 point\">3.17116</DiagPnt65><DiagPnt66 dt:dt=\"r4\" desc=\"Diagnostic66 point\">25.06878</DiagPnt66><DiagPnt67 dt:dt=\"r4\" desc=\"Diagnostic67 point\">23.54925</DiagPnt67><DiagPnt68 dt:dt=\"r4\" desc=\"Diagnostic68 point\">0.5923513</DiagPnt68><DiagPnt69 dt:dt=\"r4\" desc=\"Diagnostic69 point\">79.56741</DiagPnt69><AI03 dt:dt=\"r4\" desc=\"AI03 value\">625042.5</AI03><AI33 dt:dt=\"r4\" desc=\"AI33 value\">625042.5</AI33><AI34 dt:dt=\"r4\" desc=\"AI34 value\">625042.5</AI34><MRGas00 dt:dt=\"r4\" desc=\"Meter00 gas flow\">717.4448</MRGas00><MREnergy00 dt:dt=\"r4\" desc=\"Meter00 cur energy\">627.6673</MREnergy00><MRMcf00 dt:dt=\"r4\" desc=\"Meter00 MCF\">119.1879</MRMcf00><MRMmbtu00 dt:dt=\"r4\" desc=\"Meter00 MMBTU\">104.2737</MRMmbtu00><MRGas01 dt:dt=\"r4\" desc=\"Meter01 gas flow\">0</MRGas01><MREnergy01 dt:dt=\"r4\" desc=\"Meter01 cur energy\">0</MREnergy01><MRMcf01 dt:dt=\"r4\" desc=\"Meter01 MCF\">0</MRMcf01><MRMmbtu01 dt:dt=\"r4\" desc=\"Meter01 MMBTU\">0</MRMmbtu01><MRGas02 dt:dt=\"r4\" desc=\"Meter02 gas flow\">0</MRGas02><MREnergy02 dt:dt=\"r4\" desc=\"Meter02 cur energy\">0</MREnergy02><MRMcf02 dt:dt=\"r4\" desc=\"Meter02 MCF\">0</MRMcf02><MRMmbtu02 dt:dt=\"r4\" desc=\"Meter02 MMBTU\">0</MRMmbtu02><MRGas03 dt:dt=\"r4\" desc=\"Meter03 gas flow\">717.4448</MRGas03><MREnergy03 dt:dt=\"r4\" desc=\"Meter03 cur energy\">627.6673</MREnergy03><MRMcf03 dt:dt=\"r4\" desc=\"Meter03 MCF\">119.1879</MRMcf03><MRMmbtu03 dt:dt=\"r4\" desc=\"Meter03 MMBTU\">104.2737</MRMmbtu03><PIRawAcc01 dt:dt=\"i4\" desc=\"PI01 raw acc\">352584450</PIRawAcc01><PIRate01 dt:dt=\"r4\" desc=\"PI01 rate\">0</PIRate01><PItotal01 dt:dt=\"r4\" desc=\"PI01 total\">3.082857E-44</PItotal01><AO00 dt:dt=\"r4\" desc=\"AO00 value\">3.222986E-44</AO00><TDO00 dt:dt=\"r4\" desc=\"TDO00 EU\">3.363116E-44</TDO00><UISCMDPRMS>DGORD=0;DGTYPE=BasicPoll;</UISCMDPRMS><UISCMDTYPE>DG_F_DEV</UISCMDTYPE></dgData>"
    },
    {
      "header": {
        "deviceId": "EM107",
        "facilityId": "EM107",
        "dataGroupType": "BasicPoll",
        "dataGroupOrdinal": 0,
        "dataBaseKey": "0000000123B0000004C0001274",
        "timestamp": "2019-05-06T10:21:36.932-07:00",
        "type": "Get",
        "userId": "DOMAIN\\user.name",
        "statusCode": "Succeeded",
        "statusMessage": "Succeeded",
        "majorVersion": 2,
        "minorVersion": 2,
        "dataSize": 2497,
        "headerSize": 300,
        "indexItem": "",
        "appDefined1": 0,
        "appDefined2": 0,
        "appDefined3": 0,
        "appDefined4": 0,
        "hasPartialData": false,
        "compressSize": 753,
        "blobCount": 1
      },
      "transactionDataXml": "<dgData xmlns:dt=\"urn:schemas-microsoft-com:datatypes\"><ItemCnt dt:dt=\"i4\" desc=\"Number of items\">41</ItemCnt><RespLen dt:dt=\"i4\" desc=\"Response length\">139</RespLen><InDIs dt:dt=\"i4\" desc=\"DIs installed\">0</InDIs><InTDIs dt:dt=\"i4\" desc=\"TDIs installed\">0</InTDIs><InAIs dt:dt=\"i4\" desc=\"AIs installed\">8</InAIs><InMtrRns dt:dt=\"i4\" desc=\"Meter runs installed\">4</InMtrRns><InPIs dt:dt=\"i4\" desc=\"PIs installed\">1</InPIs><InPIDs dt:dt=\"i4\" desc=\"PIDs installed\">0</InPIDs><InTanks dt:dt=\"i4\" desc=\"Tanks installed\">0</InTanks><InAOs dt:dt=\"i4\" desc=\"AOs installed\">1</InAOs><InTDOs dt:dt=\"i4\" desc=\"TDOs installed\">1</InTDOs><InDOs dt:dt=\"i4\" desc=\"DOs installed\">0</InDOs><DiagPnt65 dt:dt=\"r4\" desc=\"Diagnostic65 point\">3.17116</DiagPnt65><DiagPnt66 dt:dt=\"r4\" desc=\"Diagnostic66 point\">25.06878</DiagPnt66><DiagPnt67 dt:dt=\"r4\" desc=\"Diagnostic67 point\">23.54925</DiagPnt67><DiagPnt68 dt:dt=\"r4\" desc=\"Diagnostic68 point\">0.5923513</DiagPnt68><DiagPnt69 dt:dt=\"r4\" desc=\"Diagnostic69 point\">79.56741</DiagPnt69><AI03 dt:dt=\"r4\" desc=\"AI03 value\">625042.5</AI03><AI33 dt:dt=\"r4\" desc=\"AI33 value\">625042.5</AI33><AI34 dt:dt=\"r4\" desc=\"AI34 value\">625042.5</AI34><MRGas00 dt:dt=\"r4\" desc=\"Meter00 gas flow\">717.4448</MRGas00><MREnergy00 dt:dt=\"r4\" desc=\"Meter00 cur energy\">627.6673</MREnergy00><MRMcf00 dt:dt=\"r4\" desc=\"Meter00 MCF\">119.1879</MRMcf00><MRMmbtu00 dt:dt=\"r4\" desc=\"Meter00 MMBTU\">104.2737</MRMmbtu00><MRGas01 dt:dt=\"r4\" desc=\"Meter01 gas flow\">0</MRGas01><MREnergy01 dt:dt=\"r4\" desc=\"Meter01 cur energy\">0</MREnergy01><MRMcf01 dt:dt=\"r4\" desc=\"Meter01 MCF\">0</MRMcf01><MRMmbtu01 dt:dt=\"r4\" desc=\"Meter01 MMBTU\">0</MRMmbtu01><MRGas02 dt:dt=\"r4\" desc=\"Meter02 gas flow\">0</MRGas02><MREnergy02 dt:dt=\"r4\" desc=\"Meter02 cur energy\">0</MREnergy02><MRMcf02 dt:dt=\"r4\" desc=\"Meter02 MCF\">0</MRMcf02><MRMmbtu02 dt:dt=\"r4\" desc=\"Meter02 MMBTU\">0</MRMmbtu02><MRGas03 dt:dt=\"r4\" desc=\"Meter03 gas flow\">717.4448</MRGas03><MREnergy03 dt:dt=\"r4\" desc=\"Meter03 cur energy\">627.6673</MREnergy03><MRMcf03 dt:dt=\"r4\" desc=\"Meter03 MCF\">119.1879</MRMcf03><MRMmbtu03 dt:dt=\"r4\" desc=\"Meter03 MMBTU\">104.2737</MRMmbtu03><PIRawAcc01 dt:dt=\"i4\" desc=\"PI01 raw acc\">352584450</PIRawAcc01><PIRate01 dt:dt=\"r4\" desc=\"PI01 rate\">0</PIRate01><PItotal01 dt:dt=\"r4\" desc=\"PI01 total\">3.082857E-44</PItotal01><AO00 dt:dt=\"r4\" desc=\"AO00 value\">3.222986E-44</AO00><TDO00 dt:dt=\"r4\" desc=\"TDO00 EU\">3.363116E-44</TDO00><UISCMDPRMS>DGORD=0;DGTYPE=BasicPoll;</UISCMDPRMS><UISCMDTYPE>DG_F_DEV</UISCMDTYPE></dgData>"
    }
  ]
}