AnalysisRule GetAnalysisRules

Get the child Analysis Rules of the Analysis Rule.

Request

GET analysisrules/{webId}/analysisrules

URL Parameters

• webId

  The ID of the parent Analysis Rule. See WebID for more information.

• nameFilter

  The name query string used for finding Analysis Rules. The default is no filter. See Query String for more information.

• searchFullHierarchy

  Specifies if the search should include Analysis Rules nested further than the immediate children of the searchRoot. The default is 'false'.

• sortField

  The field or property of the object used to sort the returned collection. The default is 'Name'.

• sortOrder

  The order that the returned collection is sorted. The default is 'Ascending'.

• startIndex

  The starting index (zero based) of the items to be returned. The default is 0.

• maxCount

  The maximum number of objects to be returned per call (page size). 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 child Analysis Rules.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1XRXDqD5loBNH0erqeqJodtALAfyWdysKU5xGEQwAVXYTCAAfyWdysKU5xGEQwAVXYTCAA",
      "Id": "ca9d257f-94c2-11e7-8443-00155d84c200",
      "Name": "PerformanceEquation",
      "Description": "Runs a performance equation.",
      "Path": "\\\\MyAssetServer\\MyDatabase\\MyElement\\Analyses[MyAnalysis]\\AnalysisRule",
      "ConfigString": "a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;",
      "DisplayString": "a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;",
      "EditorType": "OSIsoft.AF.Analysis.AnalysisRule.PEAnalysisRuleEditor",
      "HasChildren": false,
      "IsConfigured": false,
      "IsInitializing": false,
      "PlugInName": "PerformanceEquation",
      "SupportedBehaviors": [
        "SupportsRunningCase",
        "SupportStatePassing",
        "OutputCorrectAfterSkipping"
      ],
      "VariableMapping": "b||Attribute1;c||Attribute2",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/analysisrules/I1XRXDqD5loBNH0erqeqJodtALAfyWdysKU5xGEQwAVXYTCAAfyWdysKU5xGEQwAVXYTCAA"
      }
    },
    {
      "WebId": "I1XRXDqD5loBNH0erqeqJodtALAfyWdysKU5xGEQwAVXYTCAAfyWdysKU5xGEQwAVXYTCAA",
      "Id": "ca9d257f-94c2-11e7-8443-00155d84c200",
      "Name": "PerformanceEquation",
      "Description": "Runs a performance equation.",
      "Path": "\\\\MyAssetServer\\MyDatabase\\MyElement\\Analyses[MyAnalysis]\\AnalysisRule",
      "ConfigString": "a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;",
      "DisplayString": "a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;",
      "EditorType": "OSIsoft.AF.Analysis.AnalysisRule.PEAnalysisRuleEditor",
      "HasChildren": false,
      "IsConfigured": false,
      "IsInitializing": false,
      "PlugInName": "PerformanceEquation",
      "SupportedBehaviors": [
        "SupportsRunningCase",
        "SupportStatePassing",
        "OutputCorrectAfterSkipping"
      ],
      "VariableMapping": "b||Attribute1;c||Attribute2",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/analysisrules/I1XRXDqD5loBNH0erqeqJodtALAfyWdysKU5xGEQwAVXYTCAAfyWdysKU5xGEQwAVXYTCAA"
      }
    }
  ],
  "Links": {}
}