> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Глоссарий: Настройки таблиц

> Справочник понятий, полей и адресов сохранённых раскладок колонок таблиц интерфейса.

Справочник к странице [«Настройки таблиц»](/ru/logic/settings/tables).

## Понятия

| Понятие                           | Значение                                                                                                                                                                                                                                                                             |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Настройка таблицы                 | Сохранённая раскладка колонок одной таблицы интерфейса для конкретной компании. Название уникально в рамках компании: пара «компания + название» задана ограничением, поэтому повторное создание с занятым названием возвращает ошибку «Настройка с таким названием уже существует». |
| Описание колонки                  | Структура одного элемента массива описаний колонок и правила подстановки значений по умолчанию. При чтении неполные описания дополняются значениями по умолчанию: ключ «undefined», ширина 24, колонка включена.                                                                     |
| Представление настройки таблицы   | Определяет, какие поля настройки таблицы принимаются и возвращаются через API. Компания в состав полей не входит и подставляется системой из текущего контекста.                                                                                                                     |
| Список и создание настроек таблиц | Отдаёт все настройки таблиц текущей компании и создаёт новую. Изменение доступно только владельцу компании, остальным — чтение.                                                                                                                                                      |
| Настройка таблицы по названию     | Чтение, изменение и удаление одной настройки таблицы, найденной по названию таблицы.                                                                                                                                                                                                 |

## Модели и поля

### Настройка таблицы

*Сохранённая раскладка колонок одной таблицы интерфейса для конкретной компании. Название уникально в рамках компании:
пара «компания + название» задана ограничением, поэтому повторное создание с занятым названием возвращает ошибку
«Настройка с таким названием уже существует».*

| Поле             | Тип    | Описание                                                                                                                                                                    |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Идентификатор    | число  | Внутренний номер записи, отдаётся в ответе API.                                                                                                                             |
| Название таблицы | текст  | Ключ таблицы, к которой относится раскладка; по нему же идёт обращение к отдельной настройке (чтение, изменение, удаление выполняются по названию, а не по идентификатору). |
| Описания колонок | список | Массив описаний колонок таблицы: каждый элемент задаёт ключ колонки, её ширину и включённость.                                                                              |
| Компания         | связь  | Компания-владелец настройки; выборка и создание всегда ограничены текущей компанией.                                                                                        |

### Описание колонки

*Структура одного элемента массива описаний колонок и правила подстановки значений по умолчанию. При чтении неполные
описания дополняются значениями по умолчанию: ключ «undefined», ширина 24, колонка включена.*

| Поле         | Тип   | Описание                                                                                                          |
| ------------ | ----- | ----------------------------------------------------------------------------------------------------------------- |
| Ключ колонки | текст | Идентификатор столбца таблицы; обязателен при сохранении, при чтении отсутствующий ключ отдаётся как «undefined». |
| Ширина       | число | Ширина колонки; необязательна, при чтении отсутствующая ширина отдаётся как 24.                                   |
| Активность   | флаг  | Показывать ли колонку; обязательна при сохранении, при чтении отсутствующее значение считается включённым.        |

### Представление настройки таблицы

*Определяет, какие поля настройки таблицы принимаются и возвращаются через API. Компания в состав полей не входит и
подставляется системой из текущего контекста.*

| Поле             | Тип    | Описание                                                                       |
| ---------------- | ------ | ------------------------------------------------------------------------------ |
| Идентификатор    | число  | Только для чтения.                                                             |
| Название таблицы | текст  | Название, по которому настройка находится и должно быть уникальным в компании. |
| Описания колонок | список | Вложенный список описаний колонок.                                             |

### Список и создание настроек таблиц

*Отдаёт все настройки таблиц текущей компании и создаёт новую. Компания проставляется автоматически; конфликт по уже
занятому названию превращается в понятную ошибку вместо системного сбоя. Изменение доступно только владельцу компании,
остальным — чтение.*

### Настройка таблицы по названию

*Чтение, изменение и удаление одной настройки таблицы, найденной по названию таблицы. Доступ только для авторизованных
пользователей; поиск идёт по названию в пределах текущей компании.*
