K2 工作流(预览版)
使用 K2 工作流 API 服务远程处理工作流和任务。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 标准 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 标准 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 标准 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| URL | https://portal.k2.com/ticket/default |
| 连接器元数据 | |
|---|---|
| 发布者 | K2 |
| 网站 | https://www.k2.com |
| 隐私策略 | https://www.k2.com/legal/privacy-policy |
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| K2 URL | 字符串 | K2 URL(示例:https://[K2ID].onk2.com)。 | True |
| 用户名 | securestring | 此 API 的用户名 | True |
| 密码 | securestring | 此 API 的密码 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 作任务 |
执行工作流作。 |
| 分配任务 |
将任务分配给当前用户。 |
| 发布任务 |
释放任务。 |
| 启动工作流 |
创建并启动新的工作流实例。 |
| 唤醒任务 |
唤醒睡眠任务。 |
| 完成服务器事件 |
将完成响应发送到等待响应的异步服务器任务 |
| 睡眠任务 |
在某一持续时间内(秒数或直到日期)将任务睡眠。 |
| 获取任务 |
按序列号获取任务。 |
| 获取任务 |
获取可供已连接用户使用的任务列表。 |
| 获取任务作 |
获取任务的作列表。 |
| 获取工作流 |
获取可用工作流的列表。 |
| 获取工作流程 |
按 ID 获取工作流定义。 |
| 获取服务器事件 |
按序列号获取服务器事件。 |
| 重定向任务 |
向另一个人发送任务。 |
作任务
执行工作流作。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
序列号
|
serialNumber | True | string |
任务的序列号。 例如:1234_5678 |
|
自定义作
|
customAction | True | string |
任务作,由工作流定义。 |
|
XML 字段名称
|
name | string |
XML 字段的名称。 |
|
|
XML 字段值
|
value | string |
XML 字段的值。 |
|
|
项引用
|
ItemReferences | object |
工作流实例的项引用字段。 |
|
|
数据字段
|
DataFields | object |
工作流实例的数据字段。 |
分配任务
发布任务
释放任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
序列号
|
serialNumber | True | string |
任务的序列号。 例如:1234_5678 |
启动工作流
创建并启动新的工作流实例。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
工作流 ID
|
id | True | integer |
指定要启动实例的工作流 ID。 |
|
工作流实例详细信息
|
instance | True | dynamic |
发送工作流实例对象以启动工作流。 |
返回
- response
- integer
唤醒任务
完成服务器事件
将完成响应发送到等待响应的异步服务器任务
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
服务器事件序列号
|
serialNumber | True | string |
服务器事件的序列号。 例如:1234_5678 |
|
XML 字段名称
|
name | string |
XML 字段的名称。 |
|
|
XML 字段值
|
value | string |
XML 字段的值。 |
|
|
项引用
|
ItemReferences | object |
工作流实例的项引用字段。 |
|
|
数据字段
|
DataFields | object |
工作流实例的数据字段。 |
睡眠任务
在某一持续时间内(秒数或直到日期)将任务睡眠。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
序列号
|
serialNumber | True | string |
任务的序列号。 例如:1234_5678 |
|
睡眠状态
|
SleepFor | integer |
任务睡眠的秒数。 |
|
|
睡眠到
|
SleepUntil | date-time |
唤醒任务的日期和时间。 格式:yyyy-MM-ddTHH:mm:ss:fffZ UTC |
获取任务
获取任务
获取可供已连接用户使用的任务列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
All、Allocated、Sleeping、SharedFrom、SharedTo
|
state | string |
返回已连接用户的任务列表。 |
返回
- Body
- TasksResponse
获取任务作
获取任务的作列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
序列号
|
serialNumber | True | string |
任务的序列号。 例如:1234_5678 |
返回
- Body
- TaskActionsResponse
获取工作流
获取可用工作流的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
工作流类型
|
type | string |
工作流的类型。 可启动或拥有。 |
返回
获取工作流程
获取服务器事件
按序列号获取服务器事件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
服务器事件序列号
|
serialNumber | True | string |
服务器事件的序列号。 例如:1234_5678。 |
返回
重定向任务
向另一个人发送任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
序列号
|
serialNumber | True | string |
任务的序列号。 例如:1234_5678 |
|
重定向信息
|
RedirectTo | True | string |
任务重定向到的人员。 |
定义
ServerEventDataResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
服务器事件序列号
|
serialNumber | string |
服务器事件的序列号。 例如:1234_5678 |
|
服务器事件工作流 ID
|
workflowID | integer |
与服务器事件关联的工作流的 ID。 |
|
服务器事件工作流名称
|
workflowName | string |
与服务器事件关联的工作流的名称。 |
|
服务器事件工作流显示名称
|
workflowDisplayName | string |
与服务器事件关联的工作流的显示名称。 |
|
服务器事件工作流类别
|
workflowCategory | string |
与服务器事件关联的工作流的类别。 |
|
服务器事件工作流实例 ID
|
workflowInstanceID | integer |
与服务器事件关联的工作流的实例 ID。 |
|
服务器事件工作流 Folio
|
workflowInstanceFolio | string |
与服务器事件关联的工作流实例的 folio。 |
|
服务器事件活动实例 ID
|
activityInstanceID | integer |
服务器事件的活动实例 ID。 |
|
服务器事件活动目标 ID
|
activityInstanceDestinationID | integer |
服务器事件的活动实例目标 ID。 |
|
服务器事件活动名称
|
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
|
ID | integer |
事件实例的 ID。 |
UserDefinedXmlField
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
XML 字段名称
|
name | string |
XML 字段的名称。 |
|
XML 字段值
|
value | string |
XML 字段的值。 |
TasksResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务计数
|
itemCount | integer |
返回的任务计数。 |
|
Tasks
|
tasks | array of TaskLite |
一个或多个任务。 |
TaskLite
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务序列号
|
serialNumber | string |
任务的序列号。 例如:1234_5678 |
|
任务状态
|
status | string |
任务的状态。 例如:打开、已完成、睡眠、已分配、可用 |
|
任务开始日期
|
taskStartDate | date-time |
任务的开始日期。 |
|
任务睡眠持续时间
|
sleepUntil | date-time |
任务将唤醒的日期和时间。 |
|
任务优先级
|
priority | integer |
任务的优先级。 |
|
任务表单 URL
|
formURL | string |
任务的表单 URL。 |
|
任务视图流 URL
|
viewFlowURL | string |
任务的视图流 URL。 |
|
任务工作流 ID
|
workflowID | integer |
与任务关联的工作流的 ID。 |
|
任务工作流名称
|
workflowName | string |
与任务关联的工作流的名称。 |
|
任务工作流显示名称
|
workflowDisplayName | string |
与任务关联的工作流的显示名称。 |
|
任务工作流类别
|
workflowCategory | string |
与任务关联的工作流的类别。 |
|
任务工作流实例 ID
|
workflowInstanceID | integer |
与任务关联的工作流的实例 ID。 |
|
任务工作流 Folio
|
workflowInstanceFolio | string |
与任务关联的工作流实例的 folio。 |
|
任务实例 ID
|
activityInstanceID | integer |
任务的活动实例 ID。 |
|
任务活动目标 ID
|
activityInstanceDestinationID | integer |
任务的活动实例目标 ID。 |
|
任务活动名称
|
activityName | string |
任务的活动名称。 |
|
任务事件名称
|
eventName | string |
任务的事件名称。 |
|
任务事件说明
|
eventDescription | string |
任务的事件说明。 |
|
鼻祖
|
originator | User | |
|
行动
|
actions | TaskActionsResponse | |
|
任务说明
|
instruction | string |
与任务关联的说明。 |
用户
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
用户名
|
username | string |
人员的用户名。 |
|
用户 FQN
|
fqn | string |
人员的完全限定名称。 例如: bob@denallix.comK2:Denallix\Bob |
|
用户电子邮件
|
string |
此人的电子邮件地址。 |
|
|
用户管理器
|
manager | string |
人员的经理。 |
|
用户显示名称
|
displayName | string |
人员的显示名称。 |
TaskActionsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
不可批处理的作
|
nonBatchableActions | array of string |
如果不分配任务,则无法执行的作列表。 |
|
可批处理作
|
batchableActions | array of string |
无需分配任务即可执行的作列表。 |
|
系统作
|
systemActions | array of string |
系统作列表。 |
任务
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务序列号
|
serialNumber | string |
任务的序列号。 例如:1234_5678 |
|
任务状态
|
status | string |
任务的状态。 例如:打开、已完成、睡眠、已分配、可用 |
|
任务开始日期
|
taskStartDate | date-time |
任务的开始日期。 |
|
任务睡眠持续时间
|
sleepUntil | date-time |
任务将唤醒的日期和时间。 |
|
任务优先级
|
priority | integer |
任务的优先级。 |
|
任务表单 URL
|
formURL | string |
任务的表单 URL。 |
|
任务视图流 URL
|
viewFlowURL | string |
任务的视图流 URL。 |
|
任务工作流 ID
|
workflowID | integer |
与任务关联的工作流的 ID。 |
|
任务工作流名称
|
workflowName | string |
与任务关联的工作流的名称。 |
|
任务工作流显示名称
|
workflowDisplayName | string |
与任务关联的工作流的显示名称。 |
|
任务工作流类别
|
workflowCategory | string |
与任务关联的工作流的类别。 |
|
任务工作流实例 ID
|
workflowInstanceID | integer |
与任务关联的工作流的实例 ID。 |
|
任务工作流 Folio
|
workflowInstanceFolio | string |
与任务关联的工作流实例的 folio。 |
|
任务实例 ID
|
activityInstanceID | integer |
任务的活动实例 ID。 |
|
任务目标 ID
|
activityInstanceDestinationID | integer |
任务的活动实例目标 ID。 |
|
任务活动名称
|
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
|
id | integer |
工作流的 ID。 |
|
工作流默认版本
|
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
|
ID | integer |
事件实例的 ID。 |
|
事件实例元数据
|
MetaData | string |
事件实例的元数据。 |
|
事件实例名称
|
Name | string |
事件实例的名称。 |
|
事件实例优先级
|
Priority | integer |
事件实例的优先级。 |
|
事件实例开始日期
|
StartDate | date-time |
事件实例启动的日期和时间。 |
整数
这是基本数据类型“integer”。
对象
这是类型“object”。