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/ProcessDocumentation
Accept: application/xml, application/json
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., ProcessDocumentation

Response

Depending on the Accept header, the response contains the list of processes in XML or JSON format.

  • XML

  • JSON

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

<ProcessesList total="1">
    <Process href="http://localhost:8000/ibis/rest/process/processes/technical/ProcessDocumentation/TargetTWF_CL?lang=en" name="TargetTWF_CL" group="TestGroup"/>
</ProcessesList>
HTTP/1.1 200 OK
Content-Type: application/json

{
  "items": [
    {
      "href": "http://localhost:8000/ibis/rest/process/processes/technical/ProcessDocumentation/TargetTWF_CL?lang=en",
      "name": "TargetTWF_CL",
      "group": "TestGroup"
    }
  ],
  "total": 1
}

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