UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UIP 或队列项目

“uip 或队列项目”的语法和选项,用于管理 Orchestrator 队列中的各个工作事务。

管理队列项目— 队列中的单个工作事务。项目流经以下状态: New → InProgress → Successful / Failed / Abandoned / Retried / Deleted 。队列项目是文件夹范围的;大多数子命令需要--folder-path或--folder-key 。有关队列本身,请参阅uip or queues 。

有关跨资源约定(身份验证、文件夹作用域、密钥类型、输出信封),请参阅uip or概述。

大纲​

uip or queue-items list                [--folder-path <path> | --folder-key <key> | --all-folders] [--queue-definition-key <key>] [--queue-name <name>] [--status <status>] [-l <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or queue-items get                 <queue-item-key> [--all-fields]
uip or queue-items update              <queue-item-key> [--priority <p>] [--due-date <iso>] [--defer-date <iso>] [--specific-content <json>]
uip or queue-items delete              <queue-item-key> --yes
uip or queue-items delete-bulk         <queue-item-key...> --yes
uip or queue-items set-review-status   <status> <queue-item-key...>
uip or queue-items set-reviewer        <queue-item-key...> --user-key <guid>
uip or queue-items unset-reviewer      <queue-item-key...>
uip or queue-items get-reviewers       [--folder-path <path> | --folder-key <key>] [--all-fields]
uip or queue-items get-history         <queue-item-key> [-l <n>] [--offset <n>] [--all-fields]
uip or queue-items get-last-retry      <retry-chain-key> [--all-fields]
uip or queue-items has-video           <queue-item-key>
uip or queue-items add                 <queue-name> --folder-path <path> | --folder-key <key> --specific-content <json> [-r <ref>] [-p <priority>] [--defer-date <iso>] [--due-date <iso>] [--all-fields]
uip or queue-items bulk-add            <queue-name> --folder-path <path> | --folder-key <key> --queue-items <json-array> [--commit-type <mode>]
uip or queue-items list                [--folder-path <path> | --folder-key <key> | --all-folders] [--queue-definition-key <key>] [--queue-name <name>] [--status <status>] [-l <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or queue-items get                 <queue-item-key> [--all-fields]
uip or queue-items update              <queue-item-key> [--priority <p>] [--due-date <iso>] [--defer-date <iso>] [--specific-content <json>]
uip or queue-items delete              <queue-item-key> --yes
uip or queue-items delete-bulk         <queue-item-key...> --yes
uip or queue-items set-review-status   <status> <queue-item-key...>
uip or queue-items set-reviewer        <queue-item-key...> --user-key <guid>
uip or queue-items unset-reviewer      <queue-item-key...>
uip or queue-items get-reviewers       [--folder-path <path> | --folder-key <key>] [--all-fields]
uip or queue-items get-history         <queue-item-key> [-l <n>] [--offset <n>] [--all-fields]
uip or queue-items get-last-retry      <retry-chain-key> [--all-fields]
uip or queue-items has-video           <queue-item-key>
uip or queue-items add                 <queue-name> --folder-path <path> | --folder-key <key> --specific-content <json> [-r <ref>] [-p <priority>] [--defer-date <iso>] [--due-date <iso>] [--all-fields]
uip or queue-items bulk-add            <queue-name> --folder-path <path> | --folder-key <key> --queue-items <json-array> [--commit-type <mode>]
备注:

当前没有 set-progress 命令,并且 --progress 上没有 update 标志 — 无法通过此 CLI 设置进度文本。如果您正在查找此页面,请检查自上次验证此页面后是否添加了此页面,或在此期间直接使用 Orchestrator API。

列表​

列出文件夹中的队列项目或使用 --all-folders 列出每个可访问文件夹中的队列项目。筛选:--queue-definition-key <guid> 和/或 --queue-name <name> 和/或 --status <state>。通过 -l, --limit / --offset 分页; --sort-by <field> 对结果进行排序(默认为 Id desc)。--all-fields 返回完整的 API 响应,而不是策划的子集。

uip or queue-items list --folder-path Shared \
  --queue-name InvoiceQueue --status Failed
uip or queue-items list --folder-path Shared \
  --queue-name InvoiceQueue --status Failed

按 <queue-item-key>(来自 uniqueKey 输出的 list 字段,每次尝试唯一的)获取队列项目。--all-fields 返回完整的 API 响应,而不是策划的子集。

更新​

更改队列项目上的字段。可选 --priority <High|Normal|Low>、--due-date <ISO-8601>、--defer-date <ISO-8601>、--specific-content <json>。

删除/批量删除​

在 <queue-item-key> 前删除一个或多个项目/<queue-item-key...>。批量表单要求所有项目属于同一个文件夹。两者都需要 -y, --yes — CLI 从不提示进行破坏性操作。

uip or queue-items delete a1b2c3d4-0000-0000-0000-000000000001 --yes
uip or queue-items delete a1b2c3d4-0000-0000-0000-000000000001 --yes

设置审核状态​

针对一个或多个<queue-item-key...>设置<status> ( Retried Abandoned 、 Deleted )。

设置审核人/取消设置审核人​

为一个或多个<queue-item-key...>分配或清除审核人。set-reviewer需要--user-key <guid> 。

获取审核人​

列出可以作为审核人的用户(按 --folder-path / --folder-key 如果提供,则确定范围)。返回的密钥订阅源 set-reviewer --user-key。--all-fields 返回完整的 API 响应,而不是策划的子集。

获取历史记录​

返回队列项目的处理历史记录。通过-l, --limit / --offset分页。

获取-上次重试​

返回项目的最近一次重试次数。参数为重试链密钥( key中的list字段,而不是uniqueKey )。

含视频​

返回队列项目是否附加了视频录制。

添加​

按名称将单个项目添加到队列中。需要<queue-name>和--specific-content <json> 。可选的-r, --reference 、 -p, --priority <High|Normal|Low> (默认为Normal )、 --defer-date 、 --due-date 。

uip or queue-items add InvoiceQueue --folder-path Shared \
  --specific-content '{"InvoiceId":"INV-001","Amount":1500}'
uip or 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 or queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure
ITEMS=$(jq -c . ./items.json)
uip or queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure

退出代码​

请参阅共享合同的退出代码。deletedelete-bulk2-y, --yes如果省略 , 将退出 (验证错误)。

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新