uip or queue-items

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

Gestionar artículos en cola : transacciones de trabajo individuales dentro de colas. Los elementos fluyen a través de estados: New → InProgress → Successful / Failed / Abandoned / Retried / Deleted. Los artículos en cola tienen ámbito de carpeta; la mayoría de los subcomandos requieren --folder-path o --folder-key. Para la cola en sí, consulta uip or queues.

Para las convenciones de recursos cruzados (autenticación, ámbito de carpeta, tipos de clave, sobre de salida), consulta la uip or descripción general.

Sinopsis

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

Nota:

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.

Lista

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.

Actualizar

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

eliminar / eliminar masivamente

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

establecer-estado-de-revisión

Establece <status> (Retried, Abandoned, Deleted) para uno o más <queue-item-key...>.

establecer-revisor / no establecer-revisor

Asignar o borrar un revisor en uno o más <queue-item-key...>. set-reviewer requiere --user-key <guid>.

obtener revisores

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.

Obtener historial

Devuelve el historial de procesamiento de un artículo en cola. Paginado mediante -l, --limit / --offset.

obtener-último-reintento

Devuelve el reintento más reciente para un elemento. El argumento es la clave de la cadena de reintentos (el campo key de list, no uniqueKey).

tiene-vídeo

Devuelve si un elemento de la cola tiene una grabación de vídeo adjunta.

Añadir

Añade un único elemento a una cola por su nombre. Requiere <queue-name> y --specific-content <json>. Opcional -r, --reference, -p, --priority <High|Normal|Low> (predeterminado Normal), --defer-date, --due-date.

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

Añadir en masa

Añada varios elementos en una solicitud. Requiere <queue-name> y --queue-items <json-array>. Opcional --commit-type <AllOrNothing|StopOnFirstFailure|ProcessAllIndependently> (predeterminado ProcessAllIndependently).

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

Códigos de salida

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

Comandos relacionados

• uip or queues : CRUD en el nivel de cola.

Ver también

• Información generaluip or : convenciones compartidas para cada verbo uip or .
• Tutorial: gestionar activos y colas de Orchestrator : patrones masivos y envío impulsado por CSV.