Stream RetrieveStreamUpdate

Receive stream updates

Remarks

The supplied marker will identify the set of stream updates to retrieve. For a 200 response, the returned location header will contain the url for retrieving the stream updates.

Request

GET streams/updates/{marker}

URL Parameters

• marker

  Identifier of stream source and current position

• desiredUnits

  The name or abbreviation of the desired units of measure for the returned value, as found in the UOM database associated with the attribute. If not specified for an attribute, the attribute's default unit of measure is used. If the underlying stream is a point, this value may not be specified, as points are not associated with a unit of measure.

• 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 stream updates have been successfully retrieved

404: Cache not found

409: Invalid marker supplied

Sample Response Body

{
  "Source": "I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg",
  "SourceName": "Water",
  "SourcePath": "\\\\MyAssetServer\\MyDatabase\\MyElement|Water",
  "RequestedMarker": "0cbbec466f3a42288c8c47112f54b852_0",
  "LatestMarker": "0cbbec466f3a42288c8c47112f54b852_12",
  "Status": "Updated",
  "Events": [
    {
      "Action": "Add",
      "PreviousEventAction": "PreviousEventArchived",
      "Timestamp": "2014-07-22T14:00:00Z",
      "UnitsAbbreviation": "m",
      "Good": true,
      "Questionable": false,
      "Substituted": false,
      "Annotated": false,
      "Value": 12.3
    },
    {
      "Action": "Add",
      "PreviousEventAction": "PreviousEventArchived",
      "Timestamp": "2014-07-22T14:00:00Z",
      "UnitsAbbreviation": "m",
      "Good": true,
      "Questionable": false,
      "Substituted": false,
      "Annotated": false,
      "Value": 12.3
    }
  ],
  "Links": {}
}