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 Path Parameters
Name | Description | Required | Allowed values |
---|---|---|---|
|
Text to search |
yes |
Any valid search text, e.g.: TestTaskGenWF |
|
Type of Diagram |
optional |
|
|
User group |
optional |
Any valid user group, e.g.: admin |
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.
<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.