Element GetByPath

Retrieve an element by path.

Remarks

This method returns an element based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

Request

GET elements

URL Parameters

• path

  The path to the element. See Path Syntax 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 Paths to return all paths to the element. If this parameter is not specified, paths are not returned. See Associations for more information.

Status Codes

200: The specified element.

Sample Response Body

{
  "WebId": "I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA",
  "Id": "cbb28260-853d-11e4-80c5-00155d844304",
  "Name": "MachineName",
  "Description": "Manufacturing Equipment MachineName",
  "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\EngineeringProcess\\Equipment\\MachineName",
  "Paths": null,
  "TemplateName": "MachineName",
  "HasChildren": false,
  "CategoryNames": [
    "Equipment Assets"
  ],
  "ExtendedProperties": {},
  "Errors": null,
  "Links": {
    "Self": "https://localhost.osisoft.int/piwebapi/elements/I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA"
  }
}