Retrieve monitoring log using combined criteria

This part of the REST API provides sorting or/and filtering of monitoring logs by using combined criteria.

Request

URL: /log/{logName}

Method: POST

Authorization: required

POST /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
`format`	Response output format	no (default: `json` )	`json` - Response will be JSON formatted `xml` - Response will be XML formatted

format

Response output format

no (default: json )

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

Request Body

Example:

<?xml version="1.0" encoding="UTF-8"?>
<logRequest>
    <startIndex>0</startIndex>
    <filtering>
        <field>owner</field>
        <value>root</value>
        <comparison>EQUAL</comparison>
    </filtering>
    <filtering>
        <field>workflowName</field>
        <value>JMS</value>
        <comparison>LIKE</comparison>
    </filtering>
    <filtering>
        <field>startTime</field>
        <value>1669106909810</value>
        <comparison>LESSER</comparison>
    </filtering>
    <filtering>
        <field>startTime</field>
        <value>1609106909810</value>
        <comparison>GREATER</comparison>
    </filtering>
    <filtering>
        <field>startTime</field>
        <value>lastDay</value>
        <comparison>EQUAL</comparison>
    </filtering>
    <filtering>
        <field>duration</field>
        <comparison>BETWEEN</comparison>
        <min>100</min>
        <max>2000</max>
    </filtering>
    <sorting>
        <field>startTime</field>
        <order>ASCENDING</order>
    </sorting>
    <sorting>
        <field>globalPId</field>
        <order>DESCENDING</order>
    </sorting>
</logRequest>

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
    }]
  }
}

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.