GetPointsAttributes

Retrieve the attributes of the Historian points.

Input Parameter

Item
Description
Request
GET
URL Parameter
  • request
    : JSON.
  • URL Parameter Members
    :
    • ServerName: String (required). The FactoryTalk Historian server name.
    • PointNames: Array in the string format (required). The point names to be queried in the Historian server.
    • PointAttributes: Array in the string format (required). The attributes to be retrieved of the points. Entering
      *
       retrieves all the attributes. For more information about the attributes that can be retrieved using the GetPointsAttributes service, see Attributes.
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Request Body
None
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 1

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request URL Parameter
request={"ServerName":"HisSrvName","PointNames":["*Point*"],"PointAttributes":["*"]}
Response Body
{
	"Result": {
		"TestPoint1": {
			"tag": "TestPoint1",
			"pointtype": 8,
			"pointid": 144,
			"step": 0,
			"future": 0,
			"excdevpercent": 0.1
		},
		"TestPoint2": {
			"tag": "TestPoint2",
			"pointtype": 8,
			"pointid": 145,
			"step": 0,
			"future": 0,
			"excdevpercent": 0.1
		}
	},
	"Success": true,
	"ErrorMessage": ""
}
TIP:
PointNames and PointAttributes support fuzzy matching.
  • "?" matches any single character in a specific position. For example, the wildcard query
    f?rm
     will match all of the words
    farm
    ,
    firm
    , and
    form
     - any word that begins with an
    f
    , is followed by any other character, and ends with the characters
    rm
    .
  • "*" matches any sequence of characters. For example, the wildcard query
    *rm
     will match all of the words
    farm
    ,
    firm
    , and
    form
    , as well as words like
    term
    ,
    alarm
    , and
    brainstorm
    .

Sample 2

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request URL Parameter
request={"ServerName":"HisSrvName","PointNames":["TestIndividualPoint"],"PointAttributes":["PointSource"]}
Response Body
{
	"Result": {
		"TestIndividualPoint": {
			"pointsource": "L"
		}
	},
	"Success": true,
	"ErrorMessage": ""
}
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal