Рабочий процесс K2 (предварительная версия)
Используйте службу API рабочих процессов K2 для удаленной работы с рабочими процессами и задачами.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| URL | https://portal.k2.com/ticket/default |
| Метаданные соединителя | |
|---|---|
| Publisher | K2 |
| Веб-сайт | https://www.k2.com |
| Политика конфиденциальности | https://www.k2.com/legal/privacy-policy |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| URL-адрес K2 | струна | URL-адрес K2 (пример: https://[K2ID].onk2.com). | True |
| Имя пользователя | securestring | Имя пользователя для этого API | True |
| Пароль | securestring | Пароль для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Завершение события сервера |
Отправка ответа на асинхронную задачу сервера, ожидающую ответа |
| Задача выпуска |
Освобождает задачу. |
| Задача действия |
Выполняет действие рабочего процесса. |
| Задача перенаправления |
Отправляет задачу другому пользователю. |
| Задача пробуждения |
Пробуждение спящей задачи. |
| Задача спящего режима |
Спящий режим задачи в течение длительности, количество секунд или до даты. |
| Запуск рабочего процесса |
Создает и запускает новый экземпляр рабочего процесса. |
| Назначение задачи |
Назначает задачу текущему пользователю. |
| Получение действий задачи |
Возвращает список действий для задачи. |
| Получение задач |
Получите список задач, доступных для подключенного пользователя. |
| Получение рабочих процессов |
Получите список доступных рабочих процессов. |
| Получение события сервера |
Возвращает событие сервера по серийному номеру. |
| Получить задачу |
Получает задачу по серийному номеру. |
| Получить рабочий процесс |
Возвращает определение рабочего процесса по идентификатору. |
Завершение события сервера
Отправка ответа на асинхронную задачу сервера, ожидающую ответа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер события сервера
|
serialNumber | True | string |
Серийный номер события сервера. Ex: 1234_5678 |
|
Имя поля XML
|
name | string |
Имя поля XML. |
|
|
Значение поля XML
|
value | string |
Значение xml-поля. |
|
|
Ссылки на элементы
|
ItemReferences | object |
Поля ссылки на элементы экземпляра рабочего процесса. |
|
|
Поля данных
|
DataFields | object |
Поля данных экземпляра рабочего процесса. |
Задача выпуска
Освобождает задачу.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
Задача действия
Выполняет действие рабочего процесса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
|
Настраиваемое действие
|
customAction | True | string |
Действие задачи, определенное рабочим процессом. |
|
Имя поля XML
|
name | string |
Имя поля XML. |
|
|
Значение поля XML
|
value | string |
Значение xml-поля. |
|
|
Ссылки на элементы
|
ItemReferences | object |
Поля ссылки на элементы экземпляра рабочего процесса. |
|
|
Поля данных
|
DataFields | object |
Поля данных экземпляра рабочего процесса. |
Задача перенаправления
Отправляет задачу другому пользователю.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
|
Сведения о перенаправлении
|
RedirectTo | True | string |
Пользователь, которому перенаправляется задача. |
Задача пробуждения
Пробуждение спящей задачи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
Возвращаемое значение
- response
- object
Задача спящего режима
Спящий режим задачи в течение длительности, количество секунд или до даты.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
|
Спящий режим для
|
SleepFor | integer |
Количество секунд для сна задачи. |
|
|
Спящий режим до
|
SleepUntil | date-time |
Дата и время пробуждения задачи. Формат: гггг-ММ-ddTHH:mm:ss:fffZ UTC |
Запуск рабочего процесса
Создает и запускает новый экземпляр рабочего процесса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
id | True | integer |
Укажите идентификатор рабочего процесса для запуска экземпляра. |
|
Сведения об экземпляре рабочего процесса
|
instance | True | dynamic |
Отправка объекта экземпляра рабочего процесса для запуска рабочего процесса. |
Возвращаемое значение
- response
- integer
Назначение задачи
Назначает задачу текущему пользователю.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
Возвращаемое значение
- response
- object
Получение действий задачи
Возвращает список действий для задачи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
Возвращаемое значение
- Тело
- TaskActionsResponse
Получение задач
Получите список задач, доступных для подключенного пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Все, выделенные, спящие, sharedFrom, SharedTo
|
state | string |
Возвращает список задач для подключенного пользователя. |
Возвращаемое значение
- Тело
- TasksResponse
Получение рабочих процессов
Получите список доступных рабочих процессов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип рабочего процесса
|
type | string |
Тип рабочего процесса. Начальный или принадлежащий. |
Возвращаемое значение
Получение события сервера
Возвращает событие сервера по серийному номеру.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер события сервера
|
serialNumber | True | string |
Серийный номер события сервера. Ex: 1234_5678. |
Возвращаемое значение
Получить задачу
Получает задачу по серийному номеру.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Серийный номер
|
serialNumber | True | string |
Серийный номер задачи. Ex: 1234_5678 |
Возвращаемое значение
- Тело
- Task
Получить рабочий процесс
Возвращает определение рабочего процесса по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
id | True | integer |
Идентификатор рабочего процесса. |
Возвращаемое значение
- Тело
- WorkflowDataResponse
Определения
ServerEventDataResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Серийный номер события сервера
|
serialNumber | string |
Серийный номер события сервера. Ex: 1234_5678 |
|
Идентификатор рабочего процесса события сервера
|
workflowID | integer |
Идентификатор рабочего процесса, связанного с событием сервера. |
|
Имя рабочего процесса событий сервера
|
workflowName | string |
Имя рабочего процесса, связанного с событием сервера. |
|
Отображаемое имя рабочего процесса событий сервера
|
workflowDisplayName | string |
Отображаемое имя рабочего процесса, связанного с событием сервера. |
|
Категория рабочего процесса событий сервера
|
workflowCategory | string |
Категория рабочего процесса, связанного с событием сервера. |
|
Идентификатор экземпляра рабочего процесса сервера
|
workflowInstanceID | integer |
Идентификатор экземпляра рабочего процесса, связанного с событием сервера. |
|
Рабочий процесс событий сервера Фолио
|
workflowInstanceFolio | string |
Фолио экземпляра рабочего процесса, связанного с событием сервера. |
|
Идентификатор экземпляра действия сервера
|
activityInstanceID | integer |
Идентификатор экземпляра действия события сервера. |
|
Идентификатор назначения действия события сервера
|
activityInstanceDestinationID | integer |
Идентификатор назначения экземпляра действия события сервера. |
|
Имя действия события сервера
|
activityName | string |
Имя действия события сервера. |
|
Имя события сервера
|
eventName | string |
Имя события сервера. |
|
Описание события сервера
|
eventDescription | string |
Описание события сервера. |
|
создатель
|
originator | User | |
|
eventInstance
|
eventInstance | EventInstanceWrapper | |
|
Поля данных о действиях события сервера
|
dataFields | object |
Поля данных действия. |
|
Поля XML действия события сервера
|
xmlFields | array of UserDefinedXmlField |
XML-поля действия. |
|
Ссылки на элементы событий сервера
|
itemReferences | object |
Ссылки на элемент экземпляра рабочего процесса. |
|
Строка полей данных рабочего процесса событий сервера
|
workflowInstanceDataFieldsString | string |
Строковое представление полей данных экземпляра рабочего процесса. |
|
Строка ссылок на элемент события сервера
|
itemReferencesString | string |
Строка, представляющая ссылки на элементы экземпляра рабочего процесса. |
|
viewFlowURL
|
viewFlowURL | string |
EventInstance
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Дата начала экземпляра события
|
StartDate | date-time |
Дата и время запуска экземпляра события. |
|
Ожидаемая длительность экземпляра события
|
ExpectedDuration | integer |
Ожидаемая длительность экземпляра события. |
|
Приоритет экземпляра событий
|
Priority | integer |
Приоритет экземпляра события. |
|
Метаданные экземпляра событий
|
MetaData | string |
Метаданные для экземпляра события. |
|
Описание экземпляра события
|
Description | string |
Описание экземпляра события. |
|
Имя экземпляра события
|
Name | string |
Имя экземпляра события. |
|
Идентификатор экземпляра события
|
ID | integer |
Идентификатор экземпляра события. |
UserDefinedXmlField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя поля XML
|
name | string |
Имя поля XML. |
|
Значение поля XML
|
value | string |
Значение xml-поля. |
TasksResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Число задач
|
itemCount | integer |
Количество возвращаемых задач. |
|
Tasks
|
tasks | array of TaskLite |
Одна или несколько задач. |
TaskLite
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Серийный номер задачи
|
serialNumber | string |
Серийный номер задачи. Ex: 1234_5678 |
|
Состояние задачи
|
status | string |
Состояние задачи. Ex: Open, Completed, Sleep, Allocated, Available |
|
Дата начала задачи
|
taskStartDate | date-time |
Дата начала задачи. |
|
Длительность спящего режима задачи
|
sleepUntil | date-time |
Дата и время пробуждения задачи. |
|
Приоритет задачи
|
priority | integer |
Приоритет задачи. |
|
URL-адрес формы задачи
|
formURL | string |
URL-адрес формы задачи. |
|
URL-адрес потока представления задач
|
viewFlowURL | string |
URL-адрес потока представления задачи. |
|
Идентификатор рабочего процесса задачи
|
workflowID | integer |
Идентификатор рабочего процесса, связанного с задачей. |
|
Имя рабочего процесса задачи
|
workflowName | string |
Имя рабочего процесса, связанного с задачей. |
|
Отображаемое имя рабочего процесса задачи
|
workflowDisplayName | string |
Отображаемое имя рабочего процесса, связанного с задачей. |
|
Категория рабочего процесса задачи
|
workflowCategory | string |
Категория рабочего процесса, связанного с задачей. |
|
Идентификатор экземпляра рабочего процесса задачи
|
workflowInstanceID | integer |
Идентификатор экземпляра рабочего процесса, связанного с задачей. |
|
Рабочий процесс задачи Folio
|
workflowInstanceFolio | string |
Фолио экземпляра рабочего процесса, связанного с задачей. |
|
Идентификатор экземпляра задачи
|
activityInstanceID | integer |
Идентификатор экземпляра действия задачи. |
|
Идентификатор назначения действия задачи
|
activityInstanceDestinationID | integer |
Идентификатор назначения экземпляра действия задачи. |
|
Имя действия задачи
|
activityName | string |
Имя действия задачи. |
|
Имя события задачи
|
eventName | string |
Имя события задачи. |
|
Описание события задачи
|
eventDescription | string |
Описание события задачи. |
|
создатель
|
originator | User | |
|
Действия
|
actions | TaskActionsResponse | |
|
Инструкции по задачам
|
instruction | string |
Инструкции, связанные с задачей. |
User
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя пользователя
|
username | string |
Имя пользователя. |
|
Полное доменное имя пользователя
|
fqn | string |
Полное имя человека. Ex: bob@denallix.com, K2:Denallix\Bob |
|
Электронная почта пользователя
|
string |
Адрес электронной почты пользователя. |
|
|
Диспетчер пользователей
|
manager | string |
Менеджер человека. |
|
Отображаемое имя пользователя
|
displayName | string |
Отображаемое имя пользователя. |
TaskActionsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Действия, не относящиеся к скачению
|
nonBatchableActions | array of string |
Список действий, которые нельзя предпринять, не назначая задачу. |
|
Пакетные действия
|
batchableActions | array of string |
Список действий, которые можно предпринять без назначения задачи. |
|
Системные действия
|
systemActions | array of string |
Список системных действий. |
Задача
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Серийный номер задачи
|
serialNumber | string |
Серийный номер задачи. Ex: 1234_5678 |
|
Состояние задачи
|
status | string |
Состояние задачи. Ex: Open, Completed, Sleep, Allocated, Available |
|
Дата начала задачи
|
taskStartDate | date-time |
Дата начала задачи. |
|
Длительность спящего режима задачи
|
sleepUntil | date-time |
Дата и время пробуждения задачи. |
|
Приоритет задачи
|
priority | integer |
Приоритет задачи. |
|
URL-адрес формы задачи
|
formURL | string |
URL-адрес формы задачи. |
|
URL-адрес потока представления задач
|
viewFlowURL | string |
URL-адрес потока представления задачи. |
|
Идентификатор рабочего процесса задачи
|
workflowID | integer |
Идентификатор рабочего процесса, связанного с задачей. |
|
Имя рабочего процесса задачи
|
workflowName | string |
Имя рабочего процесса, связанного с задачей. |
|
Отображаемое имя рабочего процесса задачи
|
workflowDisplayName | string |
Отображаемое имя рабочего процесса, связанного с задачей. |
|
Категория рабочего процесса задачи
|
workflowCategory | string |
Категория рабочего процесса, связанного с задачей. |
|
Идентификатор экземпляра рабочего процесса задачи
|
workflowInstanceID | integer |
Идентификатор экземпляра рабочего процесса, связанного с задачей. |
|
Рабочий процесс задачи Folio
|
workflowInstanceFolio | string |
Фолио экземпляра рабочего процесса, связанного с задачей. |
|
Идентификатор экземпляра задачи
|
activityInstanceID | integer |
Идентификатор экземпляра действия задачи. |
|
Идентификатор назначения задачи
|
activityInstanceDestinationID | integer |
Идентификатор назначения экземпляра действия задачи. |
|
Имя действия задачи
|
activityName | string |
Имя действия задачи. |
|
Имя события задачи
|
eventName | string |
Имя события задачи. |
|
Описание события задачи
|
eventDescription | string |
Описание события задачи. |
|
создатель
|
originator | User | |
|
Действия
|
actions | TaskActionsResponse | |
|
Поля данных рабочего процесса задачи
|
workflowInstanceDataFields | object |
Поля данных экземпляра рабочего процесса. |
|
Поля данных действия задачи
|
activityDataFields | object |
Поля данных действия. |
|
Поля XML рабочего процесса задач
|
workflowInstanceXmlFields | array of UserDefinedXmlField |
XML-поля экземпляра рабочего процесса. |
|
Ссылки на элементы задачи
|
itemReferences | object |
Ссылки на элемент экземпляра рабочего процесса. |
|
инструкция
|
instruction | string | |
|
Строка полей данных рабочего процесса задачи
|
workflowInstanceDataFieldsString | string |
Строковое представление полей данных экземпляра рабочего процесса. |
|
Строка ссылок на элемент задачи
|
itemReferencesString | string |
Строка, представляющая ссылки на элементы экземпляра рабочего процесса. |
WorkflowLabelsResponse[WorkflowLabel]
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Количество элементов
|
itemCount | integer |
Количество рабочих процессов. |
|
Workflows
|
workflows | array of WorkflowLabel |
Список рабочих процессов. |
WorkflowLabel
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор рабочего процесса
|
id | integer |
Идентификатор рабочего процесса. |
|
Версия рабочего процесса по умолчанию
|
defaultVersionId | integer |
Версия рабочего процесса по умолчанию. |
|
Имя рабочего процесса
|
name | string |
Имя рабочего процесса. |
|
Папка рабочего процесса
|
folder | string |
Папка рабочего процесса. |
|
Имя системы рабочего процесса
|
systemName | string |
Имя системы рабочего процесса. |
WorkflowDataResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
workflowInfo
|
workflowInfo | WorkflowDefinition | |
|
Схема рабочего процесса
|
workflowSchema | string |
Схема рабочего процесса. |
WorkflowDefinition
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя рабочего процесса
|
name | string |
Имя рабочего процесса. |
|
Описание рабочего процесса
|
description | string |
Описание рабочего процесса. |
|
Папка рабочего процесса
|
folder | string |
Папка (категория) рабочего процесса. |
|
Имя системы рабочего процесса
|
systemName | string |
Имя системы рабочего процесса. |
|
Ожидаемая длительность рабочего процесса
|
expectedDuration | integer |
Ожидаемая длительность рабочего процесса. |
EventInstanceWrapper
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
EventInstance
|
EventInstance | EventInstance | |
|
Описание экземпляра события
|
Description | string |
Описание экземпляра события. |
|
Ожидаемая длительность экземпляра события
|
ExpectedDuration | integer |
Ожидаемая длительность экземпляра события. |
|
Идентификатор экземпляра события
|
ID | integer |
Идентификатор экземпляра события. |
|
Метаданные экземпляра событий
|
MetaData | string |
Метаданные для экземпляра события. |
|
Имя экземпляра события
|
Name | string |
Имя экземпляра события. |
|
Приоритет экземпляра событий
|
Priority | integer |
Приоритет экземпляра события. |
|
Дата начала экземпляра события
|
StartDate | date-time |
Дата и время запуска экземпляра события. |
целое число
Это базовый тип данных "целочисленное".
объект
Это тип object.