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

PI Web API Reference

AssetServer GetTimeRulePlugIns

AssetServer GetTimeRulePlugIns

Retrieve a list of all Time Rule Plug-in's.

Request

GET assetservers/{webId}/timeruleplugins

URL Parameters

  • webId

    The ID of the asset server, where the Time Rule Plug-in's are installed.

  • 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 Time Rule Plug-in's.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1TPDqD5loBNH0erqeqJodtALAFPRV1lWW1kqmFRgvo4IAwQ",
      "Id": "d655f414-9655-4ad6-a615-182fa38200c1",
      "Name": "Periodic",
      "Description": "Creates regular periodic time periods.",
      "Path": "\\\\MyAssetServer\\PlugInsTimeRule[Periodic]",
      "AssemblyFileName": "OSIsoft.AF.Time.TimeRule.Periodic.dll",
      "AssemblyID": "7a635b27-3c3c-4a5f-bba9-01f06e9e525b",
      "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/timeruleplugins/I1TPDqD5loBNH0erqeqJodtALAFPRV1lWW1kqmFRgvo4IAwQ"
      }
    },
    {
      "WebId": "I1TPDqD5loBNH0erqeqJodtALAFPRV1lWW1kqmFRgvo4IAwQ",
      "Id": "d655f414-9655-4ad6-a615-182fa38200c1",
      "Name": "Periodic",
      "Description": "Creates regular periodic time periods.",
      "Path": "\\\\MyAssetServer\\PlugInsTimeRule[Periodic]",
      "AssemblyFileName": "OSIsoft.AF.Time.TimeRule.Periodic.dll",
      "AssemblyID": "7a635b27-3c3c-4a5f-bba9-01f06e9e525b",
      "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/timeruleplugins/I1TPDqD5loBNH0erqeqJodtALAFPRV1lWW1kqmFRgvo4IAwQ"
      }
    }
  ],
  "Links": {}
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in