uip or queue-items

Syntax and options for `uip or queue-items`, which manages individual work transactions inside Orchestrator queues.

管理队列项目— 队列中的单个工作事务。项目流经以下状态： 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>]

备注：

There is currently no set-progress command and no --progress flag on update — progress text cannot be set through this CLI. If you were looking for it, check whether it's been added since this page was last verified, or use the Orchestrator API directly in the meantime.

列表

List queue items in a folder, or across every accessible folder with --all-folders. Filter: --queue-definition-key <guid> and/or --queue-name <name> and/or --status <state>. Paginated via -l, --limit / --offset; --sort-by <field> sorts results (default Id desc). --all-fields returns the full API response instead of the curated subset.

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

get

Get a queue item by <queue-item-key> (the uniqueKey field from list output, unique per attempt). --all-fields returns the full API response instead of the curated subset.

更新

Change fields on a queue item. Optional --priority <High|Normal|Low>, --due-date <ISO-8601>, --defer-date <ISO-8601>, --specific-content <json>.

删除/批量删除

Delete one or many items by <queue-item-key> / <queue-item-key...>. Bulk form requires all items to belong to the same folder. Both require -y, --yes — the CLI never prompts for destructive operations.

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> 。

获取审核人

List users available as reviewers (scoped by --folder-path / --folder-key if provided). Returned keys feed set-reviewer --user-key. --all-fields returns the full API response instead of the curated subset.

获取历史记录

返回队列项目的处理历史记录。通过-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}'

批量添加

在一个请求中添加多个项目。需要<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

退出代码

See Exit codes for the shared contract. delete / delete-bulk exit 2 (validation error) if -y, --yes is omitted.

相关命令

• uip or queues — 队列级别 CRUD。

另请参阅

• uip or概述— 每个uip or动词的共享约定。
• 操作方法：管理 Orchestrator 资产和队列— 批量模式和 CSV 驱动的调度。