Updates an existing filter definition.

PUT

https://api.awork.com/api/v1/me/filters/:filterId

PUT

/api/v1/me/filters/:filterId

$ curl -X PUT https://api.awork.com/api/v1/me/filters/filterId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Urgent Tasks Filter",
>   "filterDefinition": {}
> }'

1 {
2   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3   "createdOn": "2023-11-01T09:15:30.000Z",
4   "createdBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
5   "updatedOn": "2023-11-15T16:45:00.000Z",
6   "updatedBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
7   "name": "Urgent Tasks Filter",
8   "filterDefinition": {
9     "conditionGroups": [
10       {
11         "conditions": [
12           {
13             "field": "priority",
14             "type": "Comparison",
15             "operator": "Equal",
16             "values": [
17               {
18                 "constantValue": "High",
19                 "filterValueKind": "Constant",
20                 "computedValueKind": "",
21                 "daysOffset": 0
22               }
23             ],
24             "customFieldInformation": {
25               "customFieldDefinitionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
26               "customFieldValueType": "Text"
27             }
28           }
29         ],
30         "connector": "And"
31       }
32     ],
33     "rootConnector": "And",
34     "entityType": "tasks"
35   },
36   "isExternal": false,
37   "entityType": "tasks",
38   "userId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
39   "filterQuery": "priority eq 'High'",
40   "workspaceAccessLevel": "read",
41   "contributors": [
42     {
43       "id": "b1a7f8d2-3c4e-4f5a-9a2b-1d2e3f4a5b6c",
44       "userId": "c2d3e4f5-6789-4abc-def0-1234567890ab",
45       "accessLevel": "manage",
46       "firstName": "Lisa",
47       "lastName": "Smith",
48       "hasImage": true,
49       "isDeactivated": false
50     }
51   ],
52   "teams": [
53     {
54       "id": "e4f5a6b7-c8d9-4e0f-9a1b-2c3d4e5f6a7b",
55       "teamId": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
56       "accessLevel": "read",
57       "name": "Designers",
58       "icon": "paintbrush",
59       "color": "purple"
60     }
61   ]
62 }

Required Permissions

Any authenticated user.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

filterIdstringRequiredformat: "uuid"

Identifier of the filter to update.

Request

The updated filter definition supplied by the caller.

namestringRequired0-1000 characters

The name of the filter.

filterDefinitionobjectRequired

The structured filter representation of a filter query.

workspaceAccessLevelenum or nullOptional

Determines the level of access to this filter granted to all workspace users. Can be either not set (no access), read, or manage.

Response

idstringOptionalformat: "uuid"

The id of the entity.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

namestring or nullOptional

The name of the filter.

filterDefinitionobjectOptional

The structured filter representation of a filter query.

isExternalbooleanOptional

Whether this filter is coming from an external workspace (awork Connect).

entityTypestring or nullOptional

The entity type this filter targets. Can be 'projects', 'tasks', 'companies', 'users'.

userIdstringOptionalformat: "uuid"

The id of the user this filter was created for.

filterQuerystring or nullOptional

The OData- query string that will be applied for querying this filter’s underlying data type.

workspaceAccessLevelstring or nullOptional

Determines the level of access to this filter granted to all workspace users. Can be either not set (no access), read, or manage.

contributorslist of objects or nullOptional

The users explicitly connected to this filter.

teamslist of objects or nullOptional

The teams explicitly connected to this filter.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error