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

PI Web API Reference

AnalysisRulePlugIn Get

AnalysisRulePlugIn Get

Retrieve an Analysis Rule Plug-in.

Request

GET analysisruleplugins/{webId}

URL Parameters

  • webId

    The ID of the Analysis Rule Plug-in. 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: The specified Analysis Rule Plug-in.

Sample Response Body

{
  "WebId": "I1XPDqD5loBNH0erqeqJodtALABWwqmmFvekaFShbb-52MAw",
  "Id": "9a2a6c05-6f61-467a-854a-16dbfb9d8c03",
  "Name": "Imbalance",
  "Description": "Calculates simple material imbalances on nodes of a model.",
  "Path": "\\\\MyAssetServer\\PlugInsAnalysisRule[Imbalance]",
  "AssemblyFileName": "OSIsoft.AF.Analysis.AnalysisRule.Imbalance.dll",
  "AssemblyID": "1acd00c2-79d0-4818-a03c-0616c4513750",
  "AssemblyLoadProperties": [
    "None"
  ],
  "AssemblyTime": "2016-05-25T14:01:07Z",
  "CompatibilityVersion": 2,
  "IsBrowsable": true,
  "IsNonEditableConfig": false,
  "LoadedAssemblyTime": "1970-01-01T00:00:00Z",
  "LoadedVersion": "",
  "Version": "2.8.5.7552",
  "Links": {
    "Self": "https://localhost.osisoft.int/piwebapi/analysisruleplugins/I1XPDqD5loBNH0erqeqJodtALABWwqmmFvekaFShbb-52MAw"
  }
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in