uip or queue-items

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

Warteschlangenelemente verwalten – einzelne Arbeitstransaktionen innerhalb von Warteschlangen. Elemente durchlaufen Status: New → InProgress → Successful / Failed / Abandoned / Retried / Deleted. Warteschlangenelemente haben einen Ordner-Scope; Die meisten Unterbefehle erfordern --folder-path oder --folder-key. Die Warteschlange selbst finden Sie unter uip or queues.

Die ressourcenübergreifenden Konventionen (Authentifizierung, Ordner-Scoping, Schlüsseltypen, Ausgabeumschlag) finden Sie in der uip or -Übersicht.

Zusammenfassung

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

Hinweis:

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.

Liste

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.

Aktualisieren

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

Delete/Delete-Bulk

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

Überprüfungsstatus festlegen

Legen Sie <status> (Retried, Abandoned, Deleted) für ein oder mehrere <queue-item-key...> fest.

set-reviewer/unset-reviewer

Prüfer für ein oder mehrere <queue-item-key...> zuweisen oder löschen. set-reviewer erfordert --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.

Get-History

Verarbeitungsverlauf für ein Warteschlangenelement zurückgeben. Paginiert über -l, --limit / --offset.

Letzte-Wiederholung erhalten

Gibt die letzte Wiederholung für ein Element zurück. Das Argument ist der Wiederholungskettenschlüssel (das Feld key von list, nicht uniqueKey).

Has-Video

Gibt zurück, ob an ein Warteschlangenelement eine Videoaufzeichnung angehängt ist.

Hinzufügen

Fügen Sie ein einzelnes Element zu einer Warteschlange anhand des Namens hinzu. Erfordert <queue-name> und --specific-content <json>. Optional: -r, --reference, -p, --priority <High|Normal|Low> (Standard: Normal), --defer-date, --due-date.

uip or queue-items add InvoiceQueue --folder-path Shared \
  --specific-content '{"InvoiceId":"INV-001","Amount":1500}'

Massenhinzufügen

Fügen Sie mehrere Elemente in einer Anforderung hinzu. Erfordert <queue-name> und --queue-items <json-array>. Optional: --commit-type <AllOrNothing|StopOnFirstFailure|ProcessAllIndependently> (Standard: ProcessAllIndependently).

ITEMS=$(jq -c . ./items.json)
uip or queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure

Exitcodes

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

Zugehörige Befehle

• uip or queues – CRUD auf Warteschlangenebene.

Siehe auch

• uip or Übersicht – gemeinsame Konventionen für jedes uip or -Verb.
• So: Verwalten von Orchestrator-Assets und Warteschlangen – Massenmuster und CSV-gesteuerter Versand.