UpdatePointsValue

Insert or update historical values of the existing Historian points into the FactoryTalk Historian server (Data Archive).

Input Parameter

Item
Description
Request
POST
URL Parameter
None
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Request Body
  • request
    : JSON.
  • Parameters
    :
    • ServerName: String (required). The FactoryTalk Historian server name.
    • PointsValue: JSON Object (required).
      Struct Members:
      • Struct Key: String. The point name to be updated in the Data Archive.
      • Struct Members:
        • Value: Digital, String, Int16, Int32, Float16, Float32, Float64, and Timestamp.
        • Timestamp: Time.
        • Quality: Boolean (optional). The default value is true. If this value is set to false, the "Questionable" value will not take effect.
        • Questionable: Boolean (optional). The default value is false.
        • Annotation: String (optional). The default value is null.
Status Code
  • 200
    : The request succeeded.
  • 206
    : Partially processed.
  • 400
    : Bad request. For example, the URL parameter is not provided.
  • 401
    : Unauthorized.
  • 403
    : Forbidden.
  • 404
    : Resource not found.
  • 500
    : Internal server error.

Sample

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request Body
{
	"ServerName": "{{ServerName}}",
	"PointsValue": {
		"WebAPI_TestPoint4": {
			"Value": 999,
			"Timestamp": "2024-06-25 01:11:11"
		},
		"WebAPI_TestPoint5": {
			"Value": 222,
			"Timestamp": "2024-06-25 02:22:22 PM"
		}
	}
}
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal