uip ou queue-items

Sintaxe e opções para "uip or queue-items", que gerencia transações de trabalho individuais dentro das filas do Orchestrator.

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:

Atualmente não há comando set-progress e nenhum sinalizador --progress em update — o texto de progresso não pode ser definido por meio desta CLI. Se você estiver procurando por ela, verifique se ela foi adicionada desde a última verificação desta página ou use a API do Orchestrator diretamente enquanto isso.

List

Liste itens de fila em uma pasta ou em cada pasta acessível --all-folders com. Filtro: --queue-definition-key <guid> e/ou --queue-name <name> e/ou --status <state>. Paginado por meio de -l, --limit / --offset; --sort-by <field> classifica resultados (padrão Id desc). --all-fields retorna a resposta completa da API em vez do subconjunto selecionado.

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

get

Obtenha um item de fila por <queue-item-key> (o campo uniqueKey da saída list, exclusivo por tentativa). --all-fields retorna a resposta completa da API em vez do subconjunto selecionado.

Atualizar

Alterar campos em um item da fila. Opcional --priority <High|Normal|Low>, --due-date <ISO-8601>, --defer-date <ISO-8601>, --specific-content <json>.

excluir / excluir em massa

Exclua um ou muitos itens por <queue-item-key> / <queue-item-key...>. O formulário em massa exige que todos os itens pertençam à mesma pasta. Ambos exigem -y, --yes — a CLI nunca solicita operações destrutivas.

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

Listar usuários disponíveis como revisores (com escopo de --folder-path / --folder-key, se fornecido). Feed de chaves retornado set-reviewer --user-key. --all-fields retorna a resposta completa da API em vez do subconjunto selecionado.

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

Consulte Códigos de saída para o contrato compartilhado. delete / delete-bulk sai de 2 (erro de validação) se -y, --yes for omitido.

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.