GetLiveValues

Retrieve the most recently acquired raw value 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 Data Archive.
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Response-Format
(optional): OPTIMIZE.
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":["TestPoint1"]}
Response Body
{ "Result": [{ "Name": "TestPoint1", "Vqts": [{ "Value": "200", "Quality": "Good", "Timestamp": "2024-03-21T02:18:23.4118499Z" }] }], "Success": true, "ErrorMessage": "" }

Sample 2

If the request header contains the response format of OPTIMIZE, the sample should be:
Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
"response-format": "optimize"
Requet URL Parameter
request={"ServerName":"HisSrvName","PointNames":["TestPoint1","TestPoint2"]}
Response Body
{ "Result": { "Names": [ "TestPoint1", "TestPoint2" ], "MaxCount": { "Name": "TestPoint2", "Count": 1 }, "Data": { "2025-04-20T18:37:40.2606048Z": [ [ "4096", "4096" ] ] } }, "Success": true, "ErrorMessage": "" }
TIP:
If names lack values at the time of retrieval, their values are displayed as empty.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal