Attribute Get

Retrieve an attribute.

Request

GET attributes/{webId}

URL Parameters

• webId

  The ID of the attribute. See WebID for more information.

• selectedFields

  List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields for more information.

• webIdType

  Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.

• associations

  Associated values to return in the response, separated by semicolons (;). This call supports DataReference to return attributes with data references. If this parameter is not specified, DataReference values are not returned. See Associations for more information.

Status Codes

200: The requested attribute.

Sample Response Body

{
  "WebId": "I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg",
  "Id": "75de231b-b591-49b1-b138-e725a77165c2",
  "Name": "Water",
  "Description": "2008 Water Use",
  "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\EngineeringProcess\\Equipment\\MachineName|Water(2008)",
  "Paths": [
    "\\\\MyAssetServer\\MyDatabase\\MyElement|MyAttribute",
    "\\\\MyAssetServer\\MyDatabase\\ReferencingElement\\MyElement|MyAttribute"
  ],
  "Type": "Int32",
  "TypeQualifier": "",
  "DefaultUnitsName": "liter",
  "DisplayDigits": -5,
  "DataReferencePlugIn": "Table Lookup",
  "ConfigString": "SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'",
  "IsConfigurationItem": false,
  "IsExcluded": false,
  "IsHidden": false,
  "IsManualDataEntry": false,
  "HasChildren": false,
  "CategoryNames": [
    "Energy Savings Targets"
  ],
  "Step": false,
  "TraitName": "LimitLoLo",
  "DefaultUnitsNameAbbreviation": "L",
  "Span": 100.0,
  "Zero": 0.0,
  "DataReference": null,
  "Links": {
    "Self": "https://localhost.osisoft.int/piwebapi/attributes/I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg"
  }
}