EventFrame GetAttributes

Get the attributes of the specified event frame.

Request

GET eventframes/{webId}/attributes

URL Parameters

• webId

  The ID of the event frame. See WebID for more information.

• nameFilter

  The name query string used for finding attributes. The default is no filter. See Query String for more information.

• categoryName

  Specify that returned attributes must have this category. The default is no category filter.

• templateName

  Specify that returned attributes must be members of this template. The default is no template filter.

• valueType

  Specify that returned attributes' value type must be the given value type. The default is no value type filter. See Value Types for more information.

• searchFullHierarchy

  Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.

• sortField

  The field or property of the object used to sort the returned collection. The default is 'Name'. See Sort Field for more information.

• sortOrder

  The order that the returned collection is sorted. The default is 'Ascending'. See Sort Order for more information.

• startIndex

  The starting index (zero based) of the items to be returned. The default is 0.

• showExcluded

  Specified if the search should include attributes with the Excluded property set. The default is 'false'.

• showHidden

  Specified if the search should include attributes with the Hidden property set. The default is 'false'.

• maxCount

  The maximum number of objects to be returned per call (page size). The default is 1000.

• 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.

• trait

  The name of the attribute trait. Multiple traits may be specified with multiple instances of the parameter. See Attribute Trait for more information.

• traitCategory

  The category of the attribute traits. Multiple categories may be specified with multiple instances of the parameter. If the parameter is not specified, or if its value is "all", then all attribute traits of all categories will be returned. See Attribute Trait for more information.

Status Codes

200: A list of child attributes.

Sample Response Body

{
  "Items": [
    {
      "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"
      }
    },
    {
      "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"
      }
    }
  ],
  "Links": {}
}