uip or queue-items

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

Gérer les éléments de la file d’attente — les transactions de travail individuelles dans les files d’attente. Les éléments passent par les états: New → InProgress → Successful / Failed / Abandoned / Retried / Deleted. Les éléments de la file d'attente sont à l'échelle du dossier; la plupart des sous-commandes nécessitent --folder-path ou --folder-key. Pour la file d'attente elle-même, consultez uip or queues.

Pour les conventions inter-ressources (authentification, étendue des dossiers, types de clés, enveloppe de sortie), consultez la vue d’ensembleuip or .

Synthèse

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

Remarque :

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.

Mettre à jour

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

supprimer/supprimer en bloc

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

Définir-révision-statut

Définissez <status> (Retried, Abandoned, Deleted) pour un ou plusieurs <queue-item-key...>.

Définir-réviseur/non défini-réviseur

Affectez ou supprimez un réviseur sur un ou plusieurs <queue-item-key...>. set-reviewer nécessite --user-key <guid>.

obtenir des réviseurs

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.

Obtenir l'historique

Renvoyez l'historique de traitement d'un élément de file d'attente. Paginé via -l, --limit / --offset.

Obtenir la dernière nouvelle tentative

Renvoie la nouvelle tentative la plus récente pour un élément. L'argument est la clé de la chaîne de nouvelle tentative (le champ key de list, non uniqueKey).

comporte une vidéo

Indique si un élément de la file d'attente est associé à un enregistrement vidéo.

Ajouter (Add)

Ajoutez un seul élément à une file d'attente par nom. Nécessite <queue-name> et --specific-content <json>. Facultatif -r, --reference, -p, --priority <High|Normal|Low> (par défaut Normal), --defer-date, --due-date.

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

ajout en bloc

Ajoutez plusieurs éléments dans une même requête. Nécessite <queue-name> et --queue-items <json-array>. Facultatif --commit-type <AllOrNothing|StopOnFirstFailure|ProcessAllIndependently> (par défaut ProcessAllIndependently).

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

Codes de sortie

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

Commandes associées

• uip or queues — CRUD au niveau de la file d'attente.

Voir également

• Vue d’ensemble deuip or — conventions partagées pour chaque uip or verbe.
• Procédure: gérer les ressources et les files d'attente d'Orchestrator — les modèles en bloc et l'envoi basé sur des fichiers CSV.