ElementCategory GetByPath

Retrieve an element category by path.

Request

GET elementcategories

URL Parameters

• path

  The path to the target element category. 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.

Status Codes

200: The specified element category.

Sample Response Body

{
  "WebId": "I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA",
  "Id": "3051f943-7e4d-4241-ab9c-450a84c80450",
  "Name": "CategoryName",
  "Description": "Relative energy use per ton of process feed.",
  "Path": "\\\\MyAssetServer\\Database\\CategoriesElement[CategoryName]",
  "Links": {
    "Self": "https://localhost.osisoft.int/piwebapi/elementcategories/I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA"
  }
}