GET api/v1/facilities/metadata?siteService={siteService}
Retrieves facility service metadata
CygNet Access Requirements
CygNet ACS security: BRDGAPI ACCESS 1
CygNet Bridge API license type: Base
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteService |
CygNet site and service (Site.Service) of the Facility Service (FAC) |
string |
Required |
Body Parameters
None
Response Information
Resource Description
Attribute definitions for the specified Facility service
| Name | Description | Type | Additional information |
|---|---|---|---|
| infoAttributeDefinitions |
List of Info Attribute Definitions, should have 2 members when populated |
Collection of FacilityAttributeDefinitionDTO |
None |
| textAttributeDefinitions |
List of Text Attribute Definitions, should have 30 members when populated |
Collection of FacilityAttributeDefinitionDTO |
None |
| tableAttributeDefinitions |
List of Table Attribute Definitions, should have 30 members when populated |
Collection of FacilityAttributeDefinitionDTO |
None |
| yesNoAttributeDefinitions |
List of Yes or No Attribute Definitions, should have 20 members when populated |
Collection of FacilityAttributeDefinitionDTO |
None |
Response Formats
application/json, text/json
Sample:
{
"infoAttributeDefinitions": [
{
"description": "Facility Info 0",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityInfoAttribute0"
},
{
"description": "Facility Contact",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityInfoAttribute1"
}
],
"textAttributeDefinitions": [
{
"description": "SVCFacType",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute00"
},
{
"description": "Order in Type",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute01"
},
{
"description": "Attribute 2",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute02"
},
{
"description": "Facility Link",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute03"
},
{
"description": "Next ID 2",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute04"
},
{
"description": "Next ID 3",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute05"
},
{
"description": "Well #/ID",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute06"
},
{
"description": "Meter #/ID",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute07"
},
{
"description": "Tank #/ID",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute08"
},
{
"description": "Attribute 9",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute09"
},
{
"description": "Attribute 10",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute10"
},
{
"description": "GQ Source",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute11"
},
{
"description": "Contract #/ID",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute12"
},
{
"description": "Tank Farm",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute13"
},
{
"description": "Pad ID",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute14"
},
{
"description": "Attribute 15",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute15"
},
{
"description": "Attribute 16",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute16"
},
{
"description": "Attribute 17",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute17"
},
{
"description": "Attribute 18",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTextAttribute18"
},
{
"description": "Company",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute19"
},
{
"description": "System/Division",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute20"
},
{
"description": "Area",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute21"
},
{
"description": "Lateral",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute22"
},
{
"description": "Span",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute23"
},
{
"description": "Station",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute24"
},
{
"description": "Line",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute25"
},
{
"description": "Pack Seg",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute26"
},
{
"description": "Meter (Default)",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute27"
},
{
"description": "Coordinates Lat;Long",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute28"
},
{
"description": "Detail Screen",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTextAttribute29"
}
],
"tableAttributeDefinitions": [
{
"description": "Meter Use",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute00"
},
{
"description": "Meter Model",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute01"
},
{
"description": "Compressor Model",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute02"
},
{
"description": "Compressor Type",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute03"
},
{
"description": "Station Type",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute04"
},
{
"description": "Customer/Supplier",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute05"
},
{
"description": "Well Type",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute06"
},
{
"description": "Tank Type",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute07"
},
{
"description": "Lift Type",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute08"
},
{
"description": "Analyzer Type",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute09"
},
{
"description": "Table Attrib 10",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTableAttribute10"
},
{
"description": "Owner",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute11"
},
{
"description": "Table Attrib 12",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTableAttribute12"
},
{
"description": "Table Attrib 13",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTableAttribute13"
},
{
"description": "Table Attrib 14",
"category": "",
"inUse": false,
"isBoolean": false,
"propertyId": "FacilityTableAttribute14"
},
{
"description": "Field",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute15"
},
{
"description": "Reservoir",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute16"
},
{
"description": "Operator/Foreman",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute17"
},
{
"description": "Property",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute18"
},
{
"description": "Route",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute19"
},
{
"description": "Country",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute20"
},
{
"description": "State",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute21"
},
{
"description": "County",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute22"
},
{
"description": "Production Manager",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute23"
},
{
"description": "Tech",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute24"
},
{
"description": "Partner 1",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute25"
},
{
"description": "Partner 2",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute26"
},
{
"description": "Partner 3",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute27"
},
{
"description": "Partner 4",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute28"
},
{
"description": "Partner 5",
"category": "",
"inUse": true,
"isBoolean": false,
"propertyId": "FacilityTableAttribute29"
}
],
"yesNoAttributeDefinitions": [
{
"description": "Yes/No Attrib 0",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute00"
},
{
"description": "Yes/No Attrib 1",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute01"
},
{
"description": "Yes/No Attrib 2",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute02"
},
{
"description": "Yes/No Attrib 3",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute03"
},
{
"description": "Yes/No Attrib 4",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute04"
},
{
"description": "GCM",
"category": "",
"inUse": true,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute05"
},
{
"description": "Line Pack",
"category": "",
"inUse": true,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute06"
},
{
"description": "Yes/No Attrib 7",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute07"
},
{
"description": "Yes/No Attrib 8",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute08"
},
{
"description": "Yes/No Attrib 9",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute09"
},
{
"description": "Yes/No Attrib 10",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute10"
},
{
"description": "Yes/No Attrib 11",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute11"
},
{
"description": "Yes/No Attrib 12",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute12"
},
{
"description": "Yes/No Attrib 13",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute13"
},
{
"description": "Yes/No Attrib 14",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute14"
},
{
"description": "Yes/No Attrib 15",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute15"
},
{
"description": "Yes/No Attrib 16",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute16"
},
{
"description": "Yes/No Attrib 17",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute17"
},
{
"description": "Yes/No Attrib 18",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute18"
},
{
"description": "Yes/No Attrib 19",
"category": "",
"inUse": false,
"isBoolean": true,
"propertyId": "FacilityYesNoAttribute19"
}
]
}