Point GetMultiple

Retrieve multiple points by web id or path.

Request

GET points/multiple

URL Parameters

• webId

  The ID of a point. See WebID for more information. Multiple points may be specified with multiple instances of the parameter.

• path

  The path of a point. See Path Syntax for more information. Multiple points may be specified with multiple instances of the parameter.

• includeMode

  The include mode for the return list. See Include Mode for more information. The default is 'All'.

• asParallel

  Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested points. The default is 'false'.

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

207: Some or all items contain exceptions.

Sample Response Body

{
  "Items": [
    {
      "Identifier": "\\\\server\\path",
      "IdentifierType": "Path",
      "Object": {
        "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"
        }
      },
      "Exception": null
    },
    {
      "Identifier": "\\\\server\\path",
      "IdentifierType": "Path",
      "Object": {
        "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"
        }
      },
      "Exception": null
    }
  ],
  "Links": {}
}