Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Web API Reference

Stream UpdateValue

Stream UpdateValue

Updates a value for the specified stream.

Request

POST streams/{webId}/value

URL Parameters

  • webId

    The ID of the stream. See WebID for more information.

  • updateOption

    The desired AFUpdateOption. The default is 'Replace'. This parameter is ignored if the attribute is a configuration item. See Update Option for more information.

  • bufferOption

    The desired AFBufferOption. The default is 'BufferIfPossible'. See Buffer Option 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.

Body Parameter

The value to add or update.

Status Codes

202: The value was accepted for a potential buffered update. The response's Location header is a link that can be used to examine the result.

204: The update operation was successfully applied. The response's Location header is a link that can be used to examine the result.

400: The request was malformed.

409: The attribute or data reference does not support this operation, or the specified units are incompatible.

Sample Request Body

{
  "Timestamp": "2014-07-22T14:00:00Z",
  "UnitsAbbreviation": "m",
  "Good": true,
  "Questionable": false,
  "Value": 12.3
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in