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)

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

レビューステータスを設定

1 つ以上の<queue-item-key...>に <status> (Retried、 Abandoned、 Deleted) を設定します。

set-reviewer / unset-reviewer

1 つまたは複数の <queue-item-key...>でレビュー担当者を割り当てるか、レビュー担当者をクリアします。set-reviewer には --user-key <guid>が必要です。

GET-REVIEWERS

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でページ分割

最後のリトライを取得

アイテムの最新のリトライを返します。Argument はリトライ チェーン キーです (uniqueKeyではなく、listのkeyフィールド)。

has-video

キュー アイテムにビデオ記録が添付されているかどうかを返します。

追加

名前でキューにアイテムを 1 つ追加します。<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}'

一括追加

1 つの要求に複数のアイテムを追加します。<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 主導のディスパッチ。