composition_settings_read

R · чтениепо подпискене изменяет проект

Читает настройки компоновки — выбранные поля, отборы, сортировку, структуру группировок, условное оформление, параметры данных и вывода — у настроек по умолчанию схемы, у варианта, у вложенной схемы или у динамического списка на форме. Каждый элемент показан с индексом [i] — готовым адресом для правки.

Когда использовать

Понять, что показывает вариант отчёта: поля, группировки, отборы.
Перед правкой — взять индекс элемента (…Filter[0], …Structure[0,1].Order) для composition_settings_write.
Настройки динамического списка на форме — адрес реквизита Список с хвостом ExtInfo.ListSettings.

Соседние инструменты домена «Отчёты СКД»

dcs_readRсхема: наборы, поля, параметры, ресурсы dcs_writeWСоздаёт, изменяет и удаляет узлы схемы компоновки данных — саму схему, наборы данных (запрос с автоматическими полями, объект, объединение), поля, параметры, вычисляемые поля, ресурсы, связи наборов, источники данных, вложенные схемы и варианты настроек. Один вызов — один узел; пачка — через коллекционный адрес.composition_settings_writeWсоздать, изменить на месте, удалить элемент настроек

Операции

Параметра operation у инструмента нет: что вернуть, задаёт адрес fqn — маркер-хвост и грань после #.

Режимы composition_settings_read по адресу
Адрес или грань	Что возвращает
`….DefaultSettings`	Настройки схемы по умолчанию
`….SettingsVariant.<Вариант>.Settings`	Настройки варианта
`….NestedSchema.<Схема>.Settings`	Настройки вложенной схемы
`<форма>.Attribute.Список.ExtInfo.ListSettings`	Настройки динамического списка на форме
`<адрес секции>#help`	Контракт `definition` для `composition_settings_write` по секции

Параметры

Параметры composition_settings_read
Параметр и тип	Обязательный	Описание	По умолчанию
`project`строка	да	Идентификатор проекта рабочей области EDT — имя из ответа project_read (например, УТ2020). Для расширения — проект расширения.	—
`fqn`строка	да	Якорь настроек: `…DefaultSettings`, `…SettingsVariant.<Вариант>.Settings`, `…NestedSchema.<Схема>.Settings` или `…Form.<Форма>.Attribute.Список.ExtInfo.ListSettings`. С гранью `#help` — контракт записи по секции.	—
`sections`массив (строка)	нет	Какие секции показать: `selection`, `filter`, `order`, `structure`, `conditionalAppearance`, `dataParameters`, `outputParameters`. По умолчанию — все.	—
`limit`целое	нет	Окно чтения: сколько строк готового ответа вернуть. По умолчанию 200, максимум 1000.	`200`
`offset`целое	нет	Окно чтения: номер строки ответа, с которой начать (0 — первая страница). Значение для следующей страницы подсказывает строка `lines: …` в конце ответа.	`0`
`filter`строка	нет	Регулярное выражение без учёта регистра. Сужает вывод: оставляет строки ответа, в которых есть совпадение (заголовки секций с совпадениями сохраняются). Применяется до окна чтения.	—

Таблица собрана из схемы инструмента, которую получает агент при подключении.

Адреса

Адреса composition_settings_read
Адрес	Что адресует
`Report.<Отчет>.Template.<Схема>.SettingsVariant.Основной.Settings`	вариант отчёта
`Report.<Отчет>.Template.<Схема>.DefaultSettings`	настройки по умолчанию
`Report.<Отчет>.Template.<Схема>.DefaultSettings.Filter#help`	контракт записи отбора
`Catalog.Контрагенты.Form.ФормаСписка.Attribute.Список.ExtInfo.ListSettings`	настройки динамического списка

Пример вызова и ответа

аргументы composition_settings_read

{
  "project": "УТ2020",
  "fqn": "Report.<Отчет>.Template.<Схема>.DefaultSettings",
  "sections": ["filter", "order"]
}

Пример ответа в подготовке Устройство ответа — на странице Формат ответов.

Отказы и ошибки

Не якорь настроек

Адрес должен заканчиваться одним из четырёх якорей: DefaultSettings, SettingsVariant.<Вариант>.Settings, NestedSchema.<Схема>.Settings или ExtInfo.ListSettings динамического списка. Состав схемы и имена вариантов — dcs_read.

failed · лицензия

Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.

Ограничения

Отключённый элемент (флажок «использование» снят) помечен как (выкл).