Property description
The filter property filters the results on an API component (table, card, or chart).
Minimal JSON
{}{
"applicationId": {
"value": "@appId"
}
}Usage
Filters don’t have a predefined list of nested properties. To create a filter:
- Specify the parameter the filter should apply to.
- Provide a key or ID in the following formats to define which
valueof the parameter is used as the filter:-
string => { "value": "@exampleId" } or integer => { "value": [ 1 ] } or array of integers => { "value": [ 1, 2 ] }
-
Supported filters
The list below provides an overview of commonly used filter parameters.
Note that filters must be compatible with the component and API endpoint they are applied to. For a complete compatibility overview, refer to the API documentation documentation.
| Filter | Description | Value | Special supported values |
|---|---|---|---|
additionalObjectRelations | Applies filtering based on object relation type IDs. Used together with relationTypeKey to include or exclude data linked through specific relations. | array of integers | |
applicationId | Applies filtering based on application ID. Find the application ID in your Dawiso instance URL after .../app/. | integer | Use @appId to specify the current app. |
applicationIds | Applies filtering based on multiple application IDs. | array of integers | |
currentUserRelationIds | Applies filtering based on the current user’s relation IDs. Each user relation ID represents a custom identifier used for filtering. You can define new user relation IDs using the following properties: additionalUserRelations: Defines new user relation IDs., userRelationValues: Assigns users to the defined relation IDs., currentUserRelationIds: Specifies which relation IDs apply to the current user.{ "filter": { "additionalUserRelations": [ 11 ], "userRelationValues": { "11": "Name Surname" }, "currentUserRelationIds": [ 11 ] } } | array of integers | |
currentUserRelationTypeKeys | Applies filtering based on the current user’s relation type keys. For example, only objects where the current user is an owner are displayed. | array of strings | |
hierarchyId | Applies filtering based on object hierarchy ID. Used for hybrid hierarchies to filter objects in a folder or child objects (alternative for the parentObjectId filter which is not available for hybrid hierarchies). | integer | Use @hierarchyDefinitions to specify the currently used hierarchy. |
includeRelationsId | Includes the specified relation type ID. | integer | |
includeSubspaces | Determines whether subspaces are included in the count. | boolean | |
includeUserRelationIds | Includes the specified relation type IDs. | array of integers | |
facets | Applies additional facet filtering. | json | |
favouriteObjectTypes | Applies filtering of favorite objects based on object type IDs. | array of integers | |
formId | Applies filtering based on form ID. For more information, see Search Forms. | string | |
fulltextSearchId | Applies filtering based on fulltext search ID. | integer | |
languageCode | Applies filtering based on language code (e.g., EN-eng). | string | |
lastSelectedFacet | Applies filtering based on the last selected facet. | string | |
levels | Applies filtering based on the hierarchy level. Used in combination with the parentObjectId filter to select the specified levels of child objects. | integer | |
objectTypeKey | Applies filtering based on object type key. | string | |
objectTypeKeys | Applies filtering based on object type keys. | array of string | |
objectTypeId | Applies filtering based on object type ID. | integer | |
offset | Defines how many results to skip before returning data. Often used together with size. | integer | |
parentObjectId | Applies filtering based on parent object type ID. Find the parent object ID in your Dawiso instance URL after .../object/. | integer | Use @objectId to use the current object as the parent. |
relationTypeKey | Applies filtering based on user relation type key. | string | |
searchFilter | Applies filtering based on the search filter. | json | |
size | Specifies the maximum number of items to return in the result set. Often used together with offset. | integer | |
sort | Applies filtering based on the object sort type. | json | |
spaceId | Filters data based on a space. Find the space ID in your Dawiso instance URL after .../space/. | integer | Use @spaceId to specify the active space. |
statusName | Filters based on translation key of workflow state. | string | |
useSimpleQueryOnly | Determines whether only simple search queries are used. | boolean | |
workflowStateKey | Applies filtering based on workflow state key. | string | |
workflowStateKeys | Applies filtering based on workflow state keys. | array of string |