CygNet Bridge API Help Page

Introduction

The CygNet Bridge API provides methods for secure access to CygNet system data for integration into desktop, mobile, or web applications.
Refer to the CygNet Help corresponding to your product version for information about CygNet Bridge companion products and installation guidance.

Required headers

All CygNet Bridge API requests must include the following headers:

X-WFT-AuthToken

contains authentication token obtained from the ClientLoginAPI method clientloginapi/api/login

X-WFT-CygNetDomain

contains the CygNet domain for the request

Access

Access control operations

API	Description
POST api/v1/access/checkUserLevel	Checks if a user has at least the permission level associated with the specified CygNet application and event

Alarms

Alarms operations

API	Description
POST api/v1/alarms	Retrieves alarms for a CygNet alarm service, optionally within a specified date range
POST api/v1/alarms/acknowledge	Acknowledges specified alarms for a CygNet alarm service
POST api/v1/alarms/clear?force={force}	Clears, or optionally force clears, specified alarms for a CygNet alarm service
GET api/v1/alarms/points/{pointTag}	Retrieves alarms for a specified point
POST api/v1/alarms/points	Retrieves alarms for a list of points
GET api/v1/alarms/facilities/{facilityTag}	Retrieves alarms for a specified facility
POST api/v1/alarms/facilities	Retrieves alarms for a list of facilities
GET api/v1/alarms/points/{pointTag}/canUserClear	Checks if the current user can clear a particular alarm
GET api/v1/alarms/points/{pointTag}/canUserAcknowledge	Checks if the current user can acknowledge a particular alarm
GET api/v1/alarms/points/{pointTag}/canUserForceClear	Checks if the current user can force clear a particular alarm

Devices

Devices operations

API	Description
POST api/v1/devices/sendCommand	Issues a command to a specified facility
GET api/v1/devices/{deviceId}/facilityLinks?siteService={siteService}	Retrieves facilities linked to a device
POST api/v1/devices/deids/getvalues	Retrieves data group element values from the device
POST api/v1/devices/deids/sendvalues	Sends data group element values to the device
GET api/v1/devices/getCommandInfo?facilityTag={facilityTag}&commandName={commandName}&getDetails={getDetails}	Retrieves command info for a facility and command, optionally with extended details
GET api/v1/devices/properties?siteService={siteService}&deviceId={deviceId}&deviceProperty={deviceProperty}	Retrieves a device property value for a device
POST api/v1/devices/datagroups/getTransactions	Retrieves transaction data for a device and data group, optionally with reference information
POST api/v1/devices/datagroups/sendTransactions	Sends data group transaction data to a device
POST api/v1/devices/datagroups/properties	Retrieves a data group property value for a device
POST api/v1/devices/datagroups/poll	Initiates polling of a device data group, optionally returning transaction data

Facilities

Facilities operations

API	Description
POST api/v1/facilities/tags	Retrieves a list of facility tags, contained within a FacilityTagsResponse object
GET api/v1/facilities/{facilityTag}	Retrieves a facility record
POST api/v1/facilities/{facilityTag}	Updates a facility record
PUT api/v1/facilities/{facilityTag}	Creates a new facility record
DELETE api/v1/facilities/{facilityTag}	Deletes a facility record
POST api/v1/facilities/{facilityTag}/relatives	Retrieves the requested relative facility tags
GET api/v1/facilities/metadata?siteService={siteService}	Retrieves facility service metadata
POST api/v1/facilities/properties	Retrieves properties for a set of facTags. Not all values of CygNetProperties are supported, the list of supported properties is quite long and therefore not fully enumerated.
GET api/v1/facilities/{facilityTag}/linkedDevices	Retrieves devices linked to a facility

Groups

Groups operations

API	Description
GET api/v1/groups/{nodeId}/children?siteService={siteService}&recursive={recursive}	Retrieves child headers for a specified group node
GET api/v1/groups/{nodeId}?siteService={siteService}	Retrieves the full record for a specified group node
GET api/v1/groups/roots?siteService={siteService}	Retrieves root headers for a specified group service
GET api/v1/groups/{nodeId}/leaves?siteService={siteService}	Retrieves leaf node headers for the hierarchy under the specified group node
GET api/v1/groups/metadata?siteService={siteService}	Retrieves group service metadata
GET api/v1/groups/nodepathlist?siteService={siteService}&ancestorNodeId={ancestorNodeId}&descendantNodeId={descendantNodeId}	Retrieves a list of nodes between ancestor and descendant
GET api/v1/groups/{nodeId}/parents?siteService={siteService}	Retrieves parent headers for a specified child group node
GET api/v1/groups/{nodeId}/properties?siteService={siteService}&property={property}	Retrieves a group property
POST api/v1/groups/nodes	Retrieves a list of nodes matching a set of filter criteria
GET api/v1/groups/{nodeId}/hierarchy?siteService={siteService}	Retrieves the group node hierarchy for a specified group node
GET api/v1/groups/{nodeId}/levelnode?siteService={siteService}	Retrieves the group node record for the first hierarchy level node of a specified group node

History

History operations

API	Description
GET api/v1/points/{pointTag}/history?start={start}&maxRecords={maxRecords}&end={end}	Retrieves history values for a point in forward timestamp order. When multiple entries exist for the same timestamp, only the last entry added at that timestamp is returned.
GET api/v1/points/{pointTag}/history/reverse?start={start}&maxRecords={maxRecords}&end={end}	Retrieves history values for a point in reverse timestamp order. When multiple entries exist for the same timestamp, only the last entry added at that timestamp is returned.
GET api/v1/points/{pointTag}/history/stats	Retrieves history statisticsfor a point
POST api/v1/points/{pointTag}/history/rollups/minutes	Retrieves minute-aligned history rollup values for a point
POST api/v1/points/{pointTag}/history/rollups/hours	Retrieves hour-aligned history rollup values for a point
POST api/v1/points/{pointTag}/history/rollups/days	Retrieves day-aligned history rollup values for a point

Measurement

Measurement operations

API	Description
GET api/v1/measurement/devices/{deviceName}?siteService={siteService}	Retrieves the FMS device record for a specified device name
POST api/v1/measurement/devices/create	Creates a new FMS device record
GET api/v1/measurement/nodeId/{nodeName}?siteService={siteService}	Retrieves the Node ID for a specified FMS Node name
GET api/v1/measurement/nodeName/{nodeId}?siteService={siteService}	Retrieves the Node name for a specified FMS Node ID
GET api/v1/measurement/unitSetId/{unitSetName}?siteService={siteService}	Retrieves the unit set ID for a specified unit set name
GET api/v1/measurement/unitSetName/{unitSetId}?siteService={siteService}	Retrieves the unit set name for a specified unit set ID
PUT api/v1/measurement/devices/{deviceName}/update?siteService={siteService}	Updates the FMS device record for a specified device name
POST api/v1/measurement/allGroups?siteService={siteService}	Retrieves a list of groups
POST api/v1/measurement/facilityTagsFromNodes?siteService={siteService}	Retrieves a list of facility tags associated with the specified Nodes
POST api/v1/measurement/nodesFromFacTag?siteService={siteService}	Retrieves a list of Node names associated with the specified facility tags. If multiple Nodes are associated with the same facility tag, only the first matching Node found in the database is returned.
GET api/v1/measurement/generalGroup/{groupName}?siteService={siteService}	Retrieves the specified general group from the connected FMS service.
POST api/v1/measurement/nodesInGroup?siteService={siteService}	Retrieves a list of Node names associated with the specified group Node.
GET api/v1/measurement/reportInfo/{reportName}?siteService={siteService}	Retrieves information about the report command associated with the specified report name retrieved from the connected FMS service.
GET api/v1/measurement/reportNames?siteService={siteService}	Retrieves a list of available report names associated with the connected FMS service.
GET api/v1/measurement/stationGroup/{groupName}?siteService={siteService}	Retrieves the specified station group from the connected FMS service.
GET api/v1/measurement/IsTransactionComplete/{transactionId}?siteService={siteService}	Returns true if the transaction with the specified ID has completed.
POST api/v1/measurement/createStationGroup?siteService={siteService}	Creates a new station group
POST api/v1/measurement/createGeneralGroup?siteService={siteService}	Creates a new general group
POST api/v1/measurement/groupsList?siteService={siteService}	Retrieves a list of group nodes
POST api/v1/measurement/fmsCommand?siteService={siteService}	Sends a command to the FMS service.
POST api/v1/measurement/fmsCommandWithTimeFormat?siteService={siteService}	Sends a command to the FMS service, and specifies the date/time format.
PUT api/v1/measurement/dataQualitySettings?siteService={siteService}	Modifies various data quality settings for the connected FMS service.
PUT api/v1/measurement/updateGasStation?siteService={siteService}	Sends a Gas Station record to the FMS service to update.
PUT api/v1/measurement/updateGeneralGroup/{groupName}?siteService={siteService}	Updates an existing general group in the connected FMS service.
PUT api/v1/measurement/updateStationGroup/{groupName}?siteService={siteService}	Updates an existing station group in the connected FMS service.

Notes

Notes operations

API	Description
POST api/v1/notes	Retrieves a list of notes
POST api/v1/notes/create	Creates a new note
GET api/v1/notes/{noteTag}	Retrieves the note for a specified note tag
PUT api/v1/notes/{noteTag}	Updates an existing note
GET api/v1/notes/types?siteService={siteService}	Retrieves the active note types

Points

Points operations

API	Description
POST api/v1/points/tags	Retrieves a list of point tags, contained within a PointTagsResponse object
POST api/v2/points/properties	Retrieves properties for a set of pointTags. Not all values of CygNetProperties are supported, the list of supported properties is quite long and therefore not fully enumerated. If you want to request a facility property, the point tag format must be one of the long formats which include the facility service.
GET api/v1/points/{pointTag}/config	Retrieves a point configuration record
POST api/v1/points/{pointTag}/config	Updates a point configuration record
PUT api/v1/points/{pointTag}/config	Creates a new point configuration record
DELETE api/v1/points/{pointTag}/config	Deletes a point configuration record
GET api/v1/points/{pointTag}/comment	Retrieves a point comment
POST api/v1/points/{pointTag}/comment	Updates a point comment record
GET api/v1/points/{pointTag}/questionableflag	Retrieves the value of the Questionable Flag for the provided point
GET api/v1/points/{pointTag}/questionabletimestamp	Retrieves the value of the Questionable Timestamp value for the provided point
POST api/v1/points/{pointTag}/questionable	Updates the Questionable state and optional reason for the provided point

Realtime

Realtime value operations

API	Description
POST api/v1/points/currentValues	Retrieves realtime value records for specified points
PUT api/v1/points/setPoint	Sets a new value for a point. Point tags are not validated for submission.

Services

CygNet services operations

API	Description
GET api/v1/services?types={types}&statuses={statuses}	Retrieves a list of services
GET api/v1/services/{siteService}/associated/{type}	Retrieves an associated service, of a specified type, for a CygNet site and service

Tables

Tables operations

API	Description
GET api/v1/tables/{tableName}?siteService={siteService}	Retrieves table service values