GetArchiveValueBySingleTime

Retrieve a single recorded value based on the passed time and the following modes:
Mode
Description
Auto
Automatically determine the best retrieval mode.
AtOrBefore
Return a recorded value at the passed time. If no value exists at that time, return the previous recorded value.
Before
Return the first recorded value before the passed time.
AtOrAfter
Return a recorded value at the passed time. If no value exists at that time, return the next recorded value.
After
Return the first recorded value after the passed time.
Exact
Return a recorded value at the passed time. If no value exists at that time, return an error.

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.
    • Time: Time (required). The time that you want to retrieve the recorded values.
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

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request URL Parameter
request={"ServerName":"HisSrvName","PointNames":["TestPoint1"],"Time":"2024-03-21T10:18:23"}
Response Body
{
	"Result": {
		"TestPoint1": [{
				"Mode": "Before",
				"Vqt": {
					"Value": "Pt Created",
					"Quality": "Bad",
					"Timestamp": "2024-03-20T08:36:57Z"
				}
			},
			{
				"Mode": "At or Before",
				"Vqt": {
					"Value": "Pt Created",
					"Quality": "Bad",
					"Timestamp": "2024-03-20T08:36:57Z"
				}
			},
			{
				"Mode": "Auto",
				"Vqt": {
					"Value": "Pt Created",
					"Quality": "Bad",
					"Timestamp": "2024-03-21T02:18:23Z"
				}
			},
			{
				"Mode": "Exact",
				"Vqt": {
					"Value": "No Data",
					"Quality": "Bad",
					"Timestamp": "2024-03-21T02:18:23Z"
				}
			},
			{
				"Mode": "At or After",
				"Vqt": {
					"Value": "500",
					"Quality": "Good",
					"Timestamp": "2024-03-21T02:18:23.4118499Z"
				}
			},
			{
				"Mode": "After",
				"Vqt": {
					"Value": "500",
					"Quality": "Good",
					"Timestamp": "2024-03-21T02:18:23.4118499Z"
				}
			},
			{
				"Mode": "Interpolated",
				"Vqt": {
					"Value": "Pt Created",
					"Quality": "Bad",
					"Timestamp": "2024-03-21T02:18:23Z"
				}
			},
			{
				"Mode": "Current Value",
				"Vqt": {
					"Value": "500",
					"Quality": "Good",
					"Timestamp": "2024-03-21T02:18:23.4118499Z"
				}
			},
			{
				"Mode": "End Of Stream",
				"Vqt": {
					"Value": "500",
					"Quality": "Good",
					"Timestamp": "2024-03-21T02:18:23.4118499Z"
				}
			}
		]
	},
	"Success": true,
	"ErrorMessage": ""
}
TIP:
Time supports fuzzy matching.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal