Edit a filter

This request allows you to change the parameters of an issue filter.

https://api.tracker.yandex.net/v3/filters/<filter_id>

Request format

Before making the request, get access to the API.

To edit a filter, use an HTTP request with the PATCH method. Specify parameters in JSON format in the request body.

PATCH /v3/filters/<filter_id>
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": "<new_filter_name>",
    "filter": {
        "status": "open"
    }
}

Example 1: Change the filter name

• The HTTP PATCH method is used.
• The filter with ID 12345 is edited.
• Only the name parameter (the filter name) is changed.
• filter object: not specified, so the filtering conditions remain unchanged.

PATCH /v3/filters/12345 HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": "New filter name"
}

Example 2: Change filter conditions

• The HTTP PATCH method is used.
• The filter with ID 12345 is edited.
• Goal: change the filter so that it shows high-priority issues assigned to the current user.
• filter object: two new conditions are set:
  • Priority is critical (critical)
  • Assignee is the current user (me())
• Important: the filter parameter replaces conditions completely. All previous filter conditions are removed.

PATCH /v3/filters/12345 HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "filter": {
        "priority": "critical",
        "assignee": "me()"
    }
}

Example 3: Add sorting by priority

• The HTTP PATCH method is used.
• The filter with ID 12345 is edited.
• Goal: add sorting by priority (from highest to lowest) to an existing filter.
• sorts parameter: sorting results by the priority field in descending order (isAscending: false) is added.
• Note: this example doesn't specify the filter parameter, so the existing filter conditions remain unchanged. Only the sorting is changed.

PATCH /v3/filters/12345 HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "sorts": [
        {
            "field": "priority",
            "isAscending": false
        }
    ]
}

Response format

{
    "id": 12345,
    "self": "https://api.tracker.yandex.net/v3/filters/12345",
    "name": "New filter name",
    "filter": {
        "assignee": "me()",
        "status": "open"
    },
    "sorts": [
        {
            "field": {
                "self": "https://api.tracker.yandex.net/v3/fields/priority",
                "id": "priority",
                "display": "Priority"
            },
            "isAscending": false
        }
    ],
    "favorite": false,
    "permissions": {
        "WRITE": {
            "users": [
                {
                    "self": "https://api.tracker.yandex.net/v3/users/1234567890",
                    "id": "1234567890",
                    "display": "User Name",
                    "cloudUid": "ajevuhegoiuhfasjhiu",
                    "passportUid": 1234567890
                }
            ],
            "groups": [],
            "roles": []
        },
        "READ": {
            "users": [],
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/5",
                    "id": "5",
                    "display": "All employees"
                }
            ],
            "roles": []
        }
    },
    "owner": {
        "self": "https://api.tracker.yandex.net/v3/users/1234567890",
        "id": "1234567890",
        "display": "User Name",
        "cloudUid": "ajevuhegoiuhfasjhiu",
        "passportUid": 1234567890
    }
}