# Поле

API методы для Поля.

## `DELETE /api/field/:id/dimension`

Удаляет измерение связанное с полем по ID.

### Параметры:

* **`id`** целое число больше нуля.

## `GET /api/field/:id`

Получить `Поле` по ID.

### Параметры:

* **`id`** целое число больше нуля.
* **`include_editable_data_model`** допустимая логическая строка (`true` или `false`).

## `GET /api/field/:id/related`

Возвращает связанные сущности.

### Параметры:

* **`id`** целое число больше нуля.

## `GET /api/field/:id/remapping/:remapped-id`

Получить переопределенную карту значений полей.

### Параметры:

* **`id`** целое число больше нуля.

* **`remapped-id`** целое число больше нуля.

* **`value`** непустая строка.

## `GET /api/field/:id/search/:search-id`

Искать значения поля с `search-id` которое начинается с `value`.

### Параметры:

* **`id`** целое число больше нуля.

* **`search-id`** целое число больше нуля.

* **`value`** непустая строка.

## `GET /api/field/:id/summary`

Получить количество и количество различных значений для поля с ID.

### Параметры:

* **`id`** целое число больше нуля.

## `GET /api/field/:id/values`

Если значение Поля `has_field_values` является списком `:list`, то возвращает список всех различных значений Поля или переопределенного Поля, и (если определено пользователем) карту переопределенных значений.

### Параметры:

* **`id`** целое число больше нуля.

## `GET /api/field/field%2C:field-name%2C:options/values`

Реализация метода значений полей для полей в виртуальной БД "Сохраненные вопросы". Этот метод используется, чтобы упростить код интерфейса. Он просто возвращает стандартный ответ "пустых" значений полей.

### Параметры:

* **`_`**

## `POST /api/field/:id/dimension`

Устанавливает измерение для заданного поля с ID.

### Параметры:

* **`id`** целое число больше нуля.

* **`type`** значение должно быть одним из: `internal`, `external`.

* **`dimension-name`** непустая строка.

* **`human_readable_field_id`** целое число больше нуля или null.

## `POST /api/field/:id/discard_values`

Скрыть значения, принадлежащие этому полю. Применяется только к полям, имеющим FieldValues. Если установлена автоматическая синхронизация FieldValues, они будут созданы заново в следующем цикле.

### Параметры:

* **`id`**

## `POST /api/field/:id/rescan_values`

Вручную инициирует обновление значений FieldValues для этого поля. Применяется только к полям, которые имеют право на FieldValues.

### Параметры:

* **`id`** целое число больше нуля.

## `POST /api/field/:id/values`

Обновляет значения полей читаемых значений для `Field`, чей семантический тип является `category`/`city`/`state`/`country` или чей тип базы `type/Boolean`. Читаемое значение опционально.

### Параметры:

* **`id`** целое число больше нуля.

* **`value-pairs`** последовательность векторов, содержащая ровно 1 элемент любого типа, или вектор, содержащий ровно 2 элемента: любого типа и непустая строка.


## `PUT /api/field/:id`

Обновить поле `Field` с ID.

### Параметры:

* **`visibility_type`** null или одно из: `retired`, `sensitive`, `normal`, `hidden`, `details-only`.

* **`display_name`** непустая строка или null.

* **`points_of_interest`** непустая строка или null.

* **`description`** непустая строка или null.

* **`semantic_type`** null или допустимый семантический или реляционный тип (ключевое слово или строка).

* **`coercion_strategy`** null или допустимая стратегия принуждения (ключевое слово или строка).

* **`has_field_values`** null или одно из: `auto-list`, `search`, `list`, `none`.

* **`settings`** карта или null.

* **`caveats`** непустая строка или null.

* **`fk_target_field_id`** целое число больше нуля или null.

* **`nfc_path`** null или последовательность значений, являющаяся непустой строкой.

* **`id`** целое число больше нуля.

* **`json_unfolding`** логическое значение или null.

---

[<< Назад к разделу API](./api-documentation.md)