Get a process list by diagram group

Use this resource to retrieve a list of processes for a specific diagram type and diagram group.

Request

To retrieve the process list, send a GET request to the endpoint defined below.

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

Method: GET

Authorization: required

GET /ibis/rest/process/processes/technical/TargetTWF_CL HTTP/1.1
Accept: application/xml
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 name of the diagram group.

yes

Any valid diagram group, e.g., TargetTWF_CL

Response

The response contains the list of processes in XML format.

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

<ProcessesList>
    <Process href="http://localhost:8000/ibis/rest/process/processes//technical/ProcessDocumentation/TargetTWF_CL?lang=en" name="TargetTWF_CL" group="TestGroup"/>
</ProcessesList>

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.