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

PI Web API Reference

Point GetAttributes

Point GetAttributes

Get point attributes.

Request

GET points/{webId}/attributes

URL Parameters

  • webId

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

  • name

    The name of a point attribute to be returned. Multiple attributes may be specified with multiple instances of the parameter.

  • nameFilter

    The filter to the names of the list of point attributes to be returned. The default is no filter. See Query String 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.

Status Codes

200: A list of point attributes based on the specified names and name filter.

400: Some or all of the point attribute names could not be found.

Sample Response Body

{
  "Items": [
    {
      "Name": "typicalvalue",
      "Value": 50.0,
      "Links": {}
    },
    {
      "Name": "typicalvalue",
      "Value": 50.0,
      "Links": {}
    }
  ],
  "Links": {}
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in