This Method allows a Client to retrieve LogRecords from the LogObject.
The signature of the Method is described below, and the arguments are described in Table 2.
Signature
GetRecords (
[in] 0:DateTime StartTime,
[in] 0:DateTime EndTime,
[in] 0:UInt32 MaxReturnRecords,
[in] 0:UInt16 MinimumSeverity,
[in] 0:LogRecordMask RequestMask,
[in] 0:ByteString ContinuationPointIn,
[out] LogRecordsDataTypeResults,
[out] 0:ByteString ContinuationPointOut
);
Table 2 – GetRecords Method arguments
|
Argument |
Description |
|
StartTime |
The time associated with the first LogRecord returned in the Results array, or if no there is no LogRecord at this time, then the first LogRecord returned will have the time closest to, but greater than StartTime. |
|
EndTime |
The time associated with the last LogRecord. EndTime must be equal to or greater than StartTime. No records more recent then EndTime are returned. If there are no LogRecords at EndTime, then the most recent record before EndTime is the last record in the Results array. |
|
MaxReturnRecords |
The maximum number of LogRecords to be returned, 0 indicates that no limit is specified. If this limit is specified then the LogRecords will start at StartTime, but may end before EndTime if the limit is reached. This shall result in a ContinuationPointOut being generated by the Server. On subsequent calls with the continuation point, the remaining LogRecords can be retrieved. |
|
MinimumSeverity |
The minimum Severity (all LogRecords with a Severity equal to this number or greater are returned). |
|
RequestMask |
The RecordMask indicates which optional fields in the LogRecord Structure are to be returned, if they are available. The LogRecordMask is defined in 5.7. |
|
ContinuationPointIn |
An opaque identifier provided by the Server from a previous call to GetRecords. This input parameter shall be null on an initial call to GetRecords. If not all records were returned on a previous call, the ContinuationPointOut can be provided to continue the retrieval of records. If a ContinuationPointIn is passed in, all other input arguments shall be the same as provided on the call that returned the ContinuationPointOut. If any of the input parameters are changed, the Server can ignore the updated parameters, it can detect any changes to the parameters and report an error or it can process the request as if it was a new request. If the Client specifies a ContinuationPointIn that is no longer valid, then the Server shall return a Bad_ContinuationPointInvalid error. |
|
Results |
Is a structure (see 5.9) that contains an array of the LogRecord Structure (see 5.4). The LogRecords shall be returned in chronological order from oldest to newest. |
|
ContinuationPointOut |
An opaque identifier that is used if the number of records to be returned is too large to be returned in a single response or if the Server requires the Client to call again. When this parameter is not used, its value is null. This identifier can be used to continue the retrieval of LogRecords in subsequent calls. |
StartTime and EndTime together form the range in which LogRecords are returned. If StartTime equals EndTime, then only LogRecord(s) that have the provided time are returned. If EndTime is earlier than StartTime, then the error Bad_InvalidParameter is returned.
Severity is a number between 1 and 1000 inclusive, a number outside of this range will result in the error Bad_InvalidParameter (see Table 5 for additional details).
A ContinuationPointOut shall be generated if the number of records to return between StartTime and EndTime is larger than what can be returned in a single Method call. It can also be returned due to an internal error or issue by the Server.
The GetRecords Method representation in the AddressSpace is formally defined in Table 3.
Table 3 – GetRecords Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
0:GetRecords |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
M |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
M |
|
|
|
|
|
|
|
|
ConformanceUnits |
|||||
|
LogObject Base |
|||||