Agilite (предварительная версия)
Agilit-e позволяет централизировать бизнес-логику и процессы и предоставлять их как микрослужбы новым или существующим приложениям. С помощью соединителя Agilit-e вы получаете доступ ко многим службам, включая управление бизнес-процессами (BPM), роли, ключевые слова, шаблоны и многое другое.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Группа поддержки Agilit-e |
| URL | https://agilite.io |
| Адрес электронной почты | support@agilite.io |
| Метаданные соединителя | |
|---|---|
| Publisher | Agilit-e |
| Веб-сайт | https://agilite.io |
| Политика конфиденциальности | https://agilite.io/privacy-policy/ |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Доступный для общего пользования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Укажите URL-адрес сервера API Agilit-e. (Используйте 'https://api.agilite.io' для Agilit-e Cloud) | струна | Укажите URL-адрес сервера API Agilit-e. (Используйте 'https://api.agilite.io' для Agilit-e Cloud) | True |
| Ключ API (созданный в разделе "" вhttps://portal.agilite.io разделе администрирования) | securestring | Ключ API (созданный в разделе "" вhttps://portal.agilite.io разделе администрирования) | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Выполнение (BPM) |
Отправляет параметр в текущем шаге рабочего процесса. В зависимости от бизнес-правил запись будет прогрессирована на следующем шаге процесса и возвращает сведения о следующем шаге в api вызовов. |
| Выполнение (шаблоны) |
Обрабатывает и возвращает шаблон из Agilit-e на основе предоставленного ключа профиля |
| Назначение роли (роли) |
Назначьте указанную пользователем роль, которая применима к определенной записи. Примером этого будет рецензент документа или утверждающий оставьте |
| Получение значения по меткам (ключевым словам) |
Возвращает значение ключевого слова на основе предоставленного "profile-key" и "label-key" |
| Получение ключей профиля по группе (ключевые слова) |
Возвращает все ключи профиля ключевого слова на основе предоставленного имени группы |
| Получение метки по значению (ключевые слова) |
Возвращает метку ключевого слова на основе предоставленного "profile-key" и "value-key" |
| Получение назначенных ролей (ролей) |
Получение ответственных лиц для ранее назначенной роли для определенной записи |
| Получение по ключу профиля (BPM) |
Получите полный профиль BPM с конфигурацией и параметрами процесса. |
| Получение по ключу профиля (ключевые слова) |
Возвращает пары "ключ-значение" определенного профиля ключевых слов на основе предоставленного "profile-key" |
| Получение роли (роли) |
Получение ответственных лиц, назначенных ролям на портале администрирования Agilit-e. Эти роли не только относятся к конкретным записям или бизнес-процессам, и обычно используются для ролей всей компании в организации. |
| Получение состояния записи (BPM) |
Получение состояния записи BPM для одной или нескольких записей, чтобы включить текущее состояние, ответственное за запись, журнал рабочего процесса и другие сведения, чтобы описать текущее состояние и правила записи. |
| Регистрация записи BPM (BPM) |
Зарегистрируйте новую запись BPM. Запись назначается с идентификатором записи, который используется для жизненного цикла записи для идентификации записи, ее ход выполнения, журнала и состояния в любое время |
| Создание числа (нумеровка) |
Создает уникальное число на основе предоставленного ключа профиля |
Выполнение (BPM)
Отправляет параметр в текущем шаге рабочего процесса. В зависимости от бизнес-правил запись будет прогрессирована на следующем шаге процесса и возвращает сведения о следующем шаге в api вызовов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ процесса
|
process-key | True | string |
Уникальный ключ для целевого профиля |
|
Идентификатор записи BPM
|
bpm-record-id | True | string |
Идентифицирует отправляемую запись. Идентификатор регистрируется api registerBPMRecord для новых записей и можно найти в свойстве recordID ответов API BPM. |
|
Выбранный параметр
|
option-selected | True | string |
Определяет параметр, выбранный пользователем в рамках процесса отправки. Это значение должно соответствовать допустимому параметру шага в профиле рабочего процесса. |
|
Текущий пользователь
|
current-user | True | string |
Адрес электронной почты пользователя, отправляющего шаг BPM. Обычно это будет пользователь, вошедший во время вызова API. |
|
Примечания к шагу рабочего процесса
|
comments | string |
Передает комментарии процессу выполнения, который будет отпечатанным в журнал рабочего процесса. Обычно это будет использоваться, если пользователь отклоняет шаг или запрашивает дополнительные сведения |
|
|
|
object |
Возвращаемое значение
- Тело
- ExecuteBPMResult
Выполнение (шаблоны)
Обрабатывает и возвращает шаблон из Agilit-e на основе предоставленного ключа профиля
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ профиля
|
profile-key | True | string |
Уникальный ключ для целевого профиля |
|
|
object |
Возвращаемое значение
- Тело
- StdJSONResponse
Назначение роли (роли)
Назначьте указанную пользователем роль, которая применима к определенной записи. Примером этого будет рецензент документа или утверждающий оставьте
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ процесса
|
process-key | True | string |
Уникальный ключ для целевого профиля |
|
Идентификатор записи BPM
|
bpm-record-id | True | string |
Определяет запись, для которой настроена роль. Идентификатор регистрируется api registerBPMRecord для новых записей и можно найти в свойстве recordID ответов API BPM. |
|
Текущий пользователь
|
current-user | True | string |
Адрес электронной почты пользователя, задающего роль. Обычно это будет пользователь, вошедший во время вызова API. |
|
Имя роли
|
role-name | True | string |
Имя назначенной роли. Например, утверждающий или рецензент |
|
Ответственные пользователи
|
responsible-users | True | string |
Адреса электронной почты пользователей, которым назначена эта роль , (отдельные с запятыми) |
Возвращаемое значение
данные
- данные
- object
Получение значения по меткам (ключевым словам)
Возвращает значение ключевого слова на основе предоставленного "profile-key" и "label-key"
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ профиля
|
profile-key | True | string |
Уникальный ключ для целевого профиля |
|
Ключ метки
|
label-key | True | string |
Ключ метки в списке меток и значений для целевого профиля |
Возвращаемое значение
- Тело
- StdJSONResponse
Получение ключей профиля по группе (ключевые слова)
Возвращает все ключи профиля ключевого слова на основе предоставленного имени группы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя группы
|
group-name | True | string |
Имя группы, используемое для группирования профилей ключевых слов |
|
Сортировать
|
sort | string |
Необязательный параметр для сортировки возвращаемого результата key/Value |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of string |
Получение метки по значению (ключевые слова)
Возвращает метку ключевого слова на основе предоставленного "profile-key" и "value-key"
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ профиля
|
profile-key | True | string |
Уникальный ключ для целевого профиля |
|
Ключ значения
|
value-key | True | string |
Ключ значения в списке меток и значений для целевого профиля |
Возвращаемое значение
- Тело
- StdJSONResponse
Получение назначенных ролей (ролей)
Получение ответственных лиц для ранее назначенной роли для определенной записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ процесса
|
process-key | True | string |
Уникальный ключ для целевого профиля |
|
Идентификатор записи BPM
|
bpm-record-id | True | string |
Определяет запись, для которой настроена роль. Идентификатор регистрируется api registerBPMRecord для новых записей и можно найти в свойстве recordID ответов API BPM. |
|
Имя роли
|
role-names | True | string |
Роли, которые нужно запрашивать (отдельные с помощью запятых) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of object | ||
|
Имя
|
name | string | |
|
Users
|
users | array of object | |
|
Адрес электронной почты
|
users.email | string |
Получение по ключу профиля (BPM)
Получите полный профиль BPM с конфигурацией и параметрами процесса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ профиля
|
profile-key | True | string |
Уникальный ключ для целевого профиля |
Возвращаемое значение
- Тело
- GetBPMProfile
Получение по ключу профиля (ключевые слова)
Возвращает пары "ключ-значение" определенного профиля ключевых слов на основе предоставленного "profile-key"
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ профиля
|
profile-key | True | string |
Уникальный ключ для целевого профиля |
|
Сортировать
|
sort | string |
Необязательный параметр для сортировки возвращаемого результата key/Value |
Возвращаемое значение
- Товары
- KeywordValues
Получение роли (роли)
Получение ответственных лиц, назначенных ролям на портале администрирования Agilit-e. Эти роли не только относятся к конкретным записям или бизнес-процессам, и обычно используются для ролей всей компании в организации.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имена ролей
|
role-names | True | string |
Укажите имена ролей, для которого требуется получить ответственных пользователей (отдельно с запятыми) |
|
Условные уровни
|
conditional-levels | string |
Укажите дополнительные уровни, которые можно использовать для определения правильного человека для роли. Примером уровня может быть имя отдела (если вы хотите получить диспетчер отделов) или название продукта (если вы хотите получить Product Manager) ( отдельно с запятыми) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
responsibleUsers
|
responsibleUsers | array of string |
responsibleUsers |
Получение состояния записи (BPM)
Получение состояния записи BPM для одной или нескольких записей, чтобы включить текущее состояние, ответственное за запись, журнал рабочего процесса и другие сведения, чтобы описать текущее состояние и правила записи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключи процесса
|
process-keys | string |
Отфильтруйте, чтобы определить бизнес-процессы, для которые будут возвращены записи. Этот ключ можно найти на профиле BPM на портале администрирования Agilit-e (отдельно с запятыми) |
|
|
Идентификаторы записей BPM
|
bpm-record-ids | string |
фильтр, чтобы возвращать только записи с определенными идентификаторами записей. RecordId регистрируется api registerBPMRecord для новых записей и может находиться в свойстве recordID ответов API BPM (отдельно с помощью запятых). |
|
|
Имена шагов
|
step-names | string |
Фильтр для возврата только записей, которые в настоящее время относятся к указанным шагам рабочего процесса (отдельно с помощью запятых). |
|
|
Ответственные пользователи
|
responsible-users | string |
Фильтр для возврата только записей, назначенных указанным адресам электронной почты (es) (отдельно с помощью запятых). |
|
|
Соответствующие пользователи
|
relevant-users | string |
Фильтрация, чтобы возвращать только записи, относящиеся к указанным адресам электронной почты(es) — (отдельные с помощью запятых) |
|
|
Журнал включения
|
include-history | boolean |
Укажите, следует ли возвращать объект журнала с сведениями о состоянии записи. |
|
|
Включение параметров шага
|
include-step-options | boolean |
Укажите, следует ли возвращать объект параметров шага с информацией о состоянии записи. |
|
|
Включение видимых объектов
|
include-visible-objects | boolean |
Укажите, следует ли возвращать видимый объект объектов с сведениями о состоянии записи. |
Возвращаемое значение
- Товары
- GetBPMRecordState
Регистрация записи BPM (BPM)
Зарегистрируйте новую запись BPM. Запись назначается с идентификатором записи, который используется для жизненного цикла записи для идентификации записи, ее ход выполнения, журнала и состояния в любое время
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ процесса
|
process-key | True | string |
Уникальный ключ для целевого профиля |
|
Текущий пользователь
|
current-user | True | string |
Адрес электронной почты пользователя, регистрирующего запись. Обычно это будет пользователь, вошедший во время вызова API. |
Возвращаемое значение
- Тело
- RegisterBPMRecord
Создание числа (нумеровка)
Создает уникальное число на основе предоставленного ключа профиля
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Ключ профиля
|
profile-key | True | string |
Уникальный ключ для целевого профиля |
|
|
object |
Возвращаемое значение
- Тело
- StdJSONResponse
Определения
ExecuteBPMResult
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Описание шага процесса
|
description | string |
Краткое описание, объясняющее шаг процесса |
|
Длительность обслуживания (ч)
|
duration | string |
Длительность обслуживания в часах. Укажите значение 0, если применимо |
|
Метка события шага процесса
|
eventStamp | string |
Метка события для текущего шага процесса |
|
Инструкции по шагу
|
instructions | string |
Инструкции ответственному пользователю во время шага |
|
Ключ шага процесса
|
key | string |
Уникальный ключ для идентификации шага процесса |
|
Имя шага процесса
|
name | string |
Короткое имя шага процесса |
|
Ключ профиля BPM
|
processKey | string |
Уникальный ключ для идентификации профиля BPM |
|
Этап процесса
|
processStage | string |
Ключ, определяющий этап процесса текущего шага |
|
Тип ответственности
|
responsibility | string |
Ответственность на основе пользователей и ролей |
|
Роль ответственного этапа процесса
|
responsibleRole | string |
Роль, отвечающая за текущий шаг процесса |
|
Этап обработки ответственных пользователей
|
responsibleUsers | array of string |
Пользователи, ответственные за текущий шаг процесса |
|
stepOptions
|
stepOptions | array of object | |
|
Описание параметра шага
|
stepOptions.description | string |
Краткое описание, объясняющее параметр шага |
|
Метка события параметра шага
|
stepOptions.eventStamp | array of string |
Метка события для текущего параметра шага |
|
Имя параметра шага
|
stepOptions.name | string |
Короткое имя параметра шага |
|
Следующий шаг
|
stepOptions.nextStep | string |
Следующий шаг бизнес-процесса будет перенаправлен в. Оставьте пустым, если дальнейшие действия не будут |
|
Заметки о параметрах шага
|
stepOptions.notes | string |
Необязательные заметки для параметра шага |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Идентификатор объекта step option
|
stepOptions.visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
stepOptions.visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
stepOptions.visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Можно ли изменить объект step option
|
stepOptions.visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект step option
|
stepOptions.visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
|
visibleObjects
|
visibleObjects | array of object | |
|
Идентификатор объекта шага процесса
|
visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Редактируемый объект шага процесса
|
visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект шага процесса
|
visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
GetBPMProfile
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
appAdmin
|
appAdmin | array of object | |
|
Электронная почта администратора приложений
|
appAdmin.email | string |
Адрес электронной почты для администратора текущего профиля BPM |
|
URL-адрес приложения BPM
|
appUrl | string |
Необязательный URL-адрес для приложения, использующее текущий профиль BPM |
|
Описание профиля BPM
|
description | string |
Краткое описание профиля BPM |
|
Имя группы профилей BPM
|
groupName | string |
Необязательное группирование для профиля BPM |
|
Ключ профиля BPM
|
key | string |
Уникальный ключ для идентификации профиля BPM |
|
Имя профиля BPM
|
name | string |
Короткое имя профиля BPM |
|
Заметки профиля BPM
|
notes | string |
Необязательные заметки для профиля BPM |
|
processSteps
|
processSteps | array of object | |
|
Описание шага процесса
|
processSteps.description | string |
Краткое описание, объясняющее шаг процесса |
|
Длительность обслуживания (ч)
|
processSteps.duration | string |
Длительность обслуживания в часах. Укажите значение 0, если применимо |
|
Первый шаг
|
processSteps.firstStep | boolean |
Укажите, является ли запись шага процесса первым шагом в бизнес-процессе |
|
Инструкции по шагу
|
processSteps.instructions | string |
Инструкции ответственному пользователю во время шага |
|
Ключ шага процесса
|
processSteps.key | string |
Уникальный ключ для идентификации шага процесса |
|
Имя шага процесса
|
processSteps.name | string |
Короткое имя шага процесса |
|
Этап процесса
|
processSteps.processStage | string |
Ключ, определяющий этап процесса текущего шага |
|
URL-адрес ссылки на шаг процесса
|
processSteps.referenceUrl | string |
URL-адрес ссылки для шага процесса |
|
Тип ответственности
|
processSteps.responsibility | string |
Ответственность на основе пользователей и ролей |
|
Роль ответственного этапа процесса
|
processSteps.responsibleRole | string |
Роль, отвечающая за текущий шаг |
|
roleLevels
|
processSteps.roleLevels | array of string |
Уровни условной роли |
|
stepOptions
|
processSteps.stepOptions | array of object | |
|
Описание параметра шага
|
processSteps.stepOptions.description | string |
Краткое описание, объясняющее параметр шага |
|
Имя параметра шага
|
processSteps.stepOptions.name | string |
Короткое имя параметра шага |
|
Следующий шаг
|
processSteps.stepOptions.nextStep | string |
Следующий шаг бизнес-процесса будет перенаправлен в. Оставьте пустым, если дальнейшие действия не будут |
|
Заметки о параметрах шага
|
processSteps.stepOptions.notes | string |
Необязательные заметки для параметра шага |
|
visibleObjects
|
processSteps.stepOptions.visibleObjects | array of object | |
|
Идентификатор объекта step option
|
processSteps.stepOptions.visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
processSteps.stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
processSteps.stepOptions.visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
processSteps.stepOptions.visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
processSteps.stepOptions.visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Можно ли изменить объект step option
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект step option
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
|
visibleObjects
|
processSteps.visibleObjects | array of object | |
|
Идентификатор объекта шага процесса
|
processSteps.visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
processSteps.visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
processSteps.visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
processSteps.visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
processSteps.visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
processSteps.visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Редактируемый объект шага процесса
|
processSteps.visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект шага процесса
|
processSteps.visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
|
URL-адрес ссылки на профиль BPM
|
referenceUrl | string |
Необязательный URL-адрес, на который можно ссылаться для текущего профиля BPM |
GetBPMRecordState
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Описание шага процесса
|
description | string |
Краткое описание, объясняющее шаг процесса |
|
Длительность обслуживания (ч)
|
duration | string |
Длительность обслуживания в часах. Укажите значение 0, если применимо |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Имя журнала меток событий
|
eventStampHistory.eventName | string |
Имя метки событий |
|
Метка времени метки меток событий
|
eventStampHistory.timeStamp | date-time |
Метка времени возникновения метки событий |
|
история
|
history | array of object | |
|
Комментарии журнала
|
history.comments | string |
Необязательные примечания, добавленные во время создания записи журнала |
|
Текущая роль журнала
|
history.currentRole | string |
Текущая роль во время записи журнала |
|
Журнал текущего пользователя
|
history.currentUser | string |
Текущий пользователь во время записи журнала |
|
Длительность шага
|
history.duration | string |
Время (в минутах) запись существовала на текущем шаге процесса перед действием |
|
Метка событий журнала
|
history.eventStamp | array of string |
Метки событий, которые произошли во время записи журнала |
|
Шаг
|
history.fromStep | string |
Ключ шага процесса запись BPM была получена во время записи журнала |
|
Имя шага
|
history.fromStepName | string |
Имя шага процесса запись BPM была получена во время записи журнала |
|
Выбранный параметр журнала
|
history.optionSelected | string |
Параметр, выбранный при действии записи BPM |
|
Ключ процесса BPM журнала
|
history.processKey | string |
Уникальный ключ процесса BPM для записи журнала |
|
Этап процесса журнала
|
history.processStage | string |
Этап процесса во время записи журнала |
|
Идентификатор записи BPM журнала
|
history.recordId | string |
Идентификатор записи для связанной записи BPM, созданной во время процесса регистрации записи BPM |
|
Роль ответственной роли журнала
|
history.responsibleRole | string |
Ответственное роль записи BPM во время записи журнала |
|
Журнал ответственных пользователей
|
history.responsibleUsers | array of string |
Ответственные пользователи во время записи журнала |
|
Дата отправки журнала
|
history.submissionDate | date-time |
Дата и время действия записи BPM |
|
Этап обработки
|
history.toProcessStage | string |
Этап процесса записи BPM во время записи журнала |
|
Шаг
|
history.toStep | string |
Ключ шага процесса для записи BPM во время записи журнала |
|
Имя шага
|
history.toStepName | string |
Имя шага процесса для записи BPM во время записи журнала |
|
Инструкции по шагу
|
instructions | string |
Инструкции ответственному пользователю во время шага |
|
Ключ шага процесса
|
key | string |
Уникальный ключ для идентификации шага процесса |
|
Имя шага процесса
|
name | string |
Короткое имя шага процесса |
|
Ключ профиля BPM
|
processKey | string |
Уникальный ключ для идентификации профиля BPM |
|
Этап процесса
|
processStage | string |
Ключ, определяющий этап процесса текущего шага |
|
Идентификатор записи BPM
|
recordId | string |
Идентификатор записи, созданный модулем BPM при регистрации записи BPM |
|
Справочник по записи BPM
|
recordRef | string |
Доступное для чтения число, созданное модулем BPM с помощью модуля нумерирования при регистрации записи BPM |
|
URL-адрес ссылки на шаг процесса
|
referenceUrl | string |
URL-адрес ссылки для шага процесса |
|
Роль ответственного этапа процесса
|
responsibleRole | string |
Роль, отвечающая за текущий шаг |
|
Этап обработки ответственных пользователей
|
responsibleUsers | array of string |
Ответственные пользователи для текущего шага процесса |
|
roles
|
roles | array of object | |
|
Имя роли
|
roles.name | string |
Имя роли |
|
users
|
roles.users | array of object | |
|
Электронная почта роли
|
roles.users.email | string |
Адреса электронной почты, связанные с именем роли |
|
stepOptions
|
stepOptions | array of object | |
|
Описание параметра шага
|
stepOptions.description | string |
Краткое описание, объясняющее параметр шага |
|
Метка события параметра шага
|
stepOptions.eventStamp | array of string |
Метка события для текущего параметра шага |
|
Имя параметра шага
|
stepOptions.name | string |
Короткое имя параметра шага |
|
Следующий шаг
|
stepOptions.nextStep | string |
Следующий шаг бизнес-процесса будет перенаправлен в. Оставьте пустым, если дальнейшие действия не будут |
|
Заметки о параметрах шага
|
stepOptions.notes | string |
Необязательные заметки для параметра шага |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Идентификатор объекта step option
|
stepOptions.visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
stepOptions.visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
stepOptions.visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Можно ли изменить объект step option
|
stepOptions.visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект step option
|
stepOptions.visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
|
Отправлено на шаг
|
submittedIntoStep | date-time |
Дата и время отправки записи BPM в текущий шаг процесса |
|
Длительность целевого времени
|
targetTimeDuration | date-time |
Дата и время записи BPM необходимо выполнить на основе длительности обслуживания. |
|
visibleObjects
|
visibleObjects | array of object | |
|
Идентификатор объекта шага процесса
|
visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Редактируемый объект шага процесса
|
visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект шага процесса
|
visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
KeywordValues
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Этикетка
|
label | string | |
|
Ценность
|
value | string |
RegisterBPMRecord
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Описание шага процесса
|
description | string |
Краткое описание, объясняющее шаг процесса |
|
Длительность обслуживания (ч)
|
duration | string |
Длительность обслуживания в часах. Укажите значение 0, если применимо |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Имя журнала меток событий
|
eventStampHistory.eventName | string |
Имя метки событий |
|
Метка времени метки меток событий
|
eventStampHistory.timeStamp | date-time |
Метка времени возникновения метки событий |
|
история
|
history | array of object | |
|
Комментарии журнала
|
history.comments | string |
Необязательные примечания, добавленные во время создания записи журнала |
|
Текущая роль журнала
|
history.currentRole | string |
Текущая роль во время записи журнала |
|
Журнал текущего пользователя
|
history.currentUser | string |
Текущий пользователь во время записи журнала |
|
Длительность шага
|
history.duration | string |
Время (в минутах) запись существовала на текущем шаге процесса перед действием |
|
Метка событий журнала
|
history.eventStamp | array of string |
Метки событий, которые произошли во время записи журнала |
|
Шаг
|
history.fromStep | string |
Ключ шага процесса запись BPM была получена во время записи журнала |
|
Имя шага
|
history.fromStepName | string |
Имя шага процесса запись BPM была получена во время записи журнала |
|
Выбранный параметр журнала
|
history.optionSelected | string |
Параметр, выбранный при действии записи BPM |
|
Ключ процесса BPM журнала
|
history.processKey | string |
Уникальный ключ процесса BPM для записи журнала |
|
Этап процесса журнала
|
history.processStage | string |
Этап процесса во время записи журнала |
|
Идентификатор записи BPM журнала
|
history.recordId | string |
Идентификатор записи для связанной записи BPM, созданной во время процесса регистрации записи BPM |
|
Роль ответственной роли журнала
|
history.responsibleRole | string |
Ответственное роль записи BPM во время записи журнала |
|
Журнал ответственных пользователей
|
history.responsibleUsers | array of string |
Ответственные пользователи во время записи журнала |
|
Дата отправки журнала
|
history.submissionDate | date-time |
Дата и время действия записи BPM |
|
Этап обработки
|
history.toProcessStage | string |
Этап процесса записи BPM во время записи журнала |
|
Шаг
|
history.toStep | string |
Ключ шага процесса для записи BPM во время записи журнала |
|
Имя шага
|
history.toStepName | string |
Имя шага процесса для записи BPM во время записи журнала |
|
Инструкции по шагу
|
instructions | string |
Инструкции ответственному пользователю во время шага |
|
Ключ шага процесса
|
key | string |
Уникальный ключ для идентификации шага процесса |
|
Имя шага процесса
|
name | string |
Короткое имя шага процесса |
|
Ключ профиля BPM
|
processKey | string |
Уникальный ключ для идентификации профиля BPM |
|
Этап процесса
|
processStage | string |
Ключ, определяющий этап процесса текущего шага |
|
Идентификатор записи BPM
|
recordId | string |
Идентификатор записи, созданный модулем BPM при регистрации записи BPM |
|
Справочник по записи BPM
|
recordRef | string |
Доступное для чтения число, созданное модулем BPM с помощью модуля нумерирования при регистрации записи BPM |
|
URL-адрес ссылки на шаг процесса
|
referenceUrl | string |
URL-адрес ссылки для шага процесса |
|
Роль ответственного этапа процесса
|
responsibleRole | string |
Роль, отвечающая за текущий шаг процесса |
|
Этап обработки ответственных пользователей
|
responsibleUsers | array of string |
Пользователи, ответственные за текущий шаг процесса |
|
roles
|
roles | array of object | |
|
Имя роли
|
roles.name | string |
Имя роли |
|
users
|
roles.users | array of object | |
|
Электронная почта роли
|
roles.users.email | string |
Адреса электронной почты, связанные с именем роли |
|
stepOptions
|
stepOptions | array of object | |
|
Описание параметра шага
|
stepOptions.description | string |
Краткое описание, объясняющее параметр шага |
|
Метка события параметра шага
|
stepOptions.eventStamp | array of string |
Метка события для текущего параметра шага |
|
Имя параметра шага
|
stepOptions.name | string |
Короткое имя параметра шага |
|
Следующий шаг
|
stepOptions.nextStep | string |
Следующий шаг бизнес-процесса будет перенаправлен в. Оставьте пустым, если дальнейшие действия не будут |
|
Заметки о параметрах шага
|
stepOptions.notes | string |
Необязательные заметки для параметра шага |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Идентификатор объекта step option
|
stepOptions.visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
stepOptions.visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
stepOptions.visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Можно ли изменить объект step option
|
stepOptions.visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект step option
|
stepOptions.visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
|
visibleObjects
|
visibleObjects | array of object | |
|
Идентификатор объекта шага процесса
|
visibleObjects.id | string |
Идентификатор компонента, на который ссылается пользовательский интерфейс |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Метка типа "Выбор"
|
visibleObjects.inputOptions.choices.label | string |
Метка для выбранного выбора |
|
Значение типа "Выбор"
|
visibleObjects.inputOptions.choices.value | string |
Значение выбранного выбора |
|
Метка входных параметров
|
visibleObjects.inputOptions.label | string |
Метка, определяющая поле ввода или редактируемый компонент |
|
Сообщения параметров ввода
|
visibleObjects.inputOptions.messages | array of string |
Сообщения, используемые при сбое проверки параметров ввода |
|
Тип входных параметров
|
visibleObjects.inputOptions.type | string |
Определяет тип поля ввода или редактируемый компонент, используемый |
|
Редактируемый объект шага процесса
|
visibleObjects.isEditable | boolean |
Является ли компонент, на который ссылается редактируемый для ввода пользователем данных |
|
Обязательный объект шага процесса
|
visibleObjects.isMandatory | boolean |
Требуется ли у компонента, на который ссылается ссылка, ввод пользователя |
StdJSONResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Result
|
result | string |
Result |
объект
Это тип object.