Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Web API Reference

Attribute Update

Attribute Update

Update an attribute by replacing items in its definition.

Remarks

If an attribute is based on a template, the user must make sure to update the attribute appropriately so that it does not conflict with the template's design. Once a template is applied to an attribute, it can not be changed.

Request

PATCH attributes/{webId}

URL Parameters

  • webId

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

Body Parameter

A partial attribute containing the desired changes.

Status Codes

204: The attribute was updated.

Sample Request Body

{
  "Name": "Water",
  "Description": "2008 Water Use",
  "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,
  "CategoryNames": [
    "Energy Savings Targets"
  ],
  "TraitName": "LimitLoLo"
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in