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.

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 or facility tags	Collection of CygNetProperty	Required
tags	Point or facility tags for requested properties	Collection of string	Required

Request Formats

application/json, text/json

Sample:

{
  "properties": [
    "FacilityCategory",
    "FacilityDescription"
  ],
  "tags": [
    "CYGSITE.UIS::ANTIER_GM",
    "CYGSITE.UIS::BRADY_GM"
  ]
}

Response Information

Resource Description

Facility properties for a set of facTags

Name	Description	Type	Additional information
results	List of CygNet property result pairs	Collection of CygNetPropertyResultPairDTO	None
errors	List of CygNet property errors	Collection of CygNetPropertyErrorPairDTO	None

Response Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "tag": "CYGSITE.UIS::ANTIER_GM",
      "properties": [
        {
          "property": "FacilityCategory",
          "value": "REMDEV"
        },
        {
          "property": "FacilityDescription",
          "value": "Antier GM"
        }
      ]
    }
  ],
  "errors": [
    {
      "tag": "CYGSITE.UIS::BRADY_GM",
      "errors": [
        "Unable to read facility record for 'CYGSITE.UIS::BRADY_GM'"
      ]
    }
  ]
}