Skip to content

API Logging

DeclanBuckley edited this page Jan 25, 2021 · 11 revisions

Home / API / Logging

Read.

Reads logging entries. Logging entries level is defined by deployment environment (All – Log everything Debug, Info, Warn, Error, Fatal, Off – Don’t log anything). You may get a list of current values by using the Read Type API (see below).

The StartDate and EndDate parameters should use the Sortable Date format, i.e. "yyyy-MM-ddTHH:mm:ss".

Authentication: Windows

Privilege : Administrator , Power User

Method: Logging.Logging_API.Read

Parameters:

Name Type Default Description
LggDatetimeStart DateTime Start of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").
LggDatetimeEnd DateTime End of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").

Return: Array [ Object ]

Name Type Description
LggDatetime String Date time of logged entry
LggThread String Numbers Thread that logged in
LggLevel String Logging entry level
LggClass String Logging entry Class name
LggMethod String Logging entry Method name
LggLine String Logging entry Line number
LggMessage String Logging entry Message details
LggException String Logging entry Exception details

Return: An example is shown below:

[
    {
        "LggDatetime":"2019-07-18T10:00:21.65",
        "LggThread":"12",
         "LggLevel":"INFO",
        "LggClass":"API.JSONRPC",
        "LggMethod":"ProcessRequest",
        "LggLine":"53",
        "LggMessage":"API Interface Opened",
        "LggException":""
    }
]
Clone this wiki locally