SetPointsAttributes

Update the attributes' values of the existing Historian points.

Input Parameter

Item
Description
Request
PUT
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.
    • PointNames: Array in the string format (required). The point names to be queried in the Data Archive.
    • AttributesKeyValue: Key-value pair (required). The Attributes' values to be updated in the Data Archive.
Status Code
  • 200
    : The request succeeded.
  • 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": "HisSrvName",
	"PointNames": ["TestPoint1", "TestPoint2", "TestPoint3"],
	"AttributesKeyValue": {
		"PointSource": "FTHAPI",
		"PointType": 8
	}
}
Response Body
{
	"Result": true,
	"Success": true,
	"ErrorMessage": ""
}
TIP:
  • Parameters in the SetPointsAttributes service do not support fuzzy matching.
  • The SetPointsAttributes service does not support updating Attributes of "changedate", "creationdate", "creator", "pointid", "recno", and "changer". For more information about the Attributes that can be retrieved using the SetPointsAttributes service, see Attributes.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal