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 of the log table to retrieve data from |
yes |
|
Request Query Parameters
| Name | Description | Required | Allowed values |
|---|---|---|---|
|
Starting index of the retrieved results (starts at 0) |
no (default: 0) |
Any positive integer |
|
Number of records to be fetched |
no |
Any positive integer |
|
Deprecated. Use parameter |
no |
|
|
For sorting and the sorting order.
For multiple sorting, value pairs must be separated by a comma ','.
For * |
no |
<sortField>:<sortingOrder> |
|
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): * |
no |
<filterField>:<filterValue> |
|
language |
no (default: de) |
|
|
Response output format |
no (default: |
|
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.
{
"statusCode": 401,
"message": "Unauthorized access",
"path": "/rest/<endpoint>",
"timestamp": "2025-06-07T14:21:11.781"
}
- Resource Not Found (404)
-
The 404 (Not Found) status code indicates that the requested endpoint or resource is unavailable or does not exist on the server.
- Invalid value (404)
-
If
formatparameter 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.
{
"statusCode": 500,
"message": "Internal Server Error",
"path": "/rest/<endpoint>",
"timestamp": "2025-08-06T12:55:31.862"
}
- 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.
{
"statusCode": 503,
"message": "Service Unavailable",
"path": "/rest/<endpoint>",
"timestamp": "2025-08-06T12:58:06.688"
}