Point GetPointsBySearch

Retrieve points based on the specified conditions. By default, returns all points.

Request

GET points/search

URL Parameters

• dataServerWebId

  The ID of the server to use as the root of the query. See WebID for more information.

• query

  The query string is a list of filters used to perform a PI Point Query for the points in the data archive. An example would be: "query=Tag:=MyPoint*". See PIPoint Search Query Syntax for more information.

• 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). Cannot be greater than 1000. 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.

• searchNameAndDescriptor

  If true and the Tag attribute name is specified and the Descriptor attribute name is not specified in the query, then both of these attributes will be searched using the Tag query value. Otherwise, this parameter will be ignored.

• searchOption

  The search option to be applied to the Tag query filter. If the Tag attribute name is not in the query, then this parameter will be ignored. See Search Option for more information.

Status Codes

200: A list of points matching the specified conditions.

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": {}
}