UIP 任务

用于使用“uip Tasks”工具管理 Action Center 任务、目录、注释、标签、元数据和任务数据的命令。

uip tasks管理Action Center任务，即 RPA 流程和智能体创建的供人员完成的人机回圈工作项目（表单填写、审批、文档验证/分类、数据标记）。该工具可用于列出和检查任务，分配或重新分配任务，使用操作和数据有效负载来完成任务，以及管理附加到任务的辅助资源：目录（分组/保留配置）、注释、标签、元数据 (标题/优先级/目录链接），以及任务自己的表单/业务数据。tasks 是命令前缀；相关基础包为 @uipath/tasks-tool。

概念

• 文件夹作用域——作用于特定任务或目录的每个动词都接受--folder-id <id> 、 --folder-path <path>或--folder-key <key> （互斥；在解析时通过 Commander 冲突强制执行）。当未在交互式终端上传递任何内容时，CLI 将显示一个文件夹选取器；在非交互式运行（CI、编码智能体）中，无法快速请求更新。uip tasks list 和 uip tasks get 是两个例外 — 其中的文件夹是可选的，并且只是在给定时缩小结果/查找的范围。
• 任务类型— 多个动词（ get --task-type 、 complete --type ）接受FormTask 、 ExternalTask 、 AppTask 、 DocumentValidationTask 、 DocumentClassificationTask 、 DataLabelingTask 、 QuickFormTask之一。无法识别的值客户端出现故障，并在错误中指明了完整列表。
• 分页— 列表样式动词（ list 、 catalogs list 、 comments list 、 users ）具有包含 100 个项目的页面大小，并按照nextCursor进行操作，直到用尽或达到--limit ，返回一个平面数组无论哪种方式，都没有需要您自己管理的光标标志。
• 目录是任务的可选分组/保留配置— metadata --catalog-id将任务链接到一个任务； catalogs create / update的保留字段（ --retention-action 、 --retention-period和--retention-bucket-id ）控制目录数据随着时间推移会发生的变化。--encrypted 上的 catalogs create 不可变，无法通过 catalogs update 进行更改。

大纲

uip tasks list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [--as-admin] [-l, --limit <n>]
uip tasks get <id> [--task-type <type>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks assign <task-id> (--user-id <id> | --user <email>)
uip tasks reassign <task-id> (--user-id <id> | --user <email>)
uip tasks unassign <task-id>
uip tasks complete <task-id> --type <type> [--data <json>] [--action <action>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks users [folder-id] [--folder-path <path> | --folder-key <key>] [-l, --limit <n>]

uip tasks catalogs list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [-l, --limit <n>]
uip tasks catalogs get <id> [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs create --name <name> [--description <text>] [--encrypted] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs update <id> [--name <name>] [--description <text>] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]

uip tasks comments list <task-id> [-l, --limit <n>] [folder options]
uip tasks comments add <task-id> --text <text> [folder options]

uip tasks labels <task-id> --labels <json> [folder options]
uip tasks metadata <task-id> [--title <text>] [--priority <level>] [--catalog-id <id> | --unset-catalog] [--note <text>] [folder options]

uip tasks data get <task-id> [folder options]
uip tasks data save <task-id> --data <json> [folder options]

UIP 任务列表

列出跨文件夹（或一个文件夹，当限定了作用域时）的任务。

选项

长	值	描述
--folder-id <id>	整数	按文件夹 ID 筛选。
--folder-path <path>	字符串	按文件夹路径筛选（替代 --folder-id）。
--folder-key <key>	GUID	按文件夹密钥筛选（替代 --folder-id）。
--as-admin	标记	以管理员身份列出任务（比您自己的已分配/可用任务更广泛的可见性）。
-l, --limit <number>	整数	要返回的最大项目数。如果省略，则获取所有内容（内部分页）。

示例

uip tasks list --folder-path "Shared/Finance" --limit 20

数据形状（--输出 json）

{ "Code": "TaskList", "Data": [ { "id": 1, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } ] }

uip 任务获取

按 ID 获取任务的详细信息。

参数

名称	必填	用途
<id>	是	任务 ID。使用 tasks list 进行查找。

选项

长	值	描述
--task-type <type>	7 种任务类型之一	任务类型。通过时需要文件夹选项— 否则快速失败。
--folder-id <id> / --folder-path <path> / --folder-key <key>		文件夹作用域。仅在设置了 --task-type 时才需要。

示例

uip tasks get 123 --task-type FormTask --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskDetails", "Data": { "id": 123, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } }

UIP 任务分配/重新分配

将任务分配给用户，或将其重新分配给其他用户 — 相同的选项形状，不同的 Code 成功。

参数

名称	必填	用途
<task-id>	是	任务 ID。

选项

长	值	必填	描述
--user-id <id>	整数	此两者之一	受分配人的用户数字 ID。
--user <email>	字符串	此两者之一	受分配人的用户名或电子邮件地址（替代 --user-id）。

两者均不通过将失败，因为明确显示“缺少受分配人”其返回类型。

示例

uip tasks assign 123 --user [e-mail]
uip tasks reassign 123 --user-id 7

数据形状（--输出 json）

{ "Code": "TaskAssigned", "Data": { "id": 123, "assignedTo": "[e-mail]" } }

Code 的 TaskReassigned 为 reassign。

UIP 任务取消分配

从任务中删除受分配人。除任务 ID 外无其他选项。

参数

名称	必填	用途
<task-id>	是	任务 ID。

示例

uip tasks unassign 123

数据形状（--输出 json）

{ "Code": "TaskUnassigned", "Data": { "id": 123 } }

UIP 任务完成

使用操作和可选的数据有效负载完成任务。

参数

名称	必填	用途
<task-id>	是	任务 ID。

选项

长	值	必填	描述
--type <type>	7 种任务类型之一	是	任务类型 — 根据枚举在客户端进行验证。
--data <json>	JSON	否	JSON 字符串形式的任务数据有效负载。
--action <action>	字符串	有条件地	操作名称。在实践中，对于 FormTask 和 AppTask 为必需（并非客户端强制 — 对于这些类型，平台会拒绝缺少的操作）。
文件夹选项		否	在完成之前对文件夹进行解析（如果省略，则通过 TTY 以交互方式解析）。

示例

uip tasks complete 123 --type FormTask --action Approve --data '{"comment":"Looks good"}'

数据形状（--输出 json）

{ "Code": "TaskCompleted", "Data": { "id": 123, "status": "Completed" } }

UIP 任务用户

列出在文件夹中具有任务权限的用户 — --user-id/--user 的 assign/reassign 值的来源。

参数

名称	必填	用途
[folder-id]	否	作为位置参数的文件夹 ID。与 --folder-path/--folder-key 互斥 — 两者的传递明确失败。

选项

长	值	描述
--folder-path <path>	字符串	文件夹路径（替代位置参数）。
--folder-key <key>	GUID	文件夹键（替代位置参数）。
-l, --limit <number>	整数	要返回的最大项目数。

示例

uip tasks users 42
uip tasks users --folder-path "Shared/Finance" --limit 10

数据形状（--输出 json）

{
  "Code": "TaskUserList",
  "Data": [
    { "id": 1, "name": "Alice", "surname": "Smith", "userName": "alice", "emailAddress": "[e-mail]", "displayName": "Alice Smith" }
  ]
}

UIP 任务目录

管理任务目录 — 命名任务分组，具有可选的加密和保留策略。

UIP 任务目录列表

选项

长	值	描述
文件夹选项		在其中列出目录的文件夹（如果省略，则系统会解析根据“概念”的文件夹）。
-l, --limit <number>	整数	要返回的最大项目数。

示例

uip tasks catalogs list --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskCatalogList", "Data": [ { "id": 5, "name": "Invoices", "encrypted": false } ] }

uip 任务目录获取

参数

名称	必填	用途
<id>	是	任务目录 ID。

示例

uip tasks catalogs get 5 --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskCatalogDetails", "Data": { "id": 5, "name": "Invoices", "encrypted": false } }

uip 任务目录创建

选项

长	值	必填	描述
--name <name>	字符串	是	目录名称。
--description <text>	字符串	否	目录说明。
--encrypted	标记	否	加密此目录中的任务数据。不可变— 以后无法由catalogs update更改。
--retention-action <action>	Delete | Archive	否	达到保留上限会发生什么情况任何其他值都将在客户端失败。
--retention-period <days>	整数	否	保留期（以天为单位）。
--retention-bucket-id <id>	整数	否	存储桶 ID，在 --retention-action Archive 时使用。

示例

uip tasks catalogs create --name Invoices --retention-action Archive --retention-period 90 --retention-bucket-id 3 --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskCatalogCreated", "Data": { "id": 5, "name": "Invoices" } }

更新 uip 任务目录

合并 — 只有您传递的标志才会更改。至少需要“--name/--description/--retention-action/--retention-period/--retention-bucket-id”中的一个；如果不访问任何文件/网络，则在不访问任何文件/网络之前调用会失败。无法在此处更改 --encrypted。

参数

名称	必填	用途
<id>	是	任务目录 ID。

选项

与 create 减去 --encrypted 相同的设置。

示例

uip tasks catalogs update 5 --name "Invoices v2" --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskCatalogUpdated", "Data": { "id": 5, "name": "Invoices v2" } }

uip 任务注释

UIP 任务注释列表

参数

名称	必填	用途
<task-id>	是	任务 ID。

选项

长	值	描述
-l, --limit <number>	整数	要返回的最大项目数。
文件夹选项		任务所在的文件夹。

示例

uip tasks comments list 123 --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskCommentList", "Data": [ { "id": 1, "text": "Looks good", "createdBy": "alice" } ] }

添加 UIP 任务注释

参数

名称	必填	用途
<task-id>	是	任务 ID。

选项

长	值	必填	描述
--text <text>	字符串	是	注释文本。会拒绝空字符串。
文件夹选项		否	任务所在的文件夹。

示例

uip tasks comments add 123 --text "Escalating to finance" --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskCommentCreated", "Data": { "id": 2, "text": "Escalating to finance" } }

UIP 任务标签

在一次调用中设置或清除任务的标签（标签）— 这是完整替换，而不是合并；传递要保留的每个标签。

参数

名称	必填	用途
<task-id>	是	任务 ID。

选项

长	值	必填	描述
--labels <json>	JSON 数组	是	要设置的标签，例如[{"name":"region","displayName":"Region","displayValue":"EMEA"}]。通过 [] 可清除所有标签。必须为 JSON 数组 — 非数组值将无法在客户端访问。
文件夹选项		否	任务所在的文件夹。

示例

uip tasks labels 123 --labels '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]' --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskLabelsSaved", "Data": { "taskId": 123, "labels": [{ "name": "region", "displayName": "Region", "displayValue": "EMEA" }] } }

uip 任务元数据

编辑任务的标题、优先级和目录链接，并记录所做编辑的备注。合并 — 只有您传递的标志才会更改；至少需要一项。

参数

名称	必填	用途
<task-id>	是	任务 ID。

选项

长	值	描述
--title <title>	字符串	新标题。
--priority <priority>	Low | Medium | High | Critical	新优先级。超出集合的值在客户端命名有效集合时会失败。
--catalog-id <id>	整数	关联任务目录。与 --unset-catalog 互斥。
--unset-catalog	标记	删除任务的目录关联。与 --catalog-id 互斥。
--note <text>	字符串	注释与编辑一起记录。

示例

uip tasks metadata 123 --priority High --note "Escalated per manager request" --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskMetadataEdited", "Data": { "taskId": 123 } }

UIP 任务数据

读取或写入任务的基础表单/业务数据对象。

UIP 任务数据获取

参数

名称	必填	用途
<task-id>	是	任务 ID。

示例

uip tasks data get 123 --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskData", "Data": { "invoiceNumber": "INV-001", "amount": 250.0 } }

uip 任务数据保存

参数

名称	必填	用途
<task-id>	是	任务 ID。

选项

长	值	必填	描述
--data <json>	JSON 对象	是	要保存的任务数据。必须是 JSON 对象（不是数组或标量）——其他任何类型都会在客户端失败。

示例

uip tasks data save 123 --data '{"invoiceNumber":"INV-001","amount":250.0}' --folder-id 42

数据形状（--输出 json）

{ "Code": "TaskDataSaved", "Data": { "taskId": 123 } }

另请参阅

• 概念：UiPath CLI 的组织方式— 工具在“主机 + 工具”模型中的位置。
• 会话— 如何解析租户上下文。
• uip or folders — 在此页面上查找文件夹作用域选项的文件夹 ID/路径/密钥。
• uip login — 用于所有 Action Center 调用的会话。
• 全局选项
• 退出代码