POST api/v1/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.

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type	Additional information
properties	List of properties to attempt to return, properties for all point tags	Collection of CygNetProperty	Required
pointTags	Point tags for requested properties	Collection of string	Required

Request Formats

application/json, text/json

Sample:

{
  "properties": [
    "Value",
    "Units",
    "Description"
  ],
  "pointTags": [
    "CYGSITE.UIS::ANTIER_GM.ANHEP",
    "CYGSITE.UIS::BRADY_GM.ANHEP"
  ]
}

Response Information

Resource Description

Point properties for a set of pointTags

Name	Description	Type	Additional information
results	List of point property result pairs	Collection of PointPropertyResultPairDTO	None
errors	List of point property errors	Collection of PointPropertyErrorPairDTO	None

Response Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "pointTag": "CYGSITE.UIS.00004637:ANTIER_GM_ANHEP:ANTIER_GM.ANHEP",
      "properties": [
        {
          "property": "Value",
          "value": "0.03"
        },
        {
          "property": "Units",
          "value": "%"
        },
        {
          "property": "Description",
          "value": "Heptane"
        }
      ]
    }
  ],
  "errors": [
    {
      "pointTag": "CYGSITE.UIS.00004637:BRADY_GM_ANHEP:BRADY_GM.ANHEP",
      "errors": [
        "Unable to read point config record for 'CYGSITE.UIS.00004637:ANTIER_GM_ANHEP:ANTIER_GM.ANHEP'"
      ]
    }
  ]
}