FindPoints

Retrieve 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 points.
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":"PointSource:L"}
Response Body
{ "Result": ["Point1", "Point2"], "Success": true, "ErrorMessage": "" }
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal