StreamSet GetRecordedAtTimeAdHoc

Returns recorded values based on the passed time and retrieval mode.

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/recordedattime

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.

• time

  The timestamp at which the values are desired. 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.

• retrievalMode

  An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'. See Retrieval Mode 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: Recorded 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": {}
}