UiPath CLI 用户指南
管理队列项目— 队列中的单个工作事务。项目流经以下状态: New → InProgress → Successful / Failed / Abandoned / Retried / Deleted 。队列项目是文件夹范围的;大多数子命令需要--folder-path或--folder-key 。有关队列本身,请参阅uip resource queues 。
有关跨资源约定(身份验证、文件夹作用域、密钥类型、输出信封),请参阅uip resource概述。
大纲
uip resource queue-items list <flags below>
uip resource queue-items get <queue-item-key>
uip resource queue-items update <queue-item-key> [--progress <text>] [--priority <p>] [--due-date <iso>] [--defer-date <iso>] [--specific-content <json>]
uip resource queue-items set-progress <queue-item-key> <progress>
uip resource queue-items delete <queue-item-key>
uip resource queue-items delete-bulk <queue-item-key...>
uip resource queue-items set-review-status <status> <queue-item-key...>
uip resource queue-items set-reviewer <queue-item-key...> --user-key <guid>
uip resource queue-items unset-reviewer <queue-item-key...>
uip resource queue-items get-reviewers [--folder-path <path> | --folder-key <key>]
uip resource queue-items get-history <queue-item-key> [-l <n>] [--offset <n>]
uip resource queue-items get-last-retry <retry-chain-key>
uip resource queue-items has-video <queue-item-key>
uip resource queue-items add <queue-name> --folder-path <path> | --folder-key <key> --specific-content <json> [-r <ref>] [-p <priority>] [--defer-date <iso>] [--due-date <iso>]
uip resource queue-items bulk-add <queue-name> --folder-path <path> | --folder-key <key> --queue-items <json-array> [--commit-type <mode>]
uip resource queue-items list <flags below>
uip resource queue-items get <queue-item-key>
uip resource queue-items update <queue-item-key> [--progress <text>] [--priority <p>] [--due-date <iso>] [--defer-date <iso>] [--specific-content <json>]
uip resource queue-items set-progress <queue-item-key> <progress>
uip resource queue-items delete <queue-item-key>
uip resource queue-items delete-bulk <queue-item-key...>
uip resource queue-items set-review-status <status> <queue-item-key...>
uip resource queue-items set-reviewer <queue-item-key...> --user-key <guid>
uip resource queue-items unset-reviewer <queue-item-key...>
uip resource queue-items get-reviewers [--folder-path <path> | --folder-key <key>]
uip resource queue-items get-history <queue-item-key> [-l <n>] [--offset <n>]
uip resource queue-items get-last-retry <retry-chain-key>
uip resource queue-items has-video <queue-item-key>
uip resource queue-items add <queue-name> --folder-path <path> | --folder-key <key> --specific-content <json> [-r <ref>] [-p <priority>] [--defer-date <iso>] [--due-date <iso>]
uip resource queue-items bulk-add <queue-name> --folder-path <path> | --folder-key <key> --queue-items <json-array> [--commit-type <mode>]
列表
列出文件夹中的队列项目。筛选: --queue-definition-key <guid>和/或--queue-name <name>和/或--status <state> 。
uip resource queue-items list --folder-path Shared \
--queue-name InvoiceQueue --status Failed
uip resource queue-items list --folder-path Shared \
--queue-name InvoiceQueue --status Failed
get
按<queue-item-key> (来自list输出的uniqueKey字段,每次尝试唯一的)获取队列项目。
更新
更改队列项目上的字段。可选的--progress 、 --priority <High|Normal|Low> 、 --due-date <ISO-8601> 、 --defer-date <ISO-8601> 、 --specific-content <json> 。
设置进度
请更新正在进行的项目的进度文本: set-progress <queue-item-key> <progress> 。
删除/批量删除
在<queue-item-key>前删除一个或多个项目/ <queue-item-key...> 。批量表单要求所有项目属于同一个文件夹。
设置审核状态
针对一个或多个<queue-item-key...>设置<status> ( Retried Abandoned 、 Deleted )。
设置审核人/取消设置审核人
为一个或多个<queue-item-key...>分配或清除审核人。set-reviewer需要--user-key <guid> 。
获取审核人
列出可以作为审核人的用户(按--folder-path / --folder-key如果提供,则确定范围)。返回的密钥订阅源set-reviewer --user-key 。
获取历史记录
返回队列项目的处理历史记录。通过-l, --limit / --offset分页。
获取-上次重试
返回项目的最近一次重试次数。参数为重试链密钥( key中的list字段,而不是uniqueKey )。
含视频
返回队列项目是否附加了视频录制。
添加
按名称将单个项目添加到队列中。需要<queue-name>和--specific-content <json> 。可选的-r, --reference 、 -p, --priority <High|Normal|Low> (默认为Normal )、 --defer-date 、 --due-date 。
uip resource queue-items add InvoiceQueue --folder-path Shared \
--specific-content '{"InvoiceId":"INV-001","Amount":1500}'
uip resource queue-items add InvoiceQueue --folder-path Shared \
--specific-content '{"InvoiceId":"INV-001","Amount":1500}'
批量添加
在一个请求中添加多个项目。需要<queue-name>和--queue-items <json-array> 。可选--commit-type <AllOrNothing|StopOnFirstFailure|ProcessAllIndependently> (默认为ProcessAllIndependently )。
ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
--folder-path Shared \
--queue-items "$ITEMS" \
--commit-type StopOnFirstFailure
ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
--folder-path Shared \
--queue-items "$ITEMS" \
--commit-type StopOnFirstFailure
另请参阅
uip resource queues— 队列级别 CRUD。uip resource概述— 每个uip resource动词的共享约定。- 操作方法:管理 Orchestrator 资产和队列— 批量模式和 CSV 驱动的调度。