metadata_read — Документация Кванты

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

Узнать состав объекта — реквизиты с типами, табличные части, формы, макеты, модули — прежде чем писать код или запрос.
Посмотреть свойства узла: тип реквизита, индексирование, проверку заполнения, периодичность регистра.
Обзор конфигурации — адрес Configuration; только нужные виды объектов — filter, например Document.
Перед записью — грань #help: какие ключи примет metadata_write, записи типов, пример; работает и для несуществующего узла.
Режим поддержки узла виден в заголовке ответа: 🔒 на поддержке или 📦 на поддержке.

Соседние инструменты домена «Метаданные»

metadata_writeWсоздать, изменить или удалить узел по тому же адресу metadata_actionAзаимствовать объект в расширение metadata_graphRкто использует объект и каких связей ему не хватает

Операции

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

Режимы metadata_read по адресу
Адрес или грань	Что возвращает
`<адрес объекта>`	Структура: что внутри — реквизиты, табличные части, формы, модули, макеты
`<адрес листа>`	Свойства реквизита, измерения, ресурса, значения перечисления
`<адрес>#properties`	Свойства узла; синоним `#свойства`
`<адрес>#source`	Структура узла; синоним `#структура`
`<адрес>#help`	Контракт `definition` для `metadata_write` по этому адресу; синоним `#справка`
`Configuration`	Навигатор конфигурации: все виды объектов с количеством
`ScheduledJob.<Задание>.Schedule`	Расписание регламентного задания целиком

Параметры

Параметры metadata_read
Параметр и тип	Обязательный	Описание	По умолчанию
`project`строка	да	Идентификатор проекта рабочей области EDT — имя из ответа project_read (например, УТ2020). Для расширения — проект расширения.	—
`fqn`строка	да	Адрес объекта или узла любого уровня: `Catalog.Контрагенты`, `Catalog.Контрагенты.Attribute.ИНН`, `InformationRegister.КурсыВалют.Dimension.Валюта`, `Configuration`. Грань — через `#`. Формы — в `form_read`.	—
`view`строка	нет	Вид вывода: `tree` — дерево (структура) или сгруппированные категории (свойства); `layout` — секции (структура) или плоский список «ключ — значение» (свойства).значения: tree · layout	`tree`
`detail`строка	нет	Подробность: `brief` — у структуры только имена, у свойств только отличные от умолчания; `default` — имена с типами и все свойства; `full` — плюс служебные идентификаторы.значения: default · brief · full	`default`
`filter`строка	нет	Регулярное выражение без учёта регистра. Сначала сопоставляется с названием секции (например, `Document`, `Attribute`) — совпавшая секция показывается целиком; иначе фильтрует элементы по именам.	—
`leveltree`целое	нет	Глубина дерева при `view: tree`: 1 — только корневые ветки с количеством, 2 — плюс их содержимое, 3 и больше — глубже.	`2`
`counting_methods`булево	нет	true — показывать число методов у модулей. Дольше: требует разбора кода.	`false`
`branch_limit`целое	нет	Сколько элементов показывать в одной ветке дерева; остальные сворачиваются в «… (N ещё)». Для полного перечня увеличьте до 100 или 1000.	`7`
`limit`целое	нет	Окно чтения: сколько строк готового ответа вернуть. По умолчанию 200, максимум 1000.	`200`
`offset`целое	нет	Окно чтения: номер строки ответа, с которой начать (0 — первая страница). Значение для следующей страницы подсказывает строка `lines: …` в конце ответа.	`0`

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

Адреса

Адрес — объект или узел любого уровня; Configuration — вся конфигурация. Формы, макеты и схемы компоновки читают свои инструменты.

Адреса metadata_read
Адрес	Что адресует
`Configuration`	навигатор конфигурации
`Catalog.Контрагенты`	структура справочника
`Catalog.Контрагенты#properties`	свойства справочника
`Catalog.Контрагенты.Attribute.ИНН`	свойства реквизита
`Document.РеализацияТоваровУслуг.TabularSection.Товары`	табличная часть с реквизитами
`Catalog.Контрагенты.Attribute#help`	контракт пакетного создания реквизитов
`CommonPicture.<Картинка>`	общая картинка: грань `#source` показывает саму картинку

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

Бесплатный инструмент: работает без ключа.

аргументы metadata_read

{ "project": "УТ2020", "fqn": "Catalog.Контрагенты", "view": "layout", "filter": "ИНН|КПП" }

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

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

Не найдено

Объекта или узла по адресу нет — ответ предлагает ближайшие имена. Список объектов вида — search с операцией symbol и параметром type.

Адрес формы

Адреса с сегментом Form читает form_read, макеты табличного документа — spreadsheet_read, схемы компоновки — dcs_read.

Ограничения

Длинные ответы режутся окном чтения: limit, offset, filter — Окно чтения.
Ветки дерева по умолчанию обрезаются до 7 элементов — увеличьте branch_limit или сузьте filter.