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

PI Web API Reference

ElementTemplate GetAnalysisTemplates

ElementTemplate GetAnalysisTemplates

Get analysis templates for an element template.

Request

GET elementtemplates/{webId}/analysistemplates

URL Parameters

  • webId

    The ID of the element template. See WebID 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 analysis templates for the specified element template.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA",
      "Id": "612d9811-3f06-4e27-989c-42e5e5c00b88",
      "Name": "MyAnalysisTemplate",
      "Description": "",
      "Path": "\\\\MyAssetServer\\MyDatabase\\AnalysisTemplates[MyAnalysisTemplate]",
      "AnalysisRulePlugInName": "PerformanceEquation",
      "CategoryNames": [
        "MyAnalysisCategory"
      ],
      "CreateEnabled": true,
      "GroupId": 0,
      "HasNotificationTemplate": false,
      "HasTarget": false,
      "OutputTime": "",
      "TargetName": "MyElementTemplate",
      "TimeRulePlugInName": "Periodic",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/analysistemplates/I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA"
      }
    },
    {
      "WebId": "I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA",
      "Id": "612d9811-3f06-4e27-989c-42e5e5c00b88",
      "Name": "MyAnalysisTemplate",
      "Description": "",
      "Path": "\\\\MyAssetServer\\MyDatabase\\AnalysisTemplates[MyAnalysisTemplate]",
      "AnalysisRulePlugInName": "PerformanceEquation",
      "CategoryNames": [
        "MyAnalysisCategory"
      ],
      "CreateEnabled": true,
      "GroupId": 0,
      "HasNotificationTemplate": false,
      "HasTarget": false,
      "OutputTime": "",
      "TargetName": "MyElementTemplate",
      "TimeRulePlugInName": "Periodic",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/analysistemplates/I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA"
      }
    }
  ],
  "Links": {}
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in