ElementTemplate GetBaseElementTemplates

Get base element templates for an element template.

Remarks

The root template will be returned first, followed by successive templates in the inheritance chain.

Request

GET elementtemplates/{webId}/baseelementtemplates

URL Parameters

• webId

  The ID of the element template. See WebID for more information.

• maxCount

  The maximum number of objects to be returned. 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.

Status Codes

200: A list of base element templates for the specified element template.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g",
      "Id": "a7989492-b2ab-4d90-8abb-4c8284353dd6",
      "Name": "MachineName",
      "Description": "Manufacturing Machine MachineName",
      "Path": "\\\\MyAssetServer\\MyDatabase\\ElementTemplates[Boiler]",
      "AllowElementToExtend": false,
      "BaseTemplate": "Equipment",
      "InstanceType": "Element",
      "NamingPattern": "%TEMPLATE%",
      "CategoryNames": [
        "Equipment Assets"
      ],
      "ExtendedProperties": {},
      "Severity": "None",
      "CanBeAcknowledged": false,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/elementtemplates/I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g"
      }
    },
    {
      "WebId": "I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g",
      "Id": "a7989492-b2ab-4d90-8abb-4c8284353dd6",
      "Name": "MachineName",
      "Description": "Manufacturing Machine MachineName",
      "Path": "\\\\MyAssetServer\\MyDatabase\\ElementTemplates[Boiler]",
      "AllowElementToExtend": false,
      "BaseTemplate": "Equipment",
      "InstanceType": "Element",
      "NamingPattern": "%TEMPLATE%",
      "CategoryNames": [
        "Equipment Assets"
      ],
      "ExtendedProperties": {},
      "Severity": "None",
      "CanBeAcknowledged": false,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/elementtemplates/I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g"
      }
    }
  ],
  "Links": {}
}