PUT api/v1/facilities/{facilityTag}

Creates a new facility record

CygNet Access Requirements

    CygNet ACS security: BRDGAPI ACCESS 3

    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 creating a new facility record

NameDescriptionTypeAdditional information
facility

Single Facility Record DTO

FacilityRecordDTO

None

Request Formats

application/json, text/json

Sample:
{
  "facility": {
    "tag": "CYGSITE.UIS::ASH_GM",
    "type": "MTRRUN",
    "description": "Ash Gas Meter",
    "category": "DDSFAC",
    "securityApp": "",
    "isActive": true,
    "isRefAny": true,
    "isRefPNT": true,
    "isRefDDS": true,
    "infos": [
      "",
      ""
    ],
    "textAttributes": [
      "",
      "",
      "",
      "CYGSITE.UIS::ASH_WL",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "LA Production",
      "LA",
      "Alexandria",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      ""
    ],
    "tableAttributes": [
      "PROD",
      "ORIFICE",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "COLFAX",
      "",
      "JOHNNY",
      "",
      "NORTH",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      ""
    ],
    "yesNoAttributes": [
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false
    ]
  }
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
facility

Single Facility Record DTO

FacilityRecordDTO

None

Response Formats

application/json, text/json

Sample:
{
  "facility": {
    "tag": "CYGSITE.UIS::ASH_GM",
    "type": "MTRRUN",
    "description": "Ash Gas Meter",
    "category": "DDSFAC",
    "securityApp": "",
    "isActive": true,
    "isRefAny": true,
    "isRefPNT": true,
    "isRefDDS": true,
    "infos": [
      "",
      ""
    ],
    "textAttributes": [
      "",
      "",
      "",
      "CYGSITE.UIS::ASH_WL",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "LA Production",
      "LA",
      "Alexandria",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      ""
    ],
    "tableAttributes": [
      "PROD",
      "ORIFICE",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "COLFAX",
      "",
      "JOHNNY",
      "",
      "NORTH",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      "",
      ""
    ],
    "yesNoAttributes": [
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false,
      false
    ]
  }
}