GetInterpolatedValues

Retrieve interpolated values of Historian points within the specified time range.

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.
    • StartTime: Time in the string format (required). The start time of a time range.
    • EndTime: Time in the string format (required). The end time of a time range.
    • Intervals: String (required). The Sample interval. If specified in hours, minutes, seconds, or milliseconds, the time intervals will be evenly spaced UTC intervals. Longer interval types are interpreted using wall clock rules and are time zone dependent. For example, an interval created with the string "24h" means to use an evenly spaced 24 UTC hour interval between each event. On the other hand, an interval created with the string "1d" would return an interval shorter or longer than 24 hours if the interval encompasses a Daylight Savings Time change.
    • FilterExpression: String (optional). The mathematical expressions to eliminate data for which the expressions evaluate as false. The default value is empty.
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"],"StartTime":"*-8h","EndTime":"*","Intervals":"5m"}
Response Body
{
	"Result": [{
		"Name": "TestPoint1",
		"Vqts": [{
			"Value": "200",
			"Quality": "Good",
			"Timestamp": "2024-04-09T21:35:43.2302597Z"
		}]
	}],
	"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"
Request URL Parameter
request={"ServerName":"HisSrvName","PointNames":["TestPoint1","TestPoint2"],"StartTime":"2025-04-20T18:37:40.2606048Z”,"EndTime":"*","Intervals":"5m"}
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