Get monitoring log data

Use this resource to retrieve monitoring log data. You can sort and filter the results by different criteria.

Request

To retrieve the log data, send a GET request to the endpoint defined below.

URL: /log/{logName}

Method: GET

Authorization: required

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

Path Parameters

The following table lists the path parameters for this request.

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

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`startIndex`	Enter the starting index of the retrieved results. The index starts at 0.	no (default: 0)	Any positive integer
`noOfItems`	Enter the number of records to be fetched.	no	Any positive integer
`logTable`	Deprecated. Use the parameter `logName` instead.	no	`processLog`
`sorting`	Define the sorting order. Separate multiple values with a comma `,`. For `sortingOrder`, the following values are allowed: * `ASC` * `DESC`	no	`<sortField>:<sortingOrder>`
`filtering`	Define the filter criteria. Separate multiple values with a comma `,`. For date fields, the following filters are supported: * `lastDay` * `last7Days` * `last30Days`	no	`<filterField>:<filterValue>`
`lang`	Select the 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

Enter the starting index of the retrieved results. The index starts at 0.

no (default: 0)

Any positive integer

noOfItems

Enter the number of records to be fetched.

Any positive integer

logTable

Deprecated. Use the parameter logName instead.

processLog

sorting

Define the sorting order. Separate multiple values with a comma ,. For sortingOrder, the following values are allowed:

* ASC * DESC

<sortField>:<sortingOrder>

filtering

Define the filter criteria. Separate multiple values with a comma ,. For date fields, the following filters are supported:

* lastDay * last7Days * last30Days

<filterField>:<filterValue>

lang

Select the 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

The response contains the requested log data.

HTTP/1.1 200 OK
Content-Type: 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

The following example shows how to retrieve the system log. The data is filtered by the workflowName field (wf_1, wf_2, wf_3) and sorted by startTime (descending).

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

Errors

This request might return one of the following error codes:

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): The 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.