CreatePoints

Create 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.
    • PointNames: Array in the string format (required). The point names to be created in the Data Archive.
    • AttributesKeyValue: Key-value pair (required). The Attributes' values to be created in the Data Archive.
    • NoPtCreated: To not display the Pt Created value, set it to true. The default value is false.
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": "HisSrvName",
	"PointNames": ["TestPoint1", "TestPoint2", "TestPoint3"],
	"AttributesKeyValue": {
		"PointSource": "FTHAPI",
		"PointType": 8
	},
	"NoPtCreated": "true"
}
Response Body
{
	"Result": true,
	"Success": true,
	"ErrorMessage": ""
}
TIP:
  • The point types include:
    • 6
      : Int16
    • 8
      : Int32
    • 11
      : Float16
    • 12
      : Float32
    • 13
      : Float64
    • 101
      : Digital
    • 104
      : Timestamp
    • 105
      : String
  • All the points created from Historian WebAPI can use the point sources of FTHAPI, FTHAPI (1-99), and FTMS, which should be specified in the request parameter. If it is not specified, the default point source FTHAPI will be used. Before using these point sources, ensure that you set the point source limit in
    FactoryTalk® Administration Console
    .
  • The CreatePoints service does not support creating Attributes of "changedate", "creationdate", "creator", "pointid", "recno", and "changer". For more information about the Attributes that can be retrieved using the CreatePoints service, see Attributes.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal