操作

Interact Web API 服务中有若干操作，这些操作使用 Blue Prism Object（实用程序—Interact API）进行调用。以下各部分将依次介绍每个操作，并说明如何在自动化流程中运用这些操作。

所有 Web API 服务操作都应通过 Blue Prism 中的“实用程序—Interact API VBO”调用，而非直接通过 Web 服务调用。

获取提交

当从队列中检索信息时，“获取提交”操作与“获取下一项”操作非常相似。

为利用此操作，系统会将一个操作添加到您的流程和选定的“业务对象”中，并将该操作设置为获取提交。如下所示，只有一个输入参数，即“提交 ID”。

输出参数使用提交 ID 检索 Interact 表单内容并放入集合中。

使用此方法检索提交时，与标准的“获取下一项”操作不同的是日期元素的格式。使用“获取下一项”方法时，日期将以文本格式返回，而“获取提交”则以日期时间格式返回日期，如下所示。

有关完整的限制列表，请参阅 Interact Web API 服务对象限制。

除非您知道提交 ID，否则无法使用“获取提交”操作，因为该 ID 对于每个提交都是唯一的，无法将其硬编码到自动化流程中。必须使用“获取下一项”操作来检索该 ID。

获取表单模式

“获取表单模式”操作在集合中获取 Interact 表单结构，可让您处理该结构，然后使用“创建提交”操作来创建 Interact 表单（空白表单或部分创建的表单），供用户填写和提交。

只有一个输入参数，即您要检索结构的 Interact 中的表单名称，如下所示。

输出参数类似于“获取提交”操作，在该操作中，申请状态与包含字段的集合一起返回。

检索到的集合是包含表单结构的空白集合。

所示字段的结构格式与“获取下一项”格式相似，因此，日期元素申请提交文本数据类型。使用文本类型是为了支持 Interact 中的多格式日期元素类型，其中日期可能以英国、美国或国际格式提供。

“获取下一项”和“获取表单模式”格式之间的区别在于“上传元素”字段。“获取下一项”操作会返回文件存储位置的链接，但“获取表单模式”操作会返回一个集合，其包含链接和上传的文件的详细信息。在使用“上传文件”操作时也需要此集合。

如上所示，必须正确设置此集合（包含上传的文件的详细信息）的格式：

• 名称—包含扩展名的文件名称。
• 大小—文件的大小（以字节为单位）。
• 扩展名—文件扩展名（开头无句号或句点）。
• 链接—上传的文件的链接。
• 类型—文件类型，例如“application/pdf”或“image/png”。

创建提交

在“创建提交”操作中需要定义四个参数，

具体如下所示：

• 用户名—这是将为其创建提交的 Interact 用户的用户名。
• 密码—此 Interact 用户的密码。
• 表单名称—将在 Interact 中创建的表单。
• 字段—将在创建的提交中设置的值。

为帮助创建新提交，可以使用获取表单模式检索表单的基本结构。之后，可以用新的数据项填充该结构，然后将其创建为用户的新提交。

要创建提交，字段和表单模式必须与 Interact 中的表单匹配。缺少字段或结构有误最终会导致创建错误的提交。

启动后，所创建的提交将作为已提交的表单出现在指定用户的“提交历史记录”中，并将添加到表单结构中详细说明的特定 Blue Prism 队列中。

若用户的凭据用于创建新的提交，则必须允许该用户访问表单。因此，包含表单的 Interact 角色必须在用户列表中指定该用户。

“创建提交”操作没有输出参数。

编辑提交字段值

与所有其他操作一样，“编辑提交字段值”操作也是从对象调用。对象中有多个操作支持您更新特定字段元素，这些操作直接链接到 Interact 表单中使用的元素类型。

以下部分中的字段名称是在表单设计器中创建的自动化 ID。

以下部分描述了不同元素类型的详细信息。

复选框元素（单个）

“复选框编辑值”是支持使用“单个复选框”和“多个复选框”的两个不同操作。更新“单个复选框”的值时，它是一个已提交的简单文本字符串。

复选框元素（多个）

对于“复选框编辑值”（多个），它也是一个已提交的简单文本字符串，但对不同的值使用逗号分隔的字符串。

日期元素

日期元素使用文本格式来编辑 Interact 表单中的值，可支持 Interact 表单中的三种不同格式。表单将允许您使用以下日期格式：

• DD/MM/YYYY—英国格式；
• MM/DD/YYYY—美国格式；
• YYYY/MM/DD—国际格式。

如果您已将 Interact 表单设置为接受国际格式的日期，并以英国或美国格式发回日期，Interact 表单将显示无效数据消息。

下拉列表元素（单个）

下拉列表元素与复选框元素一样，支持对单个和多个条目执行两种操作。更新“单个下拉列表”的值时，它是一个已提交的简单文本字符串。

下拉列表元素（多个）

对于“下拉列表编辑值（多个）”，它也是一个已提交的简单文本字符串，但对不同的值使用逗号分隔的字符串。

数字元素

数字元素将接受数字或传递给它的文本。虽然字段类型是文本类型，但您必须仅使用逗号和小数点等可接受的分隔符来提供数字。如果发回文本，Interact 表单将显示一条关于无效数据的消息。

单选群组元素

单选群组元素类似于单个复选框或下拉列表元素。编辑的值是包含所需更新值的单一文本字段。

表格元素

表格元素使用集合来支持您更新值。集合必须包含与目标表单中的表单字段相同的列数。必须使用自动化 ID 来提供集合的字段名称。可以增加或减少行数，以适应要更新的数据。

“编辑表格”操作将覆盖整个表格，而不是将各行附加到现有表格。

文本元素

文本元素需要接受传递给它的简单文本字段。

文本区域元素

时间元素

时间元素使用文本格式编辑 Interact 表单中的值。您可以使用以下两种格式之一来提供时间：

• 下午 03:00:00；或
• 15:00:00。

两者在 Interact 中均将返回下午 3 点。

上传