Создание пользовательского API в Power Apps

При создании пользовательского API необходимо использовать решение. Если вы не знакомы с решениями, сначала ознакомьтесь со статьей "Создание решения".

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

Это важно

• Теперь есть лучший интерфейс для создания пользовательского API. Конструктор можно использовать в инструменте регистрации подключаемых модулей. Дополнительные сведения: создание пользовательского API с помощью средства регистрации подключаемых модулей
• Многие поля, связанные с созданием пользовательского API, не могут быть изменены после их создания. Перед началом работы необходимо тщательно спланировать проектирование пользовательского API. Если позже вы решите, что необходимо изменить вещи после создания пользовательского API, может потребоваться удалить существующую запись и повторно создать пользовательский API. Просмотрите сведения о столбцах, которые не могут быть изменены здесь: таблицы CustomAPI

Создайте пользовательскую запись API

1. В решении выберите новый>>дополнительный>пользовательский API из раскрывающегося списка.

2. Измените поля, чтобы задать свойства пользовательского API. Необходимо задать значения для следующих полей. Дополнительные сведения см. в столбцах таблицы настраиваемых API

   Невозможно задать значения для типа подключаемого модуля перед его созданием. Это имя можно будет изменить впоследствии.

3. Нажмите кнопку "Сохранить". Форма должна выглядеть примерно так:

Создайте любые параметры запроса

Пользовательский API не требует параметров. Создайте столько параметров, сколько необходимо передать данные, необходимые для логики.

1. В решении в раскрывающемся списке выберите новый>>дополнительный параметр>запроса пользовательского API.

2. Измените поля, чтобы задать свойства настраиваемого параметра запроса API. Дополнительные сведения см. в разделе "Столбцы таблицы CustomAPIRequestParameter"

3. Нажмите кнопку "Сохранить". Форма должна выглядеть примерно так:

   

Создайте любые свойства ответа

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

Если определено только одно свойство ответа Entity или EntityCollection , ответ имеет этот тип. Если есть несколько свойств или один или несколько свойств простого типа, API возвращает сложный тип, где каждое свойство ответа является свойством этого сложного типа.

Например, если пользовательское имя API Unique имеет sample_CustomAPIExampleзначение, оно возвращает сложный тип sample_CustomAPIExampleResponse с свойствами для каждого определенного свойства ответа.

1. В вашем решении выберите в раскрывающемся списке Новое>Больше>Другое>Свойство пользовательского ответа API.

2. Измените поля, чтобы задать свойства пользовательского свойства ответа API. Дополнительные сведения см. в разделе "Столбцы таблицы CustomAPIResponseProperty"

3. Нажмите кнопку "Сохранить". Форма должна выглядеть примерно так:

   

Просмотрите результат в документе службы

Если вы не задали свойство IsPrivate для вашего пользовательского API, теперь вы можете получить определение службы из документа CSDL $metadata с помощью GET запроса даже через браузер. Если url-адрес вашей среды указанhttps://yourorg.crm.dynamics.com, этот URL-адрес можно ввести в поле адреса браузера, чтобы получить $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata

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

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>

Протестируйте ваш пользовательский API

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

Обновление типа настраиваемого API-плагина

Сведения о написании подключаемого модуля для пользовательского API, см. в статье "Написание подключаемого модуля для пользовательского API".

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

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

Другие способы создания пользовательских API

Инструмент регистрации плагинов предоставляет индивидуальный редактор API. Дополнительные сведения: создание пользовательского API с помощью средства регистрации подключаемых модулей

Возможно, у вас есть требования к созданию клиентского приложения, позволяющего создавать пользовательские API за пределами конструктора. Так как данные для пользовательских API хранятся в таблицах, их можно создать с помощью кода. Дополнительные сведения: создание пользовательского API с кодом.

Процесс ALM может лучше обслуживаться путем создания пользовательских API путем редактирования файлов решения. Дополнительные сведения: создание пользовательского API с файлами решения.

См. также

Создание и использование пользовательских API
Создание пользовательского API с помощью средства регистрации подключаемых модулей
Создание пользовательского API с кодом
Создание пользовательского API с файлами решения
Создание собственных сообщений