Платформа A2v10 довідкова система
EN


Команди (commands)

Об'єкт commands описує команди, доступні в поточній кінцевій точці. Імена властивостей об'єкта являють собою імена команд. Кожна властивість являє собою об`єкт наступної структури:


Властивості об'єкта команди

Ім'я Тип Опис
type enum Обов'язково. Тип команди:
sql Виклик збереженої процедури sql. Необхідно вказати властивість procedure.
clr Виклик метода .NET об'єкта. Необхідно вказати властивість clrType. Детальніше....
callApi Виклик зовнішнього http-API. Параметри визначаються властивістю parameters. Детальніше....
javascript Виклик javascript на сервері. Детальніше....
startProcess Запуск бізнес-процесу.
resumeProcess Відновлення бізнес-процесу.
file Отримання файлу.
sendMessage Надсилання повідомлення. Параметри визначаються властивістю parameters. Детальніше....
source string Не обов'язково. Має сенс тільки для типу sql. Джерело даних для збереженої процедури. Якщо не вказано, береться з батьківського елементу.
schema string Не обов'язково. Має сенс тільки для типу sql. Ім'я sql-схеми для збереженої процедури. Якщо не вказано, береться з батьківського елементу.
procedure string Обов'язково для типу sql. Ім'я збереженої процедури.
clrType string Обов'язково для типу clr. Рядок, що описує збірку і .NET тип.
file string Рядок. Ім'я файла для бізнес-процесів або ім'я файлу скрипта для серверних команд.
parameters object Не обов'язково.
Для типу sql являє собою об'єкт, властивості якого передаються в збережену процедуру як статичні параметри. Ім'я властивості є ім'ям параметра, значення - значенням параметра.
Для типу callApi визначають поведінку команди. Детальніше....
debugOnly boolean Команда буде виконуватися тільки в налагоджувальній конфигурації ( ключ configuration розділу appSettings має значення "debug").

Команди типу sql

Команда типу sql виконує збережену процедуру. Ім'я процедури задається властивістю procedure. Sql-cхема задається властивістю schema або береться з батьківського елементу (якщо не вказано). Процедура виконується в джерелі, яке задається властивістю source або береться з батьківського елементу (якщо не вказано).

Процедурі передаються наступні параметри:

  • Стандартні параметри (@TenantId, @UserId).
  • Параметри, передані в url.
  • Параметри з властивості parameters.

Команди типу clr

Команда типу clr викликає метод з типу, заданного властивістю clrType. Тип повинен реалізовувати інтерфейс IInvokeTarget. Детальніше...

Команди типу javascript

Команда типу javascript викликає серверний модуль, заданий властивістю file. Детальніше...

Команди типу callApi

Команда типу callApi викликає зовнішній сервер по протоколу http. Поведінка команди визначається параметрами parameters. Детальніше....

Команди типу sendMessage

Команда типу sendMessage надсилає повідомлення. Поведінка команди визначається параметрами parameters. Детальніше....