Element CreateAnalysis
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
Element CreateAnalysis
Create an Analysis.
Request
POST elements/{webId}/analyses
URL Parameters
-
webId The ID of the element on which to create the Analysis. 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 definition.
Status Codes
201: The Analysis was created. The response's Location header is a link to the Analysis.
Sample Request Body
{
"Name": "MyAnalysis",
"Description": "",
"AnalysisRulePlugInName": "PerformanceEquation",
"CategoryNames": [
"MyAnalysisCategory"
],
"GroupId": 0,
"MaximumQueueSize": 0,
"OutputTime": "",
"Priority": "High",
"PublishResults": false,
"Status": "Disabled",
"TemplateName": "",
"TimeRulePlugInName": "Periodic"
}