DataServer List

Retrieve a list of Data Servers known to this service.

Remarks

This method returns a list of all available known Data Servers that the user can connect to. Even though a server may be returned in the list, the user may not have permission to access it.

Request

GET dataservers

URL Parameters

• 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 all known servers.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1DS1km7hQHxB0i6-VfC-9MwAA",
      "Id": "85bb49d6-f101-4807-baf9-57c2fbd33000",
      "Name": "MyPIServer",
      "Path": "\\\\PIServer[MyPIServer]",
      "IsConnected": true,
      "ServerVersion": "3.4.390.18",
      "ServerTime": "2014-07-22T14:00:00Z",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/dataservers/I1DS1km7hQHxB0i6-VfC-9MwAA"
      }
    },
    {
      "WebId": "I1DS1km7hQHxB0i6-VfC-9MwAA",
      "Id": "85bb49d6-f101-4807-baf9-57c2fbd33000",
      "Name": "MyPIServer",
      "Path": "\\\\PIServer[MyPIServer]",
      "IsConnected": true,
      "ServerVersion": "3.4.390.18",
      "ServerTime": "2014-07-22T14:00:00Z",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/dataservers/I1DS1km7hQHxB0i6-VfC-9MwAA"
      }
    }
  ],
  "Links": {}
}