---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Редактировать локальное поле очереди
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/api/queues/edit-local-field.md
  - https://yandex.ru/support/tracker/ru/api/queues/edit-local-field.md
  - href: https://yandex.ru/support/tracker/ru/api/queues/edit-local-field.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/tracker/ru/llms.txt?revision=r22105730
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt?revision=r22105730


# Редактировать локальное поле очереди

Запрос позволяет редактировать [локальное поле](https://yandex.ru/support/tracker/local-fields.html) задачи, привязанное к заданной очереди.

<div class="request_example yfm-code-floating-container method_patch">
    <p>PATCH</p>
    <pre><code>https://api.tracker.yandex.net/v3/queues/{id_очереди}/localFields/{ключ_поля}</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api/_assets/style/methods.md -->

<!-- endsource: ru/api/_assets/style/methods.md -->

## Формат запроса {#query}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api/access.md).

Чтобы изменить локальное поле, используйте HTTP-запрос с методом `PATCH`. В теле запроса укажите параметры в формате JSON:

```json translate=no
PATCH /v3/queues/{id_очереди}/localFields/{ключ_поля}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ

{
    "name":
    {
        "en": "Название поля на английском языке",
        "ru": "Название поля на русском языке"
    },
    "category": "0000000000000002********",
    "order": 102,
    "description": "Описание поля",
    "readonly": true,
    "visible": false,
    "hidden": false
}
```

<!-- source: ru/api/_includes/headings.md -->
{% cut "Заголовки" %}

* `Host`: адрес узла, предоставляющего API.

* <!-- source: ru/api/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth OAUTH_TOKEN` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#about_OAuth)

    - `Bearer IAM_TOKEN` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#iam-token)
  <!-- endsource: ru/api/_includes/authorization.md -->

* <!-- source: ru/api/_includes/content-type-json.md -->
  `Content-Type`: формат тела запроса. Должен иметь значение `application/json`.
  <!-- endsource: ru/api/_includes/content-type-json.md -->


* <!-- source: ru/api/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

  - если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок `X-Org-ID`,

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api/_includes/org-id.md -->

  <!-- source: ru/api/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api/_includes/org-id.md -->


{% endcut %}
<!-- endsource: ru/api/_includes/headings.md -->

{% cut "Ресурс" %}

Параметр | Описание | Тип данных
-------- | -------- | ----------
`id_очереди` | Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. | Строка
`ключ_поля` | Ключ локального поля.<br/>Чтобы получить ключ, используйте HTTP [запрос](get-local-fields.md):<br/>`GET /v3/queues/{id_очереди}/localFields` | Строка

{% endcut %}

{% cut "Параметры тела запроса" %}

**Дополнительные параметры**

Параметр | Описание | Тип данных
----- | ----- | -----
name | Название локального поля:<ul><li>`en` — на английском языке;</li><li>`ru` — на русском языке.</li></ul>| Строка
category | Объект с информацией о категории поля.<br/>Чтобы получить список всех категорий, используйте HTTP запрос:<br/>`GET /v3/fields/categories` | Строка
order | Порядковый номер в списке полей организации: [https://tracker.yandex.ru/admin/fields](https://tracker.yandex.ru/admin/fields). | Число
description | Описание локального поля. | Строка
[optionsProvider](#optionsProvider1) | Объект с информацией об элементах списка. | Объект
readonly | Возможность редактировать значение поля:<ul><li>`true` — значение поля нельзя изменить;</li><li>`false` — значение поля можно изменить.</li></ul> | Логический
visible | Признак отображения поля в задачах:<ul><li>`true` — всегда отображать поле в интерфейсе, даже если оно не заполнено. Такое поле нельзя скрыть кнопкой ![](../_assets/svg/add-icon.svg)</svg> **Изменить список параметров**.</li><li>`false` — значение по умолчанию. Поле отобразится в задаче, только если оно заполнено или добавлено кнопкой ![](../_assets/svg/add-icon.svg)</svg> **Изменить список параметров**.</li></ul>| Логический
hidden | Признак скрытого поля:<ul><li>`true` — полностью скрыть поле из интерфейса, даже если оно заполнено.</li><li>`false` — не скрывать поле.</li></ul> | Логический

**Поля объекта** `optionsProvider` {#optionsProvider1}

Параметр | Описание | Тип данных
-------- | -------- | ----------
type | Тип выпадающего списка: <ul><li>`FixedListOptionsProvider` — список строковых или числовых значений (для полей с типом `ru.yandex.startrek.core.fields.StringFieldType` или `ru.yandex.startrek.core.fields.IntegerFieldType`);</li><li>`FixedUserListOptionsProvider` — список пользователей (для полей с типом `ru.yandex.startrek.core.fields.UserFieldType`).</li></ul> | Строка
values | Значения для выпадающего списка. | Массив строк

{% endcut %}

> Пример: Отредактировать фиксированный набор строковых значений локального поля типа «Выпадающий список».
>
> - Используется HTTP-метод PATCH.
> - Тип поля: `FixedListOptionsProvider`.
> - Значения в выпадающем списке: «Первый элемент списка», «Второй элемент списка», «Третий элемент списка».
>
> ```json translate=no
> PATCH /v3/queues/QUEUE_ID/localFields/LOCAL_FIELD_ID
> Host: api.tracker.yandex.net
> Authorization: OAuth API_TOKEN
> Content-Type: application/json
> X-Org-ID: 1234******
>
>{
>     "optionsProvider": {
>     "type": "FixedListOptionsProvider",
>     "values": [
>          "Первый элемент списка",
>          "Второй элемент списка",
>          "Третий элемент списка"
>        ]
>    }
>}
> ```

## Формат ответа {#answer}

{% list tabs %}

- Запрос выполнен успешно

    <!-- source: ru/api/_includes/answer-200.md -->
    В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
    <!-- endsource: ru/api/_includes/answer-200.md -->

    Тело ответа содержит информацию о локальном поле очереди в формате JSON.

    ```json translate=no
     {
        "type": "local",
        "self": "https://api.tracker.yandex.net/v3/queues/ORG/localFields/loc_field_key",
        "id": "6054ae3a2b6b2c7f********--loc_field_key",
        "name": "Field name",
        "description": "Field description",
        "key": "loc_field_key",
        "version": 2,
        "schema": {
            "type": "string",
            "required": false
        },
        "readonly": true,
        "options": true,
        "suggest": false,
        "optionsProvider": {
           "type": "FixedListOptionsProvider",
           "needValidation": true,
           "values": [
              "First item",
              "Second item",
              "Third item"
             ]
          },
        "queryProvider": {
             "type": "StringOptionalQueryProvider"
        },
        "order": 102,
        "category": {
            "self": "https://api.tracker.yandex.net/v3/fields/categories/0000000000000002********",
            "id": "0000000000000002********",
            "display": "Системные"
        },
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/ORG",
            "id": "1",
            "key": "ORG",
            "display": "My queue"
        }
     }
    ```

    {% cut "Параметры ответа" %}

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    type | Тип поля. | Строка
    self | Адрес ресурса API, который содержит информацию о поле. | Строка
    id | Уникальный идентификатор поля. | Строка
    name | Название поля. | Строка
    description | Описание поля. | Строка
    key | Ключ поля. | Строка
    version | Версия поля. Каждое изменение поля увеличивает номер версии. | Число
    [schema](#schema) | Объект с информацией о типе данных значения поля. | Объект
    readonly | Возможность редактировать значение поля:<ul><li>`true` — значение поля нельзя изменить;</li><li>`false` — значение поля можно изменить.</li></ul> | Логический
    options | Ограничение списка значений:<ul><li>`true` — список значений не ограничен, можно задать любое значение;</li><li>`false` — список значений ограничен настройками организации.</li></ul> | Логический
    suggest | Наличие подсказки при вводе значения поля:<ul><li>`true` — при вводе значения появляется поисковая подсказка;</li><li>`false` — функция поисковой подсказки отключена.</li></ul> | Логический
    [optionsProvider](#optionsProvider) | Объект с информацией о допустимых значениях поля. | Объект
    [queryProvider](#queryProvider) | Объект с информацией о классе языка запроса.<br/>Класс невозможно изменить с помощью API. | Объект
    order | Порядковый номер в списке полей организации: [https://tracker.yandex.ru/admin/fields](https://tracker.yandex.ru/admin/fields) | Число
    [category](#category) | Объект с информацией о категории поля.<br/>Чтобы получить список всех категорий, используйте HTTP запрос:<br/>`GET /v3/fields/categories` | Объект
    [queue](#queue) | Объект с информацией об очереди задачи.| Объект


    **Поля объекта** `schema` {#schema}

    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    type | Тип значения поля. Возможные типы данных:<ul><li>`string` — строка. Присутствует у полей с единственным значением.</li><li>`array` — массив. Присутствует у полей с несколькими значениями.</li></ul> | Строка
    items | Тип значений. Присутствует у полей с несколькими значениями. | Строка
    required | Обязательность заполнения поля:<ul><li>`true` — поле обязательно для заполнения;</li><li>`false` — поле не обязательно для заполнения.</li></ul> | Логический

    **Поля объекта** `optionsProvider` {#optionsProvider}

    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    type | Тип выпадающего списка. | Строка
    needValidation | Проверка значения на валидность:<ul><li>`true` — проверять значение списка на валидность;</li><li>`false` — не проверять значение списка на валидность.</li></ul> | Логический
    values | Значения для выпадающего списка. | Массив строк

    **Поля объекта** `queryProvider` {#queryProvider}

    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    type | Тип языка запроса. | Строка

    **Поля объекта** `category` {#category}

    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    self | Адрес ресурса API, который содержит информацию о категории поля. | Строка
    id | Идентификатор категории поля. | Строка
    display | Отображаемое название категории. | Строка

    **Поля объекта** `queue` {#queue}

    <!-- source: ru/api/_includes/queue.md -->
    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит информацию об очереди. | Строка
    id | Идентификатор очереди. | Строка
    key | Ключ очереди. | Строка
    display | Отображаемое название очереди. | Строка
    <!-- endsource: ru/api/_includes/queue.md -->

    {% endcut %}


 - Запрос выполнен с ошибкой

    Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

    <!-- source: ru/api/_includes/answer-error-400.md -->
    400
    :   Один или несколько параметров запроса имеют недопустимое значение.
    <!-- endsource: ru/api/_includes/answer-error-400.md -->

    <!-- source: ru/api/_includes/answer-error-401.md -->
    401
    :   Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе [Доступ к API](https://yandex.ru/support/tracker/ru/api/access.md).
    <!-- endsource: ru/api/_includes/answer-error-401.md -->

    <!-- source: ru/api/_includes/answer-error-403.md -->
    403
    :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
    <!-- endsource: ru/api/_includes/answer-error-403.md -->

    <!-- source: ru/api/_includes/answer-error-404.md -->
    404
    :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
    <!-- endsource: ru/api/_includes/answer-error-404.md -->

    <!-- source: ru/api/_includes/answer-error-422.md -->
    422 
    :   Ошибка валидации JSON, запрос отклонен.
    <!-- endsource: ru/api/_includes/answer-error-422.md -->

    <!-- source: ru/api/_includes/answer-error-500.md -->
    500
    :   Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
    <!-- endsource: ru/api/_includes/answer-error-500.md -->

    <!-- source: ru/api/_includes/answer-error-503.md -->
    503
    :   Сервис API временно недоступен.    
    <!-- endsource: ru/api/_includes/answer-error-503.md -->

{% endlist %}