RenamePoint

Rename the existing points in the
FactoryTalk Historian SE
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.
    • PointName: Array in the string format (required). The point name that has been created in the Data Archive.
    • NewName: String (required). The new name of the point.
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", "PointName": "TestPoint1", "NewName": "NewTestPoint1" }
Response Body
{ "Result": "true", "Success": true, "ErrorMessage": "" }
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal