Get diagram image

Use this resource to retrieve a diagram image in PNG format. The image is identified by the diagram type, group, and name.

Request

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

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

Method: GET

Authorization: required

GET /ibis/rest/process/processes/technical/ProcessDocumentation/TargetTWF_CL HTTP/1.1
Accept: image/png
Host: localhost:8000

Path Parameters

The following table lists the path parameters for this request.

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

Response

The response contains the diagram image in PNG format.

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

<binary image data>

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.