GetEventFrames

Retrieve the Event Frames in the specified Asset Framework database within the specified time range.

Input Parameter

Item
Description
Request
GET
URL Parameter
  • request
    : JSON.
  • URL Parameter Members
    :
    • AfServerName: String (required). The Asset Framework server name.
    • DatabaseName: String (required). The database name to be queried in the Asset Framework server.
    • StartTime: Time in the string format (required). The start time when an event occurs.
    • EndTime: Time in the string format (required). The end time when an event ends.
    • SearchMode: String (optional). Select the mode to specify when the desired event frames occurred. The default value is StartInclusive.
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Request Body
None
Status Code
  • 200
    : The request succeeded.
  • 401
    : Unauthorized.
  • 403
    : Forbidden.
  • 404
    : Resource not found.
  • 500
    : Internal server error.

Sample

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request URL Parameter
request={"AfServerName":"YOURAFSERVER","DatabaseName":"YOURDATABASE","StartTime":"10/28/2023 12:00:00 AM","EndTime":"4/16/2024 5:07:20 PM","SearchMode":"StartInclusive"}
Response Body
{
	"Result": [{
		"Name": "TemperatureAnalysisTemplate 2023-10-28 00:00:00.000",
		"Time": "2023-12-05T02:00:50.002069Z",
		"PrimaryReferencedElementId": "65c65666-74b2-11ee-b276-000c2981d07e",
		"PrimaryReferencedElementPath": "\\\\YOURAFSERVER\\YOURDATABASE\\TemperatureHighElement1"
	}],
	"Success": true,
	"ErrorMessage": ""
}
TIP:
The search modes include:
  • StartInclusive
    : It includes all objects whose start time is within the specified range.
  • EndInclusive
    : It includes all objects whose end time is within the specified range.
  • Inclusive
    : It includes all objects whose start and end times are within the specified range.
  • Overlapped
    : It includes all objects whose time range overlaps with the specified range.
  • InProgress
    : It includes all objects whose start time is within the specified range and whose end time is December 31, 9999.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal