GetByPath
GET elements

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.

URL Parameters

Status Codes

200: The specified element.

Sample Response

{
  "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"
  }
}
Enabling Operational Intelligence