StreamSet GetPlotAdHoc

Returns values of attributes for the specified streams over the specified time range suitable for plotting over the number of intervals (typically represents pixels).

Remarks

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state). 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/plot

URL Parameters

• webId

  The ID of a stream. See Stream for more information. Multiple streams may be specified with multiple instances of the parameter. See WebID for more information.

• startTime

  An optional start time. The default is '*-1d'. See Time Strings for more information.

• endTime

  An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order. See Time Strings for more information.

• timeZone

  The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used. See Time Zone for more information.

• intervals

  The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).

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