AssetServer GetByName

Retrieve an Asset Server by name.

Remarks

This method returns an asset server based on the name associated with it. Users should primarily search with the WebID when available.

Request

GET assetservers

URL Parameters

• name

  The name of the server.

• 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 requested server.

Sample Response Body

{
  "WebId": "I1RSDqD5loBNH0erqeqJodtALA",
  "Id": "96f9a00e-4d80-471f-aba9-ea89a1db402c",
  "Name": "MyAssetServer",
  "Description": "Sample Description",
  "Path": "\\\\MyAssetServer",
  "IsConnected": true,
  "ServerVersion": "2.5.0.5039",
  "ServerTime": "2014-07-22T14:00:00Z",
  "ExtendedProperties": {},
  "Links": {
    "Self": "https://localhost.osisoft.int/piwebapi/assetservers/I1RSDqD5loBNH0erqeqJodtALA"
  }
}