C TWO (预览版)
C TWO 是一个代理管理平台,用于协调自动化工作流、管理人机器人交互,并通过通用队列处理工作项。 使用此连接器可以触发来自 C TWO 会话的流、管理会话生命周期、创建和处理队列项,以及启用与数字工作者的人工循环交互。
此连接器在以下产品和区域中可用:
| Service | Class | Regions |
|---|---|---|
| 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) |
| 联系人 | |
|---|---|
| 名称 | C TWO 支持 |
| URL | https://ctwo.com/ |
| customersuccess@ctwo.com |
| 连接器元数据 | |
|---|---|
| Publisher | C TWO |
| 网站 | https://ctwo.com/ |
| 隐私策略 | https://ctwo.com/privacy-policy/ |
| 类别 | 商业智能;人工智能 |
C TWO
C TWO 是一个代理管理平台,用于协调自动化工作流、管理人机器人交互,并通过通用队列处理工作项。 此连接器允许 C TWO 会话Power Automate、Power Apps、Azure 逻辑应用和Copilot Studio触发,管理会话生命周期、创建和处理通用队列项,以及实现与数字工作者的人工循环交互。
C TWO 位于自动化资产之上,充当单个业务流程、治理和监视层:无论创建或执行工作,C TWO 都会添加 SLA 跟踪、重试和自我修复、实时会话遥测和完整审核线索。
Prerequisites
在创建连接之前,需要:
- 活动 C TWO 租户 - C TWO 云(托管)或可通过 HTTPS 访问的本地 C TWO 服务器。
- 由 C TWO 管理员颁发的 服务帐户令牌 或 个人访问令牌 (请参阅 “获取凭据”)。
- 如果 C TWO 托管在本地,则必须通过 HTTPS 从 Power Platform 访问服务器(防火墙允许Microsoft Power Automate出站 IP 范围(Azure服务标记
AzureConnectors.<region>和PowerPlatformPlexPower Platform Geo)。 - 具有自定义连接器权限的 Power Platform 环境以及支持自定义连接器的许可证层(Power Automate高级版或等效连接器)。
正在创建连接
创建连接时,提供三个 值,全部来自自己的 C TWO 环境:
-
C TWO 主机 - 仅限 C TWO 服务器主机名(无方案,无尾部斜杠),例如
connect24.ctwo.cloud,或具有可选端口的本地主机,例如ctwo.contoso.com:8443。 -
C TWO 基 URL - C TWO API 的基本路径,包括除法,从斜杠开始,不带尾部斜杠,例如
/DEFAULT/CTWO.Server/api。 -
API 密钥 - 令牌,输入为
Bearer <your-token>。 建议 使用服务帐户 令牌; 个人访问令牌 也有效。
主机和基 URL 将连接器路由到自己的 C TWO 服务器(https://{Host}{Base URL}/…),因此每个客户都连接到自己的环境(C TWO 云或本地)。
获取凭据
身份验证使用在标头中作为持有者令牌发送的 Authorization API 密钥。
服务帐户令牌(建议用于生产)
- 登录到 C TWO 实例。
- 转到应用和连接→ Microsoft Power Automate →创建服务帐户。
- 立即复制生成的令牌 , 它只显示一次。
个人访问令牌 (开发/测试)
- 在 C TWO 中打开用户配置文件。
- 转到 “API 令牌 ”选项卡并生成新令牌。
- 立即复制它 — 仅显示一次,如果用户帐户被禁用,则会将其失效。
将这两种令牌类型视为机密 — 仅将它们存储在 Power Platform 连接凭据中,从不存储在流变量或客户端代码中。
支持的操作
- 触发器 - 当 C TWO 调度会话时启动流,同时或不执行强制超时。
- 会话管理 — 报告完成/失败、写入类型化的会话日志、调整会话超时以及检查正常停止请求。
- 通用队列 - 创建、列出、锁定、解锁、重试和延迟队列项;更新项数据并添加项级日志;添加/删除标记;检索附件;创建自定义项状态;列出队列。
- 人机循环 - 创建、分配、取消分配和完整的结构化人工协助表单,并检索/查询它们。
内部帮助程序操作填充动态下拉列表(任务和用户选取器),不会直接调用。
已知问题和限制
- 需要正确的主机和基 URL。 两者都在连接时输入,并将连接器路由到 C TWO 服务器。 不正确的或无法访问的值会导致连接或请求失败。
- API 密钥格式。 API 密钥字段需要文本字符串
Bearer <token>, 省略Bearer前缀结果401 Unauthorized。 - 提供 JSON 项数据。 项数据字段 (
Create Queue Item,Set Queue Item Data) 是 JSON 对象。 在流中json('…'),使用表达式提供文本 JSON,以便将其作为对象而不是字符串发送。 - 轮询触发器延迟。 触发器轮询而不是推送,因此在 C TWO 中调度会话与启动流之间存在一个小延迟(受触发器重复周期限制)。
- 窗体字段类型。 窗体操作返回的某些标识符字段可以是整数、字符串或 null,具体取决于窗体的状态。
常见错误和补救措施
| Error | 可能的原因 | 纠正方法 |
|---|---|---|
401 Unauthorized |
API 密钥缺少 Bearer 前缀、过期或已撤销 |
重新输入凭据; Bearer <token>如果吊销,请生成新的服务帐户令牌 |
400 Bad request 在创建队列项上 |
缺少必填字段 (reference, queueItemState, itemKey) |
填充所有三个必填字段 |
| 触发器永远不会触发 | 选择了错误的任务,或者 C TWO 任务未公开给Power Automate | 确认任务显示在“任务 ID”下拉列表中,并在 C TWO 中配置为公开的流 |
| 存储为转义字符串的项数据 | 作为文本而不是对象提供的 JSON |
json('…')使用表达式(流)或原始正文(连接器测试),以便将其作为对象发送 |
FAQ
是否可以从Power Apps、Azure 逻辑应用和Copilot Studio使用此连接器,而不仅仅是Power Automate? Yes. 触发器特定于Power Automate,但创建连接后,可以从其中任何平台调用每个操作。
此连接器是否管理许可? No. C TWO 协调和管理执行;客户负责自己的Microsoft许可。
在哪里可以获得帮助? 联系 C TWO 客户成功。customersuccess@ctwo.com
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| 名称 | 类型 | Description | 必需 |
|---|---|---|---|
| C TWO 主机 | 字符串 | 你的 C TWO 服务器主机名仅 “没有方案, 没有尾部斜杠。 例如,connect24.ctwo.cloud 或具有可选端口的本地主机,例如 ctwo.contoso.com:8443。 | 是 |
| C 两个基 URL | 字符串 | C TWO API 的基本路径,包括你的部门。 从斜杠开始,无尾部斜杠。 例如 /DEFAULT/CTWO。服务器/api。 | 是 |
| API 密钥 | 安全字符串 | C TWO API 令牌,输入为:持有者 <令牌>。 建议使用服务帐户令牌;个人访问令牌也有效。 | 是 |
操作
| 从队列项中删除标记 |
从队列项中删除一个或多个标记。 使用此操作可更新处理期间工作项的分类。 |
| 会话应停止 |
检查 C TWO 是否为给定会话请求了正常(软)停止。 在循环中使用此操作定期检查会话是否应提前终止,从而允许流在停止之前清理资源。 |
| 分配窗体 |
将机器人交互表单分配给特定用户,使他们负责评审和完成人工循环请求。 |
| 创建窗体 |
创建一个新的机器人交互形式,允许数字工作者请求人工协助。 此表单呈现给 C TWO 平台中的已分配用户,使人机在循环方案中能够处理异常或复杂决策所需的人工专业知识。 |
| 创建队列项 |
在指定的通用队列中创建新的工作项。 使用此操作可添加数字工作者进行处理的项目,包括数据有效负载、标记和可选文件附件。 |
| 创建队列项状态 |
在特定队列中创建新的自定义状态。 自定义状态允许定义超出默认状态(挂起、已完成、引用)的工作流阶段,从而根据业务流程定制队列。 |
| 取消分配窗体 |
从机器人交互表单中删除当前用户分配,使其可供其他用户声明。 |
| 完成表单 |
将机器人交互表单标记为已完成,表明人类用户已提供请求的输入,数字工作者可以恢复处理。 |
| 将日志添加到会话 |
将日志条目写入 C TWO 会话。 使用此操作跟踪流执行过程中的进度、记录决策或记录诊断信息。 日志在 C TWO 平台中可见,用于审核和故障排除。 |
| 将日志添加到队列项 |
将日志消息添加到队列项,以便进行审核跟踪和可跟踪。 使用此操作可记录针对特定工作项的处理步骤、警告或错误。 |
| 将标记添加到队列项 |
将一个或多个标记添加到队列项进行分类和筛选。 标记有助于跨队列组织和搜索工作项。 |
| 将流执行状态设置为失败 |
将 C TWO 会话标记为失败,表明流执行期间发生了错误。 在错误处理范围中使用此操作,将故障报告回 C TWO,其中包含有关出错的详细信息。 |
| 将流执行状态设置为已完成 |
将 C TWO 会话标记为已完成,表明流已成功完成其工作。 将此操作置于流末尾,以向 C TWO 报告自动化完成且没有错误。 |
| 延迟队列项 |
延迟队列项,以便在指定的日期/时间之前不会处理它。 当项现在无法处理,但稍后应重试时,请使用此操作。 |
| 按 ID 获取表单 |
按其唯一标识符检索特定机器人交互形式。 使用此操作可以提取数字工作者创建的人工循环表单的详细信息、字段和当前状态。 |
| 获取窗体 |
检索具有可选筛选的机器人交互表单列表。 使用此操作可以查询待处理的用户传入请求、检查其状态或查找分配给特定用户的表单。 |
| 获取队列 |
根据筛选器条件检索通用队列。 使用此操作可列出可用队列、检查其配置或查找队列详细信息。 此操作还支持其他操作中的动态下拉列表。 |
| 获取队列项 |
根据指定的筛选条件(如状态、标记、日期和队列名称)检索队列项。 使用此操作可在通用队列中搜索和监视工作项。 |
| 获取队列项附件 |
从队列项检索特定文件附件作为 base64 编码的数据。 使用此操作可下载在创建或处理过程中附加到工作项的文件。 |
| 解锁队列项 |
解锁以前锁定的队列项,并将其返回到其可用状态。 在处理中断并且应释放其他辅助角色的项目时,请使用此操作。 |
| 设置会话超时 |
更新活动 C2 会话的超时值。 使用此操作可在原始超时需要调整时延长或减少正在运行的会话的允许执行时间。 |
| 设置队列项数据 |
更新队列项的数据内容。 使用此操作可修改处理期间工作项的有效负载,例如存储中间结果。 |
| 设置队列项状态 |
更改队列项的状态(例如,从“挂起”更改为“已完成”或“自定义”状态)。 使用此操作通过工作流管道推进项目。 |
| 重试队列项 |
重试特定的队列项,将其数据设置回其原始值并创建新的尝试。 |
| 锁定队列项 |
锁定队列项以防止其他辅助角色同时处理它。 在处理工作项之前使用此操作,以确保独占访问。 |
从队列项中删除标记
从队列项中删除一个或多个标记。 使用此操作可更新处理期间工作项的分类。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
要从中删除标记的队列项的 ID。 |
|
Tags
|
tags | string |
要删除的标记的逗号分隔列表。 |
会话应停止
检查 C TWO 是否为给定会话请求了正常(软)停止。 在循环中使用此操作定期检查会话是否应提前终止,从而允许流在停止之前清理资源。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
会话 ID
|
sessionId | True | string |
用于检查停止请求的 C2 会话 ID。 默认为触发器输出中的会话 ID。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
isStopRequested
|
isStopRequested | boolean |
isStopRequested |
分配窗体
将机器人交互表单分配给特定用户,使他们负责评审和完成人工循环请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表单 ID
|
formId | True | string |
要分配的循环表单 ID 中的人类。 |
|
userId
|
userId | integer |
要向其分配窗体的用户的 ID。 |
创建窗体
创建一个新的机器人交互形式,允许数字工作者请求人工协助。 此表单呈现给 C TWO 平台中的已分配用户,使人机在循环方案中能够处理异常或复杂决策所需的人工专业知识。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
字段
|
fields | string |
JSON 格式的字符串,用于定义用户需要填写的表单字段。 |
|
|
标题
|
title | string |
打开窗体时,向用户显示标题。 |
|
|
限期
|
deadline | date-time |
人类必须响应形式(ISO 8601 格式)的最后期限。 |
|
|
介绍
|
intro | string |
向用户显示介绍性文本,说明需要执行哪些操作。 |
|
|
项目编号
|
itemId | integer |
与此表单关联的队列项 ID,将人工交互链接到特定工作项。 |
|
|
workflowTaskId
|
workflowTaskId | integer |
创建此窗体的 C TWO 任务。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer |
id |
创建队列项
在指定的通用队列中创建新的工作项。 使用此操作可添加数字工作者进行处理的项目,包括数据有效负载、标记和可选文件附件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
项键
|
itemKey | True | string |
用于标识此队列项的唯一业务密钥(例如发票编号、案例 ID)。 |
|
队列项状态
|
queueItemState | True | string |
队列项的初始状态(例如挂起)。 |
|
队列参考
|
reference | True | string |
将在其中创建项的队列引用。 |
|
推迟到
|
deferredUntil | date-time |
将处理延迟到此日期/时间(ISO 8601 格式)。 |
|
|
项数据
|
itemData | object |
JSON 格式的队列项的数据有效负载。 |
|
|
Tags
|
tags | string |
队列项的标记(逗号分隔)。 |
|
|
fileName
|
fileName | string |
附件文件的名称。 |
|
|
fileData
|
fileData | string |
base64 编码的文件数据。 |
|
|
会话 ID
|
sessionId | string |
与此项关联的会话 ID。 |
|
|
设备
|
device | string |
创建此项的设备。 |
|
|
User
|
user | string |
创建此项的用户。 |
|
|
自动化提供程序
|
automationProvider | string |
此项的自动化提供程序。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer |
id |
|
itemKey
|
itemKey | string |
itemKey |
|
尝试
|
attempts | integer |
尝试 |
|
queueId
|
queueId | integer |
queueId |
|
id
|
state.id | integer |
id |
|
名字
|
state.name | string |
名字 |
|
状态
|
state.state | string |
状态 |
|
tags
|
tags | array of string |
tags |
|
已创建
|
created | string |
已创建 |
|
createdByVendorSessionId
|
createdByVendorSessionId | integer |
createdByVendorSessionId |
|
结束
|
concluded | string |
结束 |
|
递 延
|
deferred | string |
递 延 |
|
测试
|
test | boolean |
测试 |
|
锁定
|
locked | boolean |
锁定 |
创建队列项状态
在特定队列中创建新的自定义状态。 自定义状态允许定义超出默认状态(挂起、已完成、引用)的工作流阶段,从而根据业务流程定制队列。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
名称
|
name | string |
新状态的名称。 |
|
|
响应时间计算
|
responseTimeCalculationBasis | True | string |
确定输入此状态的项的响应时间 SLA 的计算方式。 |
|
状态类型
|
state | True | string |
状态类型(挂起、已完成或引用)。 |
|
队列 ID
|
queueId | True | integer |
要在其中创建此状态的队列的 ID。 |
|
Description
|
description | string |
此状态在工作流中表示的说明。 |
|
|
按项目保存的时间
|
timeSavedPerItem | integer |
此状态(秒)中每个项目保存的时间,用于 ROI 报告。 |
|
|
每个项生成的值
|
valueGeneratedPerItem | integer |
在此状态下为每个项生成的值,用于 ROI 报告。 |
|
|
包括在报表中
|
includeInReports | boolean |
是否在分析和报表中包含此状态。 |
取消分配窗体
从机器人交互表单中删除当前用户分配,使其可供其他用户声明。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表单 ID
|
formId | True | string |
要取消分配的循环表单 ID 中的人类。 |
完成表单
将机器人交互表单标记为已完成,表明人类用户已提供请求的输入,数字工作者可以恢复处理。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表单 ID
|
formId | True | string |
要标记为已完成的循环表单 ID 中的人类。 |
|
completedAt
|
completedAt | date-time |
表单完成时的时间戳(ISO 8601 格式)。 |
将日志添加到会话
将日志条目写入 C TWO 会话。 使用此操作跟踪流执行过程中的进度、记录决策或记录诊断信息。 日志在 C TWO 平台中可见,用于审核和故障排除。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
会话 ID
|
sessionId | True | string |
记录日志条目的 C TWO 会话 ID。 默认为触发器输出中的会话 ID。 |
|
水平仪
|
level | True | string |
日志条目的严重性级别。 |
|
消息
|
message | True | string |
要记录的日志消息内容。 |
将日志添加到队列项
将日志消息添加到队列项,以便进行审核跟踪和可跟踪。 使用此操作可记录针对特定工作项的处理步骤、警告或错误。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
要记录到的队列项的 ID。 |
|
日志级别
|
level | string |
日志条目的严重性级别。 |
|
|
消息
|
message | string |
日志消息内容。 |
将标记添加到队列项
将一个或多个标记添加到队列项进行分类和筛选。 标记有助于跨队列组织和搜索工作项。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
要向其添加标记的队列项的 ID。 |
|
Tags
|
tags | string |
要添加的标记的逗号分隔列表。 |
将流执行状态设置为失败
将 C TWO 会话标记为失败,表明流执行期间发生了错误。 在错误处理范围中使用此操作,将故障报告回 C TWO,其中包含有关出错的详细信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
会话 ID
|
sessionId | True | string |
要标记为失败的 C2 会话 ID。 默认为触发器输出中的会话 ID。 |
|
详细信息
|
details | True | string |
导致会话失败的错误或异常的说明。 |
将流执行状态设置为已完成
将 C TWO 会话标记为已完成,表明流已成功完成其工作。 将此操作置于流末尾,以向 C TWO 报告自动化完成且没有错误。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
会话 ID
|
sessionId | True | string |
要标记为成功完成的 C2 会话 ID。 默认为触发器输出中的会话 ID。 |
返回
- 响应
- object
延迟队列项
延迟队列项,以便在指定的日期/时间之前不会处理它。 当项现在无法处理,但稍后应重试时,请使用此操作。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
要延迟的队列项的 ID。 |
|
推迟到
|
deferredUntil | date-time |
延迟到的日期/时间(ISO 8601 格式)。 |
返回
- 响应
- string
按 ID 获取表单
按其唯一标识符检索特定机器人交互形式。 使用此操作可以提取数字工作者创建的人工循环表单的详细信息、字段和当前状态。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表单 ID
|
formId | True | string |
循环表单 ID 中的人员可获取详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer |
id |
|
divisionId
|
divisionId |
divisionId |
|
|
sessionId
|
sessionId |
sessionId |
|
|
queueItemId
|
queueItemId |
queueItemId |
|
|
claimedByUserId
|
claimedByUserId |
claimedByUserId |
|
|
claimedOn
|
claimedOn | string |
claimedOn |
|
createdByWorkflowTaskId
|
createdByWorkflowTaskId |
createdByWorkflowTaskId |
|
|
createdByUserId
|
createdByUserId |
createdByUserId |
|
|
createdOn
|
createdOn | string |
createdOn |
|
限期
|
deadline | string |
限期 |
|
完成
|
completed | string |
完成 |
|
标题
|
title | string |
标题 |
|
简介
|
intro | string |
介绍 |
|
字段
|
fields | string |
字段 |
获取窗体
检索具有可选筛选的机器人交互表单列表。 使用此操作可以查询待处理的用户传入请求、检查其状态或查找分配给特定用户的表单。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
跳过
|
skip | integer |
要跳过分页的记录数。 |
|
|
Take
|
take | integer |
要返回的记录数。 |
|
|
截止时间
|
deadlineBefore | date-time |
筛选此日期/时间之前的截止时间(ISO 8601)的表单。 |
|
|
截止时间
|
deadlineAfter | date-time |
筛选在此日期/时间之后的最后期限(ISO 8601)的表单。 |
|
|
包括已完成
|
includeCompleted | boolean |
是否在结果中包含已完成的表单。 |
|
|
用户 ID 声明
|
claimedByUserId | integer |
筛选由特定用户 ID 声明的表单。 |
|
|
由工作流任务 ID 创建
|
createdByWorkflowTaskId | integer |
筛选由特定工作流任务 ID 创建的表单。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
id |
|
divisionId
|
divisionId |
divisionId |
|
|
sessionId
|
sessionId |
sessionId |
|
|
queueItemId
|
queueItemId |
queueItemId |
|
|
claimedByUserId
|
claimedByUserId |
claimedByUserId |
|
|
claimedOn
|
claimedOn | string |
claimedOn |
|
createdByWorkflowTaskId
|
createdByWorkflowTaskId |
createdByWorkflowTaskId |
|
|
createdByUserId
|
createdByUserId |
createdByUserId |
|
|
createdOn
|
createdOn | string |
createdOn |
|
限期
|
deadline | string |
限期 |
|
完成
|
completed | string |
完成 |
|
undeferred
|
undeferred | boolean |
undeferred |
获取队列
根据筛选器条件检索通用队列。 使用此操作可列出可用队列、检查其配置或查找队列详细信息。 此操作还支持其他操作中的动态下拉列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列 ID
|
id | string |
按队列 ID 进行筛选。 |
|
|
队列参考
|
reference | string |
按队列引用进行筛选。 |
|
|
队列名称
|
name | string |
按队列名称进行筛选。 |
|
|
状态名称
|
stateName | string |
按状态名称进行筛选。 |
|
|
已删除
|
deleted | boolean |
按已删除状态进行筛选。 |
|
|
跳过
|
skip | integer |
要跳过分页的记录数。 |
|
|
Take
|
take | integer |
要返回的记录数。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
队列的唯一标识符。 |
|
已删除
|
deleted | boolean |
是否删除队列。 |
|
名字
|
name | string |
队列的名称。 |
|
description
|
description | string |
队列的说明。 |
|
visible
|
visible | boolean |
队列是否可见。 |
|
includeInReports
|
includeInReports | boolean |
是否包括在报表中。 |
|
已创建
|
created | string |
创建时间戳。 |
|
更新
|
updated | string |
上次更新时间戳。 |
|
deletedTime
|
deletedTime | string |
删除时间戳。 |
|
divisionId
|
divisionId | integer |
除法标识符。 |
|
类型
|
type | integer |
队列类型。 |
|
引用
|
reference | string |
队列引用。 |
|
国家
|
states | array of object |
此队列中可用的状态。 |
|
id
|
states.id | integer |
状态标识符。 |
|
名字
|
states.name | string |
状态名称。 |
|
description
|
states.description | string |
状态说明。 |
|
tagfilter
|
states.tagfilter | string |
此状态的标记筛选器。 |
|
状态
|
states.state | integer |
状态类型。 |
|
timeSavedPerItem
|
states.timeSavedPerItem | integer |
每个项目保存的时间。 |
|
includeInReports
|
states.includeInReports | boolean |
是否包括在报表中。 |
|
responseTimeCalculationBasis
|
states.responseTimeCalculationBasis | integer |
响应时间计算基础。 |
获取队列项
根据指定的筛选条件(如状态、标记、日期和队列名称)检索队列项。 使用此操作可在通用队列中搜索和监视工作项。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
项键
|
itemKey | string |
按项键进行筛选。 |
|
|
尝试
|
attempts | integer |
按尝试次数进行筛选。 |
|
|
延迟之前
|
deferredBefore | date-time |
筛选在此日期之前延迟的项目。 |
|
|
延迟后
|
deferredAfter | date-time |
筛选在此日期之后延迟的项目。 |
|
|
在之前创建
|
createdBefore | date-time |
筛选在此日期之前创建的项。 |
|
|
创建后
|
createdAfter | date-time |
筛选在此日期之后创建的项。 |
|
|
结束之前
|
concludedBefore | date-time |
筛选在此日期之前结束的项。 |
|
|
结束后
|
concludedAfter | date-time |
筛选在此日期之后结束的项目。 |
|
|
在之前输入的状态
|
stateEnteredTimeBefore | date-time |
筛选在此时间之前输入状态的项目。 |
|
|
在以下之后输入的状态
|
stateEnteredTimeAfter | date-time |
筛选在此时间后进入状态的项目。 |
|
|
States
|
states | string |
按队列项状态进行筛选。 |
|
|
队列项状态 ID
|
queueItemStateIds | integer |
按队列项状态 ID 进行筛选。 |
|
|
队列项状态名称
|
queueItemStateNames | string |
按队列项状态名称进行筛选。 |
|
|
Tags
|
tags | string |
按标记进行筛选(逗号分隔)。 |
|
|
队列 ID
|
queueIds | integer |
按队列 ID 进行筛选。 |
|
|
队列名称
|
queueNames | True | string |
按队列名称(必需)进行筛选。 |
|
References
|
references | string |
按队列引用进行筛选。 |
|
|
包括项数据
|
includeItemData | boolean |
是否在响应中包含项数据。 |
|
|
跳过
|
skip | integer |
要跳过分页的记录数。 |
|
|
Take
|
take | integer |
要返回的记录数。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
队列项的唯一标识符。 |
|
itemKey
|
itemKey | string |
队列项的唯一键。 |
|
尝试
|
attempts | integer |
处理尝试次数。 |
|
queueId
|
queueId | integer |
父队列的标识符。 |
|
id
|
state.id | integer |
状态标识符。 |
|
名字
|
state.name | string |
状态的名称。 |
|
状态
|
state.state | string |
状态值。 |
|
tags
|
tags | array of string |
与队列项关联的标记。 |
|
已创建
|
created | string |
创建时间戳。 |
|
createdByVendorSessionId
|
createdByVendorSessionId | integer |
创建此项的会话 ID。 |
|
结束
|
concluded | string |
结束时间戳。 |
|
递 延
|
deferred | string |
延迟时间戳。 |
|
测试
|
test | boolean |
这是否为测试项。 |
|
锁定
|
locked | boolean |
该项是否已锁定。 |
获取队列项附件
从队列项检索特定文件附件作为 base64 编码的数据。 使用此操作可下载在创建或处理过程中附加到工作项的文件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
包含附件的队列项的 ID。 |
|
附件 ID
|
attachmentId | True | string |
要检索的附件的 ID。 |
|
Filename
|
filename | string |
附件的文件名。 |
返回
- 响应
- string
解锁队列项
解锁以前锁定的队列项,并将其返回到其可用状态。 在处理中断并且应释放其他辅助角色的项目时,请使用此操作。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
要解锁的队列项的 ID。 |
设置会话超时
更新活动 C2 会话的超时值。 使用此操作可在原始超时需要调整时延长或减少正在运行的会话的允许执行时间。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
会话 ID
|
sessionId | True | string |
要更新其超时的 C2 会话 ID。 默认为触发器输出中的会话 ID。 |
|
超时
|
timeout | True | integer |
要应用于会话的新超时值(以秒为单位)。 |
返回
- 响应
- string
设置队列项数据
更新队列项的数据内容。 使用此操作可修改处理期间工作项的有效负载,例如存储中间结果。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
要更新的队列项的 ID。 |
|
Data
|
data | object |
队列项的新数据有效负载作为 JSON 对象。 |
|
|
已创建
|
created | date-time |
此数据的创建时间戳。 |
设置队列项状态
更改队列项的状态(例如,从“挂起”更改为“已完成”或“自定义”状态)。 使用此操作通过工作流管道推进项目。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | string |
要更新的队列项的 ID。 |
|
州
|
state | string |
队列项的新状态。 |
重试队列项
重试特定的队列项,将其数据设置回其原始值并创建新的尝试。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | True | integer |
要重试的特定队列项 ID。 |
|
状态 ID
|
stateId | integer |
要设置的特定挂起队列项状态 ID;优先于状态参数。 |
|
|
州
|
state | string |
要设置的特定挂起队列项状态名称。 |
|
|
工作流任务 ID
|
workflowTaskId | integer |
WorkflowTask 标识符。 |
|
|
应用 ID
|
appId | integer |
应用标识符。 |
锁定队列项
锁定队列项以防止其他辅助角色同时处理它。 在处理工作项之前使用此操作,以确保独占访问。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
队列项 ID
|
queueItemId | string |
要锁定的队列项的 ID。 如果省略,将锁定与筛选器匹配的下一个可用项。 |
|
|
队列名称
|
reference | string |
用于锁定项的队列引用。 |
|
|
状态 ID
|
stateId | string |
用于筛选项的状态 ID。 |
|
|
状态名称
|
stateName | string |
要按其筛选项的状态名称。 |
|
|
会话 ID
|
sessionId | string |
此锁的会话 ID。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer |
锁定项的唯一标识符。 |
|
itemKey
|
itemKey | string |
锁定项的唯一键。 |
|
尝试
|
attempts | integer |
处理尝试次数。 |
|
queueId
|
queueId | integer |
父队列的标识符。 |
|
id
|
state.id | integer |
状态标识符。 |
|
名字
|
state.name | string |
状态的名称。 |
|
状态
|
state.state | string |
状态值。 |
|
tags
|
tags | array of string |
与队列项关联的标记。 |
|
已创建
|
created | string |
创建时间戳。 |
|
createdByVendorSessionId
|
createdByVendorSessionId | integer |
创建此项的会话 ID。 |
|
结束
|
concluded | string |
结束时间戳。 |
|
递 延
|
deferred | string |
延迟时间戳。 |
|
测试
|
test | boolean |
这是否为测试项。 |
|
锁定
|
locked | boolean |
该项是否已锁定。 |
触发器
| 从会话请求启动流而不超时 |
轮询新的 C TWO 会话,并在为所选任务创建会话时触发流。 当自动化不需要超时约束时,请使用此触发器。 流接收会话详细信息,包括从 C TWO 传递的输入值。 |
| 通过超时从会话请求启动流 |
轮询新的 C TWO 会话并触发具有超时约束的流。 当自动化必须在特定时间范围内完成时使用此触发器。 如果会话超过超时,C TWO 将根据其超时策略来处理它。 |
从会话请求启动流而不超时
轮询新的 C TWO 会话,并在为所选任务创建会话时触发流。 当自动化不需要超时约束时,请使用此触发器。 流接收会话详细信息,包括从 C TWO 传递的输入值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务标识
|
taskId | True | integer |
选择将触发此流的 C TWO 任务。 在 C TWO 中为此任务创建新会话时,流将自动启动,而无需强制超时。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
sessions
|
sessions | array of object |
由 C TWO 触发的会话集(无超时) |
|
sessionId
|
sessions.sessionId | integer |
sessionId |
|
workflowTaskId
|
sessions.workflowTaskId | integer |
workflowTaskId |
|
工作流名称
|
sessions.workflowName | string |
工作流名称 |
|
任务名称
|
sessions.taskName | string |
任务名称 |
|
已创建
|
sessions.created | string |
已创建 |
|
processInputValues
|
sessions.processInputValues | object |
processInputValues |
通过超时从会话请求启动流
轮询新的 C TWO 会话并触发具有超时约束的流。 当自动化必须在特定时间范围内完成时使用此触发器。 如果会话超过超时,C TWO 将根据其超时策略来处理它。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务标识
|
taskId | True | integer |
选择将触发此流的 C TWO 任务。 为此任务创建会话时,流从强制实施的指定超时开始。 |
|
秒超时
|
timeout | True | integer |
允许会话在 C TWO 之前运行的最大时间(以秒为单位),将其标记为超时。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
sessions
|
sessions | array of object |
由 C TWO 触发且超时的会话集 |
|
sessionId
|
sessions.sessionId | integer |
sessionId |
|
workflowTaskId
|
sessions.workflowTaskId | integer |
workflowTaskId |
|
工作流名称
|
sessions.workflowName | string |
工作流名称 |
|
任务名称
|
sessions.taskName | string |
任务名称 |
|
已创建
|
sessions.created | string |
已创建 |
|
processInputValues
|
sessions.processInputValues | object |
processInputValues |
定义
字符串
这是基本数据类型“string”。
对象
这是类型“object”。