uipath-tasks

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

UiPath Tasks (Action Center) — Agent Skill

Action Center is UiPath's human-in-the-loop platform. Tasks represent work items that require human input — form approvals, document validation, data labeling, and more.

All operations go through

uip tasks <verb> --output json

Action Center是UiPath的人机协同平台。任务代表需要人工输入的工作项——例如表单审批、文档验证、数据标注等。

所有操作均通过

uip tasks <verb> --output json

执行。

Login & Tenant Setup

登录与租户设置

Default to Production. Only switch environment/org/tenant when explicitly stated in the request.

If the request mentions no environment → use the current session (defaults to prod
```
cloud.uipath.com
```
)
If the request explicitly names an environment/org/tenant → check
```
uip login status
```
and re-login if needed

When switching is required:

Check current login:

uip login status --output json

— verify

UIPATH_URL

Organization

, and

Tenant

Re-login with

--authority

only if environment differs:

Alpha:

uip login --authority https://alpha.uipath.com --tenant <tenant>

Staging:

uip login --authority https://staging.uipath.com --tenant <tenant>

Production:
```
uip login --tenant <tenant>
```
(default, no
```
--authority
```
needed)

If already on the right environment but wrong tenant:
```
uip login tenant set <tenant-name>
```

bash

undefined

默认使用生产环境。仅当请求中明确说明时，才切换环境/组织/租户。

如果请求未提及环境→使用当前会话（默认是生产环境
```
cloud.uipath.com
```
）
如果请求明确指定环境/组织/租户→检查
```
uip login status
```
，必要时重新登录

当需要切换时：

检查当前登录状态：

uip login status --output json

——验证

UIPATH_URL

、

Organization

和

Tenant

仅当环境不同时，使用

--authority

重新登录：

Alpha环境：

uip login --authority https://alpha.uipath.com --tenant <tenant>

Staging环境：

uip login --authority https://staging.uipath.com --tenant <tenant>

生产环境：
```
uip login --tenant <tenant>
```
（默认，无需
```
--authority
```
）

如果已在正确环境但租户错误：
```
uip login tenant set <tenant-name>
```

bash

undefined

Check current environment, org, and tenant

检查当前环境、组织和租户

uip login status --output json

Login to a specific environment (production cloud is the default)

登录到特定环境（默认是生产云环境）

uip login --authority https://cloud.uipath.com --tenant MyTenant

List all available tenants (after login)

列出所有可用租户（登录后）

uip login tenant list --output json

Switch tenant within the same environment

在同一环境内切换租户

uip login tenant set MyTenant


> **Critical:** The `--tenant` flag on `tasks` commands does NOT switch the active session tenant.
> The environment is determined by `UIPATH_URL` in the auth file — always confirm with `login status` before running `tasks` commands.

---

uip login tenant set MyTenant


> **重要提示：**`tasks`命令中的`--tenant`标志不会切换活动会话的租户。环境由认证文件中的`UIPATH_URL`决定——在运行`tasks`命令前，请务必用`login status`确认。

---

When to Use

使用场景

Listing or inspecting Action Center tasks across folders
Assigning, reassigning, or unassigning tasks to users
Completing tasks with action outcomes and data payloads
Querying which users have task permissions in a folder
Managing task catalogs (list, get, create, update) and their retention policy
Reading and adding task comments
Setting task labels
Editing task metadata (title, priority, catalog association)
Getting and saving task data

Not in scope: Orchestrator queues or queue items (use
uip or
), Document Understanding model training, or Action Center app development (use
uip codedapp
).

跨文件夹列出或查看Action Center任务
向用户分配、重新分配或取消分配任务
提交操作结果和数据负载以完成任务
查询哪些用户拥有文件夹中的任务权限
管理任务目录（列出、获取、创建、更新）及其保留策略
查看和添加任务评论
设置任务标签
编辑任务元数据（标题、优先级、目录关联）
获取和保存任务数据

**不在范围内：**Orchestrator队列或队列项（使用
uip or
）、Document Understanding模型训练，或Action Center应用开发（使用
uip codedapp
）。

Task Types

任务类型

Type	CLI value	Description
Form task	`FormTask`	Form-based approval/action task
External task	`ExternalTask`	Generic external task
App task	`AppTask`	Action Center app-based task
Document validation	`DocumentValidationTask`	Document Understanding validation
Document classification	`DocumentClassificationTask`	Document Understanding classification
Data labeling	`DataLabelingTask`	Data labeling task

类型	CLI 值	描述
表单任务	`FormTask`	基于表单的审批/操作任务
外部任务	`ExternalTask`	通用外部任务
应用任务	`AppTask`	基于Action Center应用的任务
文档验证	`DocumentValidationTask`	Document Understanding验证任务
文档分类	`DocumentClassificationTask`	Document Understanding分类任务
数据标注	`DataLabelingTask`	数据标注任务

Task Statuses & Priorities

任务状态与优先级

Status	Meaning
`Unassigned`	Created but not assigned to any user
`Pending`	Assigned, awaiting completion
`Completed`	Completed with an action/outcome

Priority	Level
`Low`	Low
`Medium`	Medium (default)
`High`	High
`Critical`	Critical

状态	含义
`Unassigned`	已创建但未分配给任何用户
`Pending`	已分配，等待完成
`Completed`	已完成并提交操作/结果

优先级	级别
`Low`	低
`Medium`	中（默认）
`High`	高
`Critical`	紧急

Quick Start

快速开始

bash

undefined

bash

undefined

Check login and active tenant

检查登录状态和活动租户

uip login status --output json

Switch tenant if needed

必要时切换租户

uip login tenant set <tenant-name>

List all tasks across folders

列出所有跨文件夹的任务

uip tasks list --output json

Get details of a specific task

获取特定任务的详细信息

uip tasks get <task-id> --output json

Assign a task to a user

将任务分配给用户

uip tasks assign <task-id> --user alice@company.com --output json

Complete a task

完成任务

uip tasks complete <task-id> --type ExternalTask --folder-id <folder-id> --output json

---

uip tasks complete <task-id> --type ExternalTask --folder-id <folder-id> --output json

---

Critical Rules

关键规则

Always resolve org and tenant first. If the user specifies an org/environment and tenant, run
```
uip login status
```
to check the active tenant, then
```
uip login tenant set <tenant>
```
to switch if needed. Never assume the active tenant matches the user's intent.
Task IDs are numeric. Unlike other UiPath services that use GUIDs, Action Center uses numeric task IDs. Use
```
tasks list
```
to discover task IDs.
Folder ID is required for complete. Tasks are scoped to folders. Use
```
--folder-id
```
when completing tasks.
Complete requires
--type
. The API routes to different endpoints per task type. Always include
```
--type
```
when completing a task. Use
```
tasks get
```
to check the task type first.
FormTask and AppTask require
--action
and
--data
for completion. Other task types allow optional action and data.
Assign accepts
--user-id
or
--user
(email). Use
```
tasks users <folder-id>
```
to discover assignable users and their IDs.
Always discover before acting. Use
```
tasks list
```
or
```
tasks get
```
to inspect task state before performing assign/complete operations.
Do not complete already-completed tasks. Check the task
```
status
```
field — if it is
```
Completed
```
, inform the user.
Folder ID for catalogs/comments/labels/metadata/data. These commands are folder-scoped. Pass
```
--folder-id
```
, or omit it on an interactive terminal to pick from a list. It is required in non-interactive runs (agents, CI) — always pass it explicitly there.
Retention actions are
Delete
or
Archive
.
```
Archive
```
also needs
```
--retention-bucket-id
```
.
```
--encrypted
```
is create-only and cannot be changed on update.
Labels replace the full set.
```
tasks labels --labels
```
overwrites all labels on the task — include every label to keep, and pass
```
[]
```
to clear them all.
data save
takes no type flag. The command resolves the task type itself; pass the task ID,
```
--folder-id
```
, and
```
--data
```
(a JSON object).

**先确定组织和租户。**如果用户指定了组织/环境和租户，运行
```
uip login status
```
检查活动租户，必要时使用
```
uip login tenant set <tenant>
```
切换。永远不要假设活动租户符合用户需求。
**任务ID是数字。**与其他使用GUID的UiPath服务不同，Action Center使用数字任务ID。使用
```
tasks list
```
查找任务ID。
**完成任务需要文件夹ID。**任务是按文件夹划分范围的。完成任务时需使用
```
--folder-id
```
。
**完成任务需要
```
--type
```
。**API会根据任务类型路由到不同的端点。完成任务时务必包含
```
--type
```
。可先使用
```
tasks get
```
检查任务类型。
**FormTask和AppTask完成时需要
```
--action
```
和
```
--data
```
。**其他任务类型允许可选的操作和数据。
**分配任务接受
```
--user-id
```
或
```
--user
```
（邮箱）。**使用
```
tasks users <folder-id>
```
查找可分配的用户及其ID。
**操作前先查询。**执行分配/完成等操作前，使用
```
tasks list
```
或
```
tasks get
```
检查任务状态。
**不要完成已完成的任务。**检查任务的
```
status
```
字段——如果是
```
Completed
```
，告知用户。
**目录/评论/标签/元数据/数据操作需要文件夹ID。**这些命令是按文件夹划分范围的。传递
```
--folder-id
```
，或者在交互式终端中省略以从列表中选择。在非交互式运行（Agent、CI）中是必填项——务必显式传递。
保留操作是
Delete
或
Archive
。
```
Archive
```
还需要
```
--retention-bucket-id
```
。
```
--encrypted
```
仅在创建时可用，更新时无法修改。
标签会替换全部集合。
```
tasks labels --labels
```
会覆盖任务上的所有标签——需包含所有要保留的标签，传递
```
[]
```
可清除所有标签。
**
```
data save
```
不需要类型标志。**该命令会自行解析任务类型；只需传递任务ID、
```
--folder-id
```
和
```
--data
```
（JSON对象）。

Task Navigation

任务操作导航

Task	Commands to use
List all tasks	`tasks list`
List tasks in a folder	`tasks list --folder-id <id>`
List tasks as admin	`tasks list --as-admin`
Get task details	`tasks get <task-id>`
Get task with type hint	`tasks get <task-id> --task-type FormTask --folder-id <id>`
Assign a task	`tasks assign <task-id> --user <email>`
Assign by user ID	`tasks assign <task-id> --user-id <id>`
Reassign a task	`tasks reassign <task-id> --user <email>`
Unassign a task	`tasks unassign <task-id>`
Complete a task	`tasks complete <task-id> --type <type> --folder-id <id>`
Complete with action	`tasks complete <task-id> --type FormTask --folder-id <id> --action "Approve" --data '{...}'`
List assignable users	`tasks users <folder-id>`
List task catalogs	`tasks catalogs list --folder-id <id>`
Get a catalog	`tasks catalogs get <catalog-id> --folder-id <id>`
Create a catalog	`tasks catalogs create --name <name> --folder-id <id>`
Update a catalog	`tasks catalogs update <catalog-id> --folder-id <id>`
List task comments	`tasks comments list <task-id> --folder-id <id>`
Add a comment	`tasks comments add <task-id> --text <text> --folder-id <id>`
Set task labels	`tasks labels <task-id> --labels '[{"name":"urgent"}]' --folder-id <id>`
Edit task metadata	`tasks metadata <task-id> --folder-id <id> [--title --priority --catalog-id]`
Get task data	`tasks data get <task-id> --folder-id <id>`
Save task data	`tasks data save <task-id> --data '{...}' --folder-id <id>`

任务	使用的命令
列出所有任务	`tasks list`
列出文件夹中的任务	`tasks list --folder-id <id>`
以管理员身份列出任务	`tasks list --as-admin`
获取任务详情	`tasks get <task-id>`
获取带类型提示的任务	`tasks get <task-id> --task-type FormTask --folder-id <id>`
分配任务	`tasks assign <task-id> --user <email>`
通过用户ID分配任务	`tasks assign <task-id> --user-id <id>`
重新分配任务	`tasks reassign <task-id> --user <email>`
取消分配任务	`tasks unassign <task-id>`
完成任务	`tasks complete <task-id> --type <type> --folder-id <id>`
带操作完成任务	`tasks complete <task-id> --type FormTask --folder-id <id> --action "Approve" --data '{...}'`
列出可分配用户	`tasks users <folder-id>`
列出任务目录	`tasks catalogs list --folder-id <id>`
获取目录	`tasks catalogs get <catalog-id> --folder-id <id>`
创建目录	`tasks catalogs create --name <name> --folder-id <id>`
更新目录	`tasks catalogs update <catalog-id> --folder-id <id>`
列出任务评论	`tasks comments list <task-id> --folder-id <id>`
添加评论	`tasks comments add <task-id> --text <text> --folder-id <id>`
设置任务标签	`tasks labels <task-id> --labels '[{"name":"urgent"}]' --folder-id <id>`
编辑任务元数据	`tasks metadata <task-id> --folder-id <id> [--title --priority --catalog-id]`
获取任务数据	`tasks data get <task-id> --folder-id <id>`
保存任务数据	`tasks data save <task-id> --data '{...}' --folder-id <id>`

Workflow: Discover → Plan → Act → Verify

工作流：查询→规划→执行→验证

Always follow this pattern:

Discover — list tasks, get details, find assignable users
Plan — determine the operation (assign, complete, etc.)
Act — execute the operation
Verify — re-read the task to confirm the state change

bash

undefined

请始终遵循此流程：

查询 ——列出任务、获取详情、查找可分配用户
规划 ——确定要执行的操作（分配、完成等）
执行 ——执行操作
验证 ——重新查看任务以确认状态变更

bash

undefined

0. Ensure correct tenant

0.确保租户正确

uip login status --output json uip login tenant set <tenant-name> # only if needed

uip login status --output json uip login tenant set <tenant-name> # 仅在需要时执行

1. Discover

1.查询

uip tasks list --output json uip tasks get <task-id> --output json

2. Plan — determine the task type, folder ID, and action needed

2.规划——确定任务类型、文件夹ID和所需操作

3. Act — assign a task

3.执行——分配任务

uip tasks assign <task-id> --user alice@company.com --output json

4. Verify

4.验证

uip tasks get <task-id> --output json

---

uip tasks get <task-id> --output json

---

Troubleshooting

故障排除

Error	Cause	Fix
`Not logged in`	Auth expired	`uip login`
`HTTP 401`	Invalid token	Re-login
`HTTP 403`	Permission denied	Ensure account has Action Center permissions in the folder
`Missing assignee`	Neither `--user-id` nor `--user` provided	Add `--user <email>` or `--user-id <id>`
`Task not found`	Wrong task ID	Run `tasks list` to get correct ID
Completion fails	Wrong `--type`	Use `tasks get` to check the actual task type
Completion fails for FormTask	Missing `--action` or `--data`	FormTask and AppTask require both `--action` and `--data`
Cannot assign	User lacks permissions in folder	Run `tasks users <folder-id>` to list eligible users

错误	原因	修复方法
`Not logged in`	认证过期	`uip login`
`HTTP 401`	令牌无效	重新登录
`HTTP 403`	权限不足	确保账户在该文件夹中拥有Action Center权限
`Missing assignee`	未提供 `--user-id` 或 `--user`	添加 `--user <email>` 或 `--user-id <id>`
`Task not found`	任务ID错误	运行 `tasks list` 获取正确ID
完成失败	`--type` 错误	使用 `tasks get` 检查实际任务类型
FormTask完成失败	缺少 `--action` 或 `--data`	FormTask和AppTask需要同时提供 `--action` 和 `--data`
无法分配任务	用户在文件夹中无权限	运行 `tasks users <folder-id>` 列出符合条件的用户

References

参考资料

For deeper guidance, read these files only when needed:

```
references/task-lifecycle.md
```
— Listing and getting tasks, type-hint endpoint routing, and the full discover→assign→complete workflow
```
references/task-completion.md
```
— Completion endpoint routing, required fields per task type
```
references/task-assignment.md
```
— Assign, reassign, unassign patterns and user discovery
```
references/task-catalogs.md
```
— Task catalog list/get/create/update and retention policy
```
references/task-metadata.md
```
— Editing task metadata, plus task comments and labels
```
references/task-data.md
```
— Getting and saving task data, and save type routing
```
references/action-center-urls.md
```
— Canonical Action Center URL patterns; read this before constructing or sharing any task deep-link (the portal-UI misclassifies tenant-less URLs as "Orchestrator not enabled")

如需更深入的指导，仅在需要时阅读以下文件：

```
references/task-lifecycle.md
```
——任务的列出与获取、类型提示端点路由，以及完整的查询→分配→完成工作流
```
references/task-completion.md
```
——完成任务的端点路由、各任务类型的必填字段
```
references/task-assignment.md
```
——分配、重新分配、取消分配的模式及用户查询方法
```
references/task-catalogs.md
```
——任务目录的列出/获取/创建/更新及保留策略
```
references/task-metadata.md
```
——任务元数据编辑，以及任务评论和标签管理
```
references/task-data.md
```
——任务数据的获取与保存，以及保存操作的类型路由
```
references/action-center-urls.md
```
——标准Action Center URL模式；在构建或分享任何任务深度链接前请阅读此文件（门户UI会将无租户的URL错误归类为"未启用Orchestrator"）