uip or queue-items

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

Gerenciar itens de fila — transações de trabalho individuais dentro de filas. Os itens fluem por estados: New → InProgress → Successful / Failed / Abandoned / Retried / Deleted. Os itens de fila têm escopo de pasta; a maioria dos subcomandos requer --folder-path ou --folder-key. Para a própria fila, consulte uip or queues.

Para as convenções entre recursos (autenticação, escopo de pasta, tipos de chave, envelope de saída), consulte a visão geraluip or .

Resumo

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

Observação:

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.

Atualizar

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

excluir / excluir em massa

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

definir-revisão-status

Defina <status> (Retried, Abandoned, Deleted) como um ou mais <queue-item-key...>.

definir revisor / unset-reviewer

Atribuir ou limpar um revisor em um ou mais <queue-item-key...>. set-reviewer requer --user-key <guid>.

obter-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.

Obter histórico

Retorna o histórico de processamento de um item da fila. Paginado por meio de -l, --limit / --offset.

obter a última tentativa

Retorna a repetição mais recente de um item. O argumento é a chave da cadeia de nova tentativa (o campo key de list, não de uniqueKey).

tem vídeo

Retorna se um item da fila tem uma gravação de vídeo anexada.

Adicionar

Adicione um único item a uma fila por nome. Requer <queue-name> e --specific-content <json>. Opcional -r, --reference, -p, --priority <High|Normal|Low> (padrão Normal), --defer-date, --due-date.

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

adição em massa

Adicione vários itens em uma solicitação. Requer <queue-name> e --queue-items <json-array>. Opcional --commit-type <AllOrNothing|StopOnFirstFailure|ProcessAllIndependently> (padrão 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 saída

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 no nível da fila.

Veja também

• Visão geraluip or — convenções compartilhadas para cada verbo uip or .
• Como fazer: gerenciar ativos e filas do Orchestrator — padrões em massa e envio orientado por CSV.