Настройка шаблонов API

Библиотека API для Business Central предоставляет разработчикам упрощенное представление лежащих в ее основе объектов. Не все свойства в приложении предоставляются через связанный API. Страница Настройка API позволяет определить шаблоны, используемые для заполнения пустых свойств в объекте при создании действия POST через API.

Например, если для объекта товара определен шаблон конфигурации, при создании новой записи товара через API товаров все свойства нового товара, не определенные в вызове API, будут заполняться из выбранного шаблона. Например, если для поля Общая товарная группа не задается значение через API, однако значение задано в выбранном шаблоне, то к новому товару будет применено значение товарной группы, определенное в шаблоне.

Создание шаблона объекта

Чтобы использовать шаблоны с библиотекой API, необходимо сначала создать шаблоны и определить для них свойства. Создать эти шаблоны можно на странице Шаблоны конфигурации. Для получения дополнительной информации см. раздел Перенос локальных данных в Business Central Online в материалах для администраторов (только на английском языке).

Назначение шаблона API-интерфейсу

Чтобы назначить шаблон API-интерфейсу, необходимо выполнить следующие действия.

Примечание

Шаблоны API можно настроить только со следующими страницами API: contacts, countriesRegions, currencies, customers, employees, itemCategories, paymentMethods, paymentTerms, shipmentMethods, unitsOfMeasure и vendors.

1. Выберите значок , введите Настройка API, затем выберите соответствующую ссылку.

2. Выберите Создать, а затем выберите значение поля Порядок для записи.

   Если для API (ИД страницы) выбрано несколько шаблонов, шаблоны применяются в порядке, определенном в поле Порядок.

   При применении каждого шаблона значения полей, определенные в шаблоне, применяются только к полям, для которых еще не задано значение — либо явно в API, либо в ранее примененном согласно порядку шаблоне.

3. Выберите значение в поле ИД страницы.

   Это страница для API, к которому будет применяться шаблон. Поиск в поле ИД страницы выводит список всех API-интерфейсов, имеющихся в библиотеке.

4. Выберите значение в поле Код шаблона.

   Код шаблона — это код для шаблона, который был определен на странице Шаблоны конфигураций. Определенные в шаблоне значения применяются к API.

5. В поле Условия укажите, какой шаблон должен быть применен.

   Заданный шаблон применяется к новой записи, создаваемой через API, если и только если значения, уже определенные для нового экземпляра записи, соответствуют условиям, определенным в поле Условия.

См. также

Документация по API
Разработка Connect Apps для Business Central
Включение API
Конечные точки для API
Администрация

Бесплатные модули электронного обучения для Business Central можно найти здесь