Get a process list by diagram type

Use this resource to retrieve a list of processes filtered by one or more diagram types.

Request

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

URL: /process/processes

Method: GET

Authorization: required

GET /ibis/rest/process/processes/?diagramType=bpd, technical, organigram, systemdiagram, constraintsdiagram, processmap HTTP/1.1
Accept: application/xml
Host: localhost:8080

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`diagramType`	Specify the diagram types to include in the result. Separate multiple types with a comma.	yes	`bpd` `technical` `organigram` `systemdiagram` `constraintsdiagram` `processmap`
`userGroup`	Specified user group	no	Any valid user group, e.g.: `admin`

diagramType

Specify the diagram types to include in the result. Separate multiple types with a comma.

yes

bpd
technical
organigram
systemdiagram
constraintsdiagram
processmap

userGroup

Specified user group

Any valid user group, e.g.: admin

Response

The response contains a list of processes that match the specified diagram types.

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

<ProcessesList>
    <Type href="http://localhost:8000/ibis/rest/process/processes//organigram?lang=en" name="organigram"/>
    <Type href="http://localhost:8000/ibis/rest/process/processes//technical?lang=en" name="technical"/>
    <Type href="http://localhost:8000/ibis/rest/process/processes//systemdiagram?lang=en" name="systemdiagram"/>
    <Type href="http://localhost:8000/ibis/rest/process/processes//bpd?lang=en" name="bpd"/>
    <Type href="http://localhost:8000/ibis/rest/process/processes//processmap?lang=en" name="processmap"/>
    <Type href="http://localhost:8000/ibis/rest/process/processes//constraintsdiagram?lang=en" name="constraintsdiagram"/>
</ProcessesList>

The response will be empty if no diagrams with the given diagram types are matched.

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.