Get reports in a folder

Use this resource to retrieve a list of reports or subfolders within a specific folder.

Request

To retrieve the reports or subfolders, send a GET request to the endpoint defined below.

URL: /report/reports/{folderName}/{subFolderName}

Method: GET

Authorization: required

GET /ibis/rest/report/reports/System+load HTTP/1.1
Accept: */*
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
`folderName`	Enter the folder name of the report.	yes	Any valid folder name
`subFolderName`	Enter the subfolder name of the report.	no	Any valid folder name

folderName

Enter the folder name of the report.

yes

Any valid folder name

subFolderName

Enter the subfolder name of the report.

Any valid folder name

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`lang`	Enter the language code for the report information.	no (default: `de`)	`de` or `en`

lang

Enter the language code for the report information.

no (default: de)

de or en

Response

The response contains a list of folders or reports located in the specified folder. If the response contains folders, use the URL provided in the href attribute to navigate deeper into the report tree structure.

HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8

<?xml version="1.0" encoding="UTF-8"?>
<ReportsList>
    <Folder href="http://localhost:8000/ibis/rest/report/reports/System+load/Today?lang=en" name="Today"/>
    <Folder href="http://localhost:8000/ibis/rest/report/reports/System+load/Last+30+days?lang=en" name="Last 30 days"/>
    <Folder href="http://localhost:8000/ibis/rest/report/reports/System+load/Last+7+days?lang=en" name="Last 7 days"/>
</ReportsList>

The following example shows a request to a subfolder and the corresponding response containing reports.

GET /ibis/rest/report/reports/System+load/Today HTTP/1.1
Accept: */*
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8

<?xml version="1.0" encoding="UTF-8"?>
<ReportsList>
    <Report id="festplattenauslastung pro knoten@report@4797bf74_14ac9060432_-7c38" href="<portal-processviewer-url>&amp;reportID=festplattenauslastung+pro+knoten%40report%404797bf74_14ac9060432_-7c38" type="Barchart" name="Hard disc usage per node"/>
    <Report id="speicherauslastung pro knoten@report@4797bf74_14ac9060432_-7c27" href="<portal-processviewer-url>&amp;reportID=speicherauslastung+pro+knoten%40report%404797bf74_14ac9060432_-7c27" type="Barchart" name="Memory usage per node"/>
    <Report id="prozessorauslastung pro knoten@report@4797bf74_14ac9060432_-7c2e" href="<portal-processviewer-url>&amp;reportID=prozessorauslastung+pro+knoten%40report%404797bf74_14ac9060432_-7c2e" type="Barchart" name="Processor load per node"/>
    <Report id="concurrent portal user@report@4797bf74_14ac9060432_-7ba2" href="<portal-processviewer-url>&amp;reportID=concurrent+portal+user%40report%404797bf74_14ac9060432_-7ba2" type="Linechart" name="Concurrent portal user"/>
</ReportsList>

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.