Get list of reports

Use this resource to retrieve a list of all reports available in INUBIT.

Request

To retrieve the list of reports, send a GET request to the endpoint defined below.

URL: /report/reportdata

Method: GET

Authorization: required

GET /ibis/rest/report/reportdata HTTP/1.1
Accept: application/json
Host: localhost:8080

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

lang

Control the output of language-dependent data.

no (default: en)

de or en

Response

The response contains a JSON list of available reports.

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

{
  "Report": [
    {
      "name": "DialChart",
      "id": "dialchart@report@1a072ec9_17ae2dffd13_-7e36",
      "type": "Dialchart",
      "myConfigData": {
        "myConfigData": {
          "ConditionElement": [
            "Workflow log.Status"
          ],
          "Description": "DialChart",
          "MajorType": "CHART",
          "Title": "DialChart",
          "Height": 350,
          "Width": 600,
          "ReportType": "Dialchart",
          "XAxis": [
            "Workflow log.Node"
          ],
          "Name": "DialChart",
          "YAxis": [
            "Workflow log.Duration",
            "Workflow log.Start"
          ]
        }
      }
    }, {
      "name": "Executions per hour",
      "id": "executions per hour@report@4797bf74_14ac9060432_-7b1c",
      "type": "Barchart",
      "myConfigData": {
        "myConfigData": {
          "ConditionElement": [],
          "Description": "",
          "MajorType": "CHART",
          "Title": "Number of executions per hour",
          "Height": 250,
          "Width": 600,
          "ReportType": "TimeSerieBarchart",
          "XAxis": ["Workflow log.Start"],
          "Name": "Executions per hour",
          "YAxis": ["Workflow log.Name"]
        }
      }
    }
  ]
}

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>
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.