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

PI Web API Reference

AssetDatabase CreateAnalysisTemplate

AssetDatabase CreateAnalysisTemplate

Create an analysis template at the Asset Database root.

Remarks

Analyses that are based on an analysis template will inherit characteristics defined in the template.

Request

POST assetdatabases/{webId}/analysistemplates

URL Parameters

  • webId

    The ID of the database in which to create the analysis template. See WebID 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.

Body Parameter

The new analysis template definition.

Status Codes

201: The analysis template was created. The response's Location header is a link to the created template.

Sample Request Body

{
  "Name": "MyAnalysisTemplate",
  "Description": "",
  "AnalysisRulePlugInName": "PerformanceEquation",
  "CategoryNames": [
    "MyAnalysisCategory"
  ],
  "CreateEnabled": true,
  "GroupId": 0,
  "OutputTime": "",
  "TargetName": "MyElementTemplate",
  "TimeRulePlugInName": "Periodic"
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in