PUT api/v1/measurement/devices/{deviceName}/update?siteService={siteService}

Updates the FMS device record for a specified device name

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Base

Request Information

URI Parameters

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

Body Parameters

Request object containing the data for device to update

Name	Description	Type	Additional information
device	Single FMS Device Record DTO	FmsDeviceRecordDTO	Required

Request Formats

application/json, text/json

Sample:

{
  "device": {
    "beginActiveDate": "2000-01-01T00:00:00",
    "endActiveDate": "3000-12-31T00:00:00",
    "name": "New_Device",
    "description": "My new device",
    "siteService": "CYGNET.FMS",
    "facilityId": "ANTIER_GM",
    "sortPriority": 0,
    "securityApp": "",
    "daysOfData": 35,
    "deviceInstallDate": "2020-02-13T00:00:00",
    "pmRecordSpan": "Hourly",
    "pqRecordSpan": "Hourly",
    "collectionMethod": "DeviceImport",
    "stationType": "Interconnect",
    "stationContribution": "Receipt",
    "timezoneKey": 54,
    "timezoneDst": false,
    "contractHour": 0,
    "stationValidationNodeId": 0,
    "stationValidationNodeName": "",
    "isActive": true,
    "hasConfig": true,
    "hasPMHistory": true,
    "hasPQHistory": false,
    "hasEvents": true,
    "hasAlarms": true,
    "useAlternateSource": false,
    "deviceType": null,
    "pollingSiteService": "",
    "pollingFacilityId": "",
    "gmrUnitSetId": 0,
    "hasBatchHistory": false,
    "hasTicketHistory": false,
    "alternateSourceNodeName": "",
    "hasProduct": false,
    "useJobScheduleStartDate": false,
    "jobScheduleStartDate": "2020-02-13T00:00:00"
  }
}

Response Information

Resource Description

The updated device data

Name	Description	Type	Additional information
nodeId	Node Id of the device	integer	None
device	Single FMS Device Record DTO	FmsDeviceRecordDTO	None

Response Formats

application/json, text/json

Sample:

{
  "nodeId": 22,
  "device": {
    "beginActiveDate": "2000-01-01T00:00:00",
    "endActiveDate": "3000-12-31T00:00:00",
    "name": "New_Device",
    "description": "My new device",
    "siteService": "CYGNET.FMS",
    "facilityId": "ANTIER_GM",
    "sortPriority": 0,
    "securityApp": "",
    "daysOfData": 35,
    "deviceInstallDate": "2020-02-13T00:00:00",
    "pmRecordSpan": "Hourly",
    "pqRecordSpan": "Hourly",
    "collectionMethod": "DeviceImport",
    "stationType": "Interconnect",
    "stationContribution": "Receipt",
    "timezoneKey": 54,
    "timezoneDst": false,
    "contractHour": 0,
    "stationValidationNodeId": 0,
    "stationValidationNodeName": "",
    "isActive": true,
    "hasConfig": true,
    "hasPMHistory": true,
    "hasPQHistory": false,
    "hasEvents": true,
    "hasAlarms": true,
    "useAlternateSource": false,
    "deviceType": null,
    "pollingSiteService": "",
    "pollingFacilityId": "",
    "gmrUnitSetId": 0,
    "hasBatchHistory": false,
    "hasTicketHistory": false,
    "alternateSourceNodeName": "",
    "hasProduct": false,
    "useJobScheduleStartDate": false,
    "jobScheduleStartDate": "2020-02-13T00:00:00"
  }
}