POST api/v1/points/currentValues

Retrieves realtime value records for specified points

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Request DTO, contains list of point tags for values

Name	Description	Type	Additional information
pointTags	List of CygNet point tags	Collection of string	Required
updatedAfter	Optional datetime to change the return to only values updated since this date	date	None

Request Formats

application/json, text/json

Sample:

{
  "pointTags": [
    "CYGSITE.UIS::ASH_GM.PRDIFXIN",
    "CYGSITE.UIS::JEFFERY_WL.PRCASXIN"
  ],
  "updatedAfter": null
}

Response Information

Resource Description

Realtime records for specified points

Name	Description	Type	Additional information
currentValues	List of Value Pair DTOs for successful pointTag requests	Collection of RealtimeValuePairDTO	None
errors	List of errors for associated pointTags	Collection of RealtimeErrorPairDTO	None

Response Formats

application/json, text/json

Sample:

{
  "currentValues": [
    {
      "pointTag": "CYGSITE.UIS::ASH_GM.PRDIFXIN",
      "record": {
        "timestamp": "2018-10-11T09:17:47-07:00",
        "value": "1100.851486875",
        "alternateValue": "2.73935883993975",
        "status": [
          "Initialized",
          "Updated"
        ],
        "userStatus": [
          "PointScheme1",
          "ExternalValue"
        ],
        "externalStatus": 192
      }
    }
  ],
  "errors": [
    {
      "pointTag": "CYGSITE.UIS::JEFFERY_WL.PRCASXIN",
      "error": "Unable to read realtime point record for 'CYGSITE.UIS::JEFFERY_WL.PRCASXIN'"
    }
  ]
}