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

PI Web API Reference

EventFrame CreateAttribute

EventFrame CreateAttribute

Create a new attribute of the specified event frame.

Request

POST eventframes/{webId}/attributes

URL Parameters

  • webId

    The ID of the event frame on which to create the attribute. See WebID 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.

Body Parameter

The definition of the new attribute.

Status Codes

201: The attribute was created. The response's Location header is a link to the created attribute.

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