DataServer GetPoints

Retrieve a list of points on a specified Data Server.

Remarks

Users can search for the data servers 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 data servers that match the default search.

Request

GET dataservers/{webId}/points

URL Parameters

• webId

  The ID of the server. See WebID for more information.

• nameFilter

  A query string for filtering by point name. The default is no filter. When combined with the sourceFilter, the results will be those that satisfy both filters. See Query String for more information.

• sourceFilter

  A query string for filtering by point source. The default is no filter. When combined with the nameFilter, the results will be those that satisfy both filters.

• 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 matching points.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA",
      "Id": 82,
      "Name": "PointName",
      "Path": "\\\\MyPIServer\\PointName",
      "Descriptor": "12 Hour Sine Wave",
      "PointClass": "classic",
      "PointType": "Float32",
      "DigitalSetName": "",
      "Span": 100.0,
      "Zero": 0.0,
      "EngineeringUnits": "",
      "Step": false,
      "Future": false,
      "DisplayDigits": -5,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/points/I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA"
      }
    },
    {
      "WebId": "I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA",
      "Id": 82,
      "Name": "PointName",
      "Path": "\\\\MyPIServer\\PointName",
      "Descriptor": "12 Hour Sine Wave",
      "PointClass": "classic",
      "PointType": "Float32",
      "DigitalSetName": "",
      "Span": 100.0,
      "Zero": 0.0,
      "EngineeringUnits": "",
      "Step": false,
      "Future": false,
      "DisplayDigits": -5,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/points/I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA"
      }
    }
  ],
  "Links": {}
}