POST api/v1/facilities/{facilityTag}/relatives

Retrieves the requested relative facility tags

CygNet Access Requirements

    CygNet ACS security: BRDGAPI ACCESS 1

    CygNet Bridge API license type: Base

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityTag

CygNet facility tag (Site.Service::FacilityId)

 string

Required

Body Parameters

Request object for retrieving relative facilities

NameDescriptionTypeAdditional information
relatives

List of reference path names for which to get relative facilities

 Collection of string

Required

Request Formats

application/json, text/json

Sample: 
{
  "relatives": [
    "Well",
    "Plunger",
    "Gas Meter",
    "Compressor"
  ]
}

Response Information

Resource Description

Facility tag of the relative facility

NameDescriptionTypeAdditional information
relativeFacilities

List of relative facilities

 Collection of RelativeFacilityDTO

None
errors

List of relative facility errors

 Collection of RelativeFacilityErrorPairDTO

None

Response Formats

application/json, text/json

Sample: 
{
  "relativeFacilities": [
    {
      "relationship": "Plunger",
      "relative": "CYGSITE.UIS::ASH_PL"
    },
    {
      "relationship": "Gas Meter",
      "relative": "CYGSITE.UIS::ASH_GM"
    },
    {
      "relationship": "Compressor",
      "relative": "CYGSITE.UIS::COLFAX_CDP"
    }
  ],
  "errors": [
    {
      "relationship": "Well",
      "error": "No relative facility found"
    }
  ]
}