Element GetAnalyses

Retrieve analyses based on the specified conditions.

Remarks

Users can search for the analyses based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the analyses that match the default search.

Request

GET elements/{webId}/analyses

URL Parameters

• webId

  The ID of the element, which is the Target of the analyses. See WebID for more information.

• 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 analyses matching the specified conditions.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA",
      "Id": "11853358-94bf-11e7-8443-00155d84c200",
      "Name": "MyAnalysis",
      "Description": "",
      "Path": "\\\\MyAssetServer\\MyDatabase\\MyElement\\Analyses[MyAnalysis]",
      "AnalysisRulePlugInName": "PerformanceEquation",
      "AutoCreated": false,
      "CategoryNames": [
        "MyAnalysisCategory"
      ],
      "GroupId": 0,
      "HasNotification": false,
      "HasTarget": true,
      "HasTemplate": false,
      "IsConfigured": false,
      "IsTimeRuleDefinedByTemplate": false,
      "MaximumQueueSize": 0,
      "OutputTime": "",
      "Priority": "High",
      "PublishResults": false,
      "Status": "Disabled",
      "TargetWebId": "I1ETDqD5loBNH0erqeqJodtALAjFPVfUpY-02A8uioGDSgIg",
      "TemplateName": "",
      "TimeRulePlugInName": "Periodic",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/analyses/I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA"
      }
    },
    {
      "WebId": "I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA",
      "Id": "11853358-94bf-11e7-8443-00155d84c200",
      "Name": "MyAnalysis",
      "Description": "",
      "Path": "\\\\MyAssetServer\\MyDatabase\\MyElement\\Analyses[MyAnalysis]",
      "AnalysisRulePlugInName": "PerformanceEquation",
      "AutoCreated": false,
      "CategoryNames": [
        "MyAnalysisCategory"
      ],
      "GroupId": 0,
      "HasNotification": false,
      "HasTarget": true,
      "HasTemplate": false,
      "IsConfigured": false,
      "IsTimeRuleDefinedByTemplate": false,
      "MaximumQueueSize": 0,
      "OutputTime": "",
      "Priority": "High",
      "PublishResults": false,
      "Status": "Disabled",
      "TargetWebId": "I1ETDqD5loBNH0erqeqJodtALAjFPVfUpY-02A8uioGDSgIg",
      "TemplateName": "",
      "TimeRulePlugInName": "Periodic",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/analyses/I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA"
      }
    }
  ],
  "Links": {}
}