Search in Process Documentation

This request retrieves information as per search text Search in Process Documentation modules search for a keyword in

Name of diagrams/modules
Comment in diagrams/modules
Metadata

Request

URL: process/search

Method: GET

Authorization: required

GET /ibis/rest/process/search?searchText=TestTaskGenWF&diagramType=bpd,technical, organigram,systemdiagram,constraintsdiagram,processmap&userGroup= HTTP/1.1
Accept: application/json
Host: localhost:8000

Request Query Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`searchText`	Text to search	yes	Any valid search text, e.g.: TestTaskGenWF
`diagramType`	Type of Diagram	optional	bpd technical organigram systemdiagram constraintsdiagram processmap
`userGroup`	User group	optional	Any valid user group, e.g.: admin
`lang`	language	no (default: de)	`de` or `en`

searchText

Text to search

yes

Any valid search text, e.g.: TestTaskGenWF

diagramType

Type of Diagram

optional

bpd
technical
organigram
systemdiagram
constraintsdiagram
processmap

userGroup

User group

optional

Any valid user group, e.g.: admin

lang

language

no (default: de)

de or en

Response

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

{
    "SearchResult": {
        "technical": {
            "Size": 1,
            "Objects": [
                {
                    "comments": "",
                    "workflowGroupDisplayName": "TestGroup",
                    "moduleList": [],
                    "count": 1,
                    "workflowDisplayName": "TestTaskGenWF",
                    "workflowName": "TestTaskGenWF",
                    "workflowType": "technical",
                    "workflowGroup": "TestGroup"
                }
            ]
        }
    },
    "SearchText": "TestTaskGenWF"
}

The response will be empty if the search text does not match with anything.

Errors

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