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/detail HTTP/1.1
Accept: text/plain
Content-Type: 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

reportzip

Upload the report as a ZIP file.

yes

Any attachment

Response

The response confirms the successful deployment of the reports.

HTTP/1.1 201 Created
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.

{
    "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.
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"
}