uip ou queue-Items

Syntaxe et options pour `uip ou queue-items`, qui gère les transactions de travail individuelles dans les files d'attente Orchestrator.

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 :

Il n'y a actuellement aucune commande set-progress et aucun indicateur --progress sur update — le texte de progression ne peut pas être défini via cette CLI. Si vous le cherchiez, vérifiez s’il a été ajouté depuis que cette page a été vérifiée pour la dernière fois ou utilisez l’API Orchestrator directement entre-temps.

List

Répertoriez les éléments de la file d'attente dans un dossier ou dans chaque dossier accessible avec --all-folders. Filtre: --queue-definition-key <guid> et/ou --queue-name <name> et/ou --status <state>. Paginé via -l, --limit / --offset; --sort-by <field> trie les résultats (par défaut Id desc). --all-fields renvoie la réponse complète de l'API au lieu du sous-ensemble sélectionné.

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

get

Obtenez un élément de file d'attente par <queue-item-key> (le champ uniqueKey de la sortie list, unique par tentative). --all-fields renvoie la réponse complète de l'API au lieu du sous-ensemble sélectionné.

Mettre à jour

Modifiez les champs d'un élément de la file d'attente. Facultatif --priority <High|Normal|Low>, --due-date <ISO-8601>, --defer-date <ISO-8601>, --specific-content <json>.

supprimer/supprimer en bloc

Supprimez un ou plusieurs éléments par <queue-item-key> / <queue-item-key...>. Le formulaire en bloc requiert que tous les éléments appartiennent au même dossier. Les deux nécessitent -y, --yes — la CLI ne demande jamais d'opérations destructrices.

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

Lister les utilisateurs disponibles en tant que réviseurs (étendue par --folder-path / --folder-key si fourni). Flux de clés renvoyées set-reviewer --user-key. --all-fields renvoie la réponse complète de l'API au lieu du sous-ensemble sélectionné.

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

Voir Codes de sortie pour le contrat partagé. delete / delete-bulk quittez 2 (erreur de validation) si -y, --yes est omis.

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.