Retrieve monitoring log

This part of the REST API provides specific functionality towards retrieving a monitoring log. You can sort and filter the fetched result by different criteria

Request

URL: /log/{logName}

Method: GET

Authorization: required

GET /ibis/rest/log/systemLog HTTP/1.1
Accept: application/json
Host: localhost:8080

Request Path Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`logName`	Name of the log table to retrieve data from	yes	`systemLog` `queueLog` `processLog` `keyManagerLog` `connectionLog` `schedulerLog` `webserviceManager` `auditLog`

logName

Name of the log table to retrieve data from

yes

systemLog
queueLog
processLog
keyManagerLog
connectionLog
schedulerLog
webserviceManager
auditLog

Request Query Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`startIndex`	Starting index of the retrieved results (starts at 0)	no (default: 0)	Any positive integer
`noOfItems`	Number of records to be fetched	no	Any positive integer
`logTable`	Deprecated. Use parameter `logName`.	no	`processLog`
`sorting`	For sorting and the sorting order. For multiple sorting, value pairs must be separated by a comma ','. For `sortingOrder` the following values allowed: * `ASC` * `DESC`	no	<sortField>:<sortingOrder>
`filtering`	The field and the value for filtering. For multiple filtering, value pairs must be separated by a comma ','. For date fields, the following filters are supported (as in the workbench): * `lastDay` * `last7Days` * `last30Days`	no	<filterField>:<filterValue>
`lang`	language	no (default: de)	`de` or `en`
`format`	Response output format	no (default: `json` )	`json` - Response will be JSON formatted `xml` - Response will be XML formatted

startIndex

Starting index of the retrieved results (starts at 0)

no (default: 0)

Any positive integer

noOfItems

Number of records to be fetched

Any positive integer

logTable

Deprecated. Use parameter logName.

processLog

sorting

For sorting and the sorting order. For multiple sorting, value pairs must be separated by a comma ','. For sortingOrder the following values allowed:

* ASC * DESC

filtering

The field and the value for filtering. For multiple filtering, value pairs must be separated by a comma ','. For date fields, the following filters are supported (as in the workbench):

* lastDay * last7Days * last30Days

lang

language

no (default: de)

de or en

format

Response output format

no (default: json )

json - Response will be JSON formatted
xml - Response will be XML formatted

Response

HTTP/1.1 200 OK
Content-Tye: application/json

{
  "systemLog":  {
    "total":1,
    "success":true,
    "count":1,
    "row":[{
      "owner":"root",
      "index":1,
      "workflowName":"JMSTestListener",
      "message":"An error occured while connecting to the JMS provider. : Could not connect to broker URL: tcp://localhost:61616. Reason: java.net.ConnectException: Connection refused (Connection refused)",
      "priority":"normal",
      "inputModule":"System",
      "outputSize":0,
      "duration":0,
      "node":"172.17.0.1",
      "inputSize":0,
      "success":{
        "level":0,
        "content":false
      },
      "globalPId":0,
      "userDefined4":"",
      "userDefined5":"",
      "startTime":1639106909810,
      "userDefined2":"",
      "tag":"",
      "endTime":1639106909810,
      "userDefined3":"",
      "outputModule":"System",
      "userDefined1":"",
      "workflowId":0
    }]
  }
}

Examples

To retrieve the systemLog, filter the retrieved data by the workflowName field (wf_1, wf_2, wf_3) and sort by startTime (descending):

https://localhost:8000/ibis/rest/log/systemLog?filtering=workflowName:wf1,workflowName:wf2,workflowName:wf3&sorting=startTime:desc&format=xml

Errors

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

Invalid value (404): If format parameter value is invalid
Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.