GetPointsAttributesByCondition

Retrieve the attributes of the Historian points based on the Condition field.

Input Parameter

Item
Description
Request
GET
URL Parameter
  • request
    : JSON.
  • URL Parameter Members
    :
    • ServerName: String (required). The FactoryTalk Historian server name.
    • Condition: String (required). The query conditions to filter the Historian point attributes.
    • PointAttributes: Array in the string format (required). The point attributes to be retrieved in the Data Archive.
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Request Body
None
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 URL Parameter
request={"ServerName":"HisSrvName","Condition":"Tag=TestPoint* AND PointSource:L","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": ""
}
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal