GET api/v1/measurement/devices/{deviceName}?siteService={siteService}

Retrieves the FMS device record for a specified device name

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

Name	Description	Type	Additional information
deviceName	The name of the device to retrieve	string	Required
siteService	CygNet site and service (Site.Service) of the FMS Service	string	Required

Body Parameters

None

Response Information

Resource Description

Device record for the specified device name

Name	Description	Type	Additional information
nodeId	Node Id of the device	integer	None
beginActiveDate	Begin Active Date	date	None
endActiveDate	End Active Date	date	None
name	Device Name	string	None
description	Device Description	string	None
siteService	CygNet Site.Service of the device	string	None
facilityId	Facility Id of the device	string	None
sortPriority	Sort priority of the device	integer	None
securityApp	Security application of the device	string	None
daysOfData	Number of days for which the source device associated with the Node will retain data	integer	None
deviceInstallDate	Install date of the device	date	None
pMRecordSpan	Periodic metering record span(in minutes)	integer	None
pQRecordSpan	Periodic quality record span (in minutes)	integer	None
collectionMethod	Collection method of the device	byte	None
stationType	Station type of the meter	signed byte	None
stationContribution	Station contribution of the meter	byte	None
timezoneKey	CygNet Timezone key	integer	None
timezoneDst	Daylight saving time status of the device	boolean	None
contractHour	Contract hour of the device	byte	None
stationValidationNodeId	Node ID of the linked station of the meter	integer	None
stationValidationNodeName	Node Name of the linked station of the meter	string	None
isActive	Active status of the device	boolean	None
hasConfig	Configuration status of the device	boolean	None
hasPMHistory	Periodic metering status of the device	boolean	None
hasPQHistory	Periodic quality status of the device	boolean	None
hasEvents	Events status of the device	boolean	None
hasAlarms	Alarms status of the device	boolean	None
useAlternateSource	Flag to determine if the device uses another Node as the source	boolean	None
deviceType	Device type	integer	None
pollingSiteService	Polling CygNet Site.Service	string	None
pollingFacilityId	Polling Facility Id	string	None
gmrUnitSetId	GMR UnitSet Id	integer	None
hasBatchHistory	Batch status of the device	boolean	None
hasTicketHistory	Ticket status of the device	boolean	None
alternateSourceNodeName	Node name used as the alternate source of the device	string	None
hasProduct	Liquid product status of the device	boolean	None
useJobScheduleStartDate	Flag to use Job Schedule Start Date	boolean	None
jobScheduleStartDate	Job Schedule Start Date	date	None

Response Formats

application/json, text/json

Sample:

{
  "nodeId": 200,
  "beginActiveDate": "2000-01-01T00:00:00",
  "endActiveDate": "3000-12-31T00:00:00",
  "name": "New_Device",
  "description": "My new device",
  "siteService": "CYGSITE.FMS",
  "facilityId": "",
  "sortPriority": 0,
  "securityApp": "",
  "daysOfData": 35,
  "deviceInstallDate": "2020-01-15T00:00:00",
  "pmRecordSpan": 60,
  "pqRecordSpan": 60,
  "collectionMethod": 0,
  "stationType": 0,
  "stationContribution": 0,
  "timezoneKey": 64,
  "timezoneDst": false,
  "contractHour": 0,
  "stationValidationNodeId": 0,
  "stationValidationNodeName": "",
  "isActive": false,
  "hasConfig": true,
  "hasPMHistory": true,
  "hasPQHistory": false,
  "hasEvents": true,
  "hasAlarms": true,
  "useAlternateSource": false,
  "deviceType": 1,
  "pollingSiteService": "",
  "pollingFacilityId": "",
  "gmrUnitSetId": 0,
  "hasBatchHistory": false,
  "hasTicketHistory": false,
  "alternateSourceNodeName": "",
  "hasProduct": false,
  "useJobScheduleStartDate": false,
  "jobScheduleStartDate": "2020-01-15T00:00:00"
}