Get diagram image

Use this resource to retrieve a diagram image.

Request

To retrieve the diagram image, send a GET request to the endpoint defined below.

URL: /process/processes/{diagramType}/{diagramGroup}/{diagramName}

Append /version/{version} to retrieve a specific version.

Method: GET

Authorization: required

GET /ibis/rest/process/processes/technical/ProcessDocumentation/TargetTWF_CL
Accept: image/png, application/json
Host: localhost:8000

Path Parameters

The following table lists the path parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`diagramType`	Enter the type of the diagram.	yes	`bpd` `technical` `organigram` `systemdiagram` `constraintsdiagram` `processmap`
`diagramGroup`	Enter the diagram group.	yes	Any string
`diagramName`	Enter the diagram name.	yes	Any string
`version`	Enter the process version ID to retrieve a specific version.	no	Any valid version string

diagramType

Enter the type of the diagram.

yes

bpd
technical
organigram
systemdiagram
constraintsdiagram
processmap

diagramGroup

Enter the diagram group.

yes

Any string

diagramName

Enter the diagram name.

yes

Any string

version

Enter the process version ID to retrieve a specific version.

Any valid version string

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`lang`	Language for the diagram.	no	`en` (default), `de`
`zoomValue`	The zoom level for the generated image.	no	`1` (default) or other numeric string

lang

Language for the diagram.

en (default), de

zoomValue

The zoom level for the generated image.

1 (default) or other numeric string

Response

Depending on the Accept header, the response contains the diagram image in PNG format or a JSON object with the Base64 encoded image data.

HTTP/1.1 200 OK
Content-Type: image/png

<binary image data>

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

{
  "diagramName": "TargetTWF_CL",
  "mediaType": "image/png",
  "dataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}

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