Deploy reports

Use this resource to deploy reports to the INUBIT Process Engine.

Request

To deploy reports, send a PUT request to the endpoint defined below.

URL: /report

Method: PUT

Authorization: required (user with role System Administrator)

PUT /ibis/rest/report HTTP/1.1
Accept: multipart/form-data
Host: localhost:8080

Request Parameters

The following table lists the parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`reportzip`	Upload the report as a ZIP file.	yes	Any attachment
`deployuser`	Enter the name of the user for whom the report is to be deployed.	yes	Any string

reportzip

Upload the report as a ZIP file.

yes

Any attachment

deployuser

Enter the name of the user for whom the report is to be deployed.

yes

Any string

Response

The response confirms the successful deployment of the reports.

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="UTF-8"?>

<Protocol>
    <Date>15.02.2022 10:12:45</Date>
    <Type>ImportReportType.Diagram</Type>
    <AffectedFile></AffectedFile>
    <Results>
        <Result>
            <Description key="ImportReport.Module.Info.Modified">demo@report@-7c661299_17bba6c8eee_-7faa</Description>
            <ToolsetElementPath>
                <WorkflowName></WorkflowName>
                <ModuleName>demo@report@-7c661299_17bba6c8eee_-7faa</ModuleName>
            </ToolsetElementPath>
            <Date>15.02.2022 10:12:45</Date>
            <Type>3</Type>
            <TargetSystem>http://KOR-V-0003K.brt.emea.bosch.com:8000</TargetSystem>
            <User>admin</User>
        </Result>
        <Result>
            ...
        </Result>
    </Results>
</Protocol>

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.