Search process documentation

Use this resource to search for a keyword within the process documentation. The search includes the following elements:

Names of diagrams or modules
Comments in diagrams or modules
Metadata

Request

To search the process documentation, send a GET request to the endpoint defined below.

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

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`searchText`	Enter the text to search for.	yes	Any search text
`diagramType`	Specify the type of diagram.	no	`bpd` `technical` `organigram` `systemdiagram` `constraintsdiagram` `processmap`
`userGroup`	Specified user group	no	Any valid user group, e.g.: `admin`

searchText

Enter the text to search for.

yes

Any search text

diagramType

Specify the type of diagram.

bpd
technical
organigram
systemdiagram
constraintsdiagram
processmap

userGroup

Specified user group

Any valid user group, e.g.: admin

Response

The response contains a list of search results matching the criteria.

HTTP/1.1 200 OK
Content-Type: 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 is empty if the search text does not match any content.

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.