Filter tasks by basic criteria

Use this resource to retrieve tasks using a basic filter. You can pre-filter the tasks based on roles or other criteria.

Request

To retrieve the filtered tasks, send a POST request to the endpoint defined below.

URL: /task/baseFilterTasks

Method: POST

Authorization: required

POST /ibis/rest/task/baseFilterTasks?user=root&enableDIN5007Sort=false&lang=en&inactiveFilter=true&inactiveFilterComparison=%21%3d&nameSorting=ascending&start=0&count=10&Unit%2F%40nameFilter=admin&Unit%2F%40nameFilterComparison=%3D&Unit%2F%40typeFilter=Role&Unit%2F%40typeFilterComparison=%3D&nameFilter=Area&nameFilterComparison=LIKE 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
`user`	Enter the username.	yes	Any existing username
`enableDIN5007Sort`	Specify whether to enable German umlaut sorting (DIN 5007).	no	`true` or `false`
`start`	Enter the index of the first result row. The index starts at 0.	no	Any positive integer
`count`	Enter the maximum number of rows to return.	no	Any positive integer
`lang`	Enter the language code.	no (default: `de`)	`de` or `en`
`inactiveFilter`	Specify whether to filter by inactive status.	no	`true` or `false`
`inactiveFilterComparison`	Select the comparison operator for the inactive filter.	yes	`LIKE` \| `=` \| `<` \| `>` \| `⇐` \| `>0`
`nameSorting`	Select the sorting direction for the name.	no	`ascending` or `descending`
`nameFilter`	Enter the name to filter by.	no	E.g.: `admin`
`nameFilterComparison`	Select the comparison operator for the name filter.	no	`LIKE` \| `=` \| `<` \| `>` \| `⇐` \| `>0`
`Unit/@nameFilter`	Enter the unit name to filter by.	Yes if the request body is empty	E.g.: `admin`
`Unit/@nameFilterComparison`	Select the comparison operator for the unit name filter.	Yes if request body is empty	`LIKE` \| `=` \| `<` \| `>` \| `⇐` \| `>0`
`Unit/@typeFilter`	Enter the unit type to filter by.	Yes if the request body is empty	`role`
`Unit/@typeFilterComparison`	Select the comparison operator for the unit type filter.	Yes if request body is empty	`LIKE` \| `=` \| `<` \| `>` \| `⇐` \| `>0`
`{field}FieldSorting`	Select the sorting direction for a custom field. Replace `{field}` with the actual field name.	no	E.g.: `DummyField1typeFilter`=`ascending` or `descending`
`{field}typeFilter`	Enter the filter type for a custom field. Replace `{field}` with the actual field name.	no	E.g.: `DummyField1typeFilter`=`role`
`{field}FieldFilter`	Enter the filter value for a custom field. Replace `{field}` with the actual field name.	no	E.g.: `DummyField1fieldFilter`=`Custo`
`{field}FieldFilterComparison`	Select the comparison operator for a custom field filter. Replace `{field}` with the actual field name.	no	`LIKE` \| `=` \| `<` \| `>` \| `⇐` \| `>0`

user

Enter the username.

yes

Any existing username

enableDIN5007Sort

Specify whether to enable German umlaut sorting (DIN 5007).

true or false

start

Enter the index of the first result row. The index starts at 0.

Any positive integer

count

Enter the maximum number of rows to return.

Any positive integer

lang

Enter the language code.

no (default: de)

de or en

inactiveFilter

Specify whether to filter by inactive status.

true or false

inactiveFilterComparison

Select the comparison operator for the inactive filter.

yes

LIKE | = | < | > | ⇐ | >0

nameSorting

Select the sorting direction for the name.

ascending or descending

nameFilter

Enter the name to filter by.

E.g.: admin

nameFilterComparison

Select the comparison operator for the name filter.

LIKE | = | < | > | ⇐ | >0

Unit/@nameFilter

Enter the unit name to filter by.

Yes if the request body is empty

E.g.: admin

Unit/@nameFilterComparison

Select the comparison operator for the unit name filter.

Yes if request body is empty

LIKE | = | < | > | ⇐ | >0

Unit/@typeFilter

Enter the unit type to filter by.

Yes if the request body is empty

role

Unit/@typeFilterComparison

Select the comparison operator for the unit type filter.

Yes if request body is empty

LIKE | = | < | > | ⇐ | >0

{field}FieldSorting

Select the sorting direction for a custom field. Replace {field} with the actual field name.

E.g.: DummyField1typeFilter=ascending or descending

{field}typeFilter

Enter the filter type for a custom field. Replace {field} with the actual field name.

E.g.: DummyField1typeFilter=role

{field}FieldFilter

Enter the filter value for a custom field. Replace {field} with the actual field name.

E.g.: DummyField1fieldFilter=Custo

{field}FieldFilterComparison

Select the comparison operator for a custom field filter. Replace {field} with the actual field name.

LIKE | = | < | > | ⇐ | >0

Request Body

You can provide a JSON object in the request body to define the filter.

[
  {
    "Unit/@name": {
      "Role": [
        "admin",
        "user"
      ]
    },
    "Unit/@type": "Role"
  }
]

Response

The response contains the list of tasks matching the filter criteria.

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

<Tasklist user="admin" total="4">
    <Task id="feaa6622-cee9-4158-94c7-eb7026b47477" process="20004" creation="1719763229788" expiration="1720022429788" action="Form" wait="0" test="true" client="admin">
        <Name xml:lang="de">Task_with_helpInfo</Name>
        <Description xml:lang="de">Task_with_helpInfo</Description>
        <Unit name="admin" type="Role" />
    </Task>
    <Task id="d43670e8-b922-40c9-a82e-63ba8e480a5e" process="20004" creation="1719763229700" expiration="1720022429700" action="Form" wait="0" client="admin" delegateRuleSetId="7ebee7fc-7f00-0101-218f-31c48a953396">
        <Name xml:lang="de">Task_Delegate_to_role</Name>
        <Description xml:lang="de">Task_Delegate_to_role</Description>
        <Unit name="user" type="Role" />
        <History user="admin" target="" timestamp="1719826596242" type="Delegation">
            <Description xml:lang="de"></Description>
        </History>
    </Task>
    <Task id="743933ef-a4bb-4511-8c52-9511b62b3987" process="20004" creation="1719763229745" expiration="1720022429745" action="Form" wait="0" client="admin" delegateRuleSetId="7efed0e6-7f00-0101-218f-31c46b1f3241">
        <Name xml:lang="de">Task_Delegate_to_all</Name>
        <Description xml:lang="de">Task_Delegate_to_all</Description>
        <Unit name="user" type="Role" />
        <History user="admin" target="" timestamp="1719826577116" type="Delegation">
            <Description xml:lang="de"></Description>
        </History>
    </Task>
    <Task id="590ed670-d656-4c85-8a5f-eb7d68c8966d" process="20004" creation="1719763229766" expiration="1720022429766" action="Form" wait="2" test="true" client="admin">
        <Name xml:lang="de">Task_follow_up_id</Name>
        <Description xml:lang="de">Task_follow_up_id</Description>
        <Unit name="admin" type="Role" />
    </Task>
</Tasklist>

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.