StreamSet GetEnd

Returns End of stream values of the attributes for an Element, Event Frame or Attribute

Remarks

Any time series value in the response that contains an 'Errors' property indicates PI Web API encountered a handled error during the transfer of the response stream. See Error Handling for more information.

Request

GET streamsets/{webId}/end

URL Parameters

• webId

  The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes. See WebID for more information.

• nameFilter

  The name query string used for filtering attributes. The default is no filter. See Query String for more information.

• categoryName

  Specify that included attributes must have this category. The default is no category filter.

• templateName

  Specify that included attributes must be members of this template. The default is no template filter.

• searchFullHierarchy

  Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.

• showExcluded

  Specified if the search should include attributes with the Excluded property set. The default is 'false'.

• showHidden

  Specified if the search should include attributes with the Hidden property set. The default is 'false'.

• sortField

  The field or property of the object used to sort the returned collection. For better performance, by default no sorting is applied. 'Name' is the only supported field by which to sort. See Sort Field for more information.

• sortOrder

  The order that the returned collection is sorted. The default is 'Ascending' See Sort Order for more information.

• 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: Summary values of the streams that meet the specified conditions.

409: Unsupported operation on the given AF object.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg",
      "Name": "Water",
      "Path": "\\\\MyAssetServer\\MyDatabase\\MyElement|Water",
      "Value": {
        "Timestamp": "2014-07-22T14:00:00Z",
        "UnitsAbbreviation": "m",
        "Good": true,
        "Questionable": false,
        "Substituted": false,
        "Annotated": false,
        "Value": 12.3
      },
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/attributes/I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg"
      }
    },
    {
      "WebId": "I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg",
      "Name": "Water",
      "Path": "\\\\MyAssetServer\\MyDatabase\\MyElement|Water",
      "Value": {
        "Timestamp": "2014-07-22T14:00:00Z",
        "UnitsAbbreviation": "m",
        "Good": true,
        "Questionable": false,
        "Substituted": false,
        "Annotated": false,
        "Value": 12.3
      },
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/attributes/I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg"
      }
    }
  ],
  "Links": {}
}