tarefas do UIP

Comandos para gerenciar tarefas, catálogos, comentários, rótulos, metadados e dados de tarefas do Action Center usando a ferramenta "uip Tasks".

uip tasks gerencia tarefas do Action Center — os itens de trabalho humanos (preenchimentos de formulários, aprovações, validação/classificação de documentos, rotulagem de dados) que os processos e agentes de RPA criam para uma pessoa concluir. A ferramenta permite que você liste e inspecione tarefas, atribua ou reatribua-as, conclua-as com uma ação e carga de dados e gerencie os recursos auxiliares anexados a uma tarefa: catálogos (configurações de agrupamento/retenção), comentários, rótulos (tags), metadados ( título/prioridade/link do catálogo) e o formulário/dados de negócios da própria tarefa. tasks é o prefixo do comando; o pacote subjacente é @uipath/tasks-tool.

Conceitos

• Escopo de pasta — cada verbo que opera em uma tarefa ou catálogo específico aceita --folder-id <id>, --folder-path <path> ou --folder-key <key> ( mutuamente exclusivo; imposto no tempo de análise por meio de conflitos do Commander). Quando nenhum é passado em um terminal interativo, a CLI mostra um seletor de pasta; em uma execução não interativa (CI, agentes de codificação), ele falha rapidamente ao solicitar um. uip tasks list e uip tasks get são as duas exceções — uma pasta é opcional lá e simplesmente limita os resultados/pesquisa quando fornecida.
• Tipo de tarefa — vários verbos (get --task-type, complete --type) recebem um dos FormTask, ExternalTask, AppTask, DocumentValidationTask, DocumentClassificationTask, DataLabelingTask, QuickFormTask. Um valor não reconhecido falha no lado do cliente com a lista completa nomeada no erro.
• Paginação — verbos no estilo de lista (list, catalogs list, comments list, users) página internamente com um tamanho de página de 100 itens e seguem nextCursor até esgotar ou --limit ser atingida, retornando uma matriz simples de qualquer forma — não há sinalizador de cursor para gerenciar a si mesmo.
• Catálogos são configurações de agrupamento/retenção opcionais para tarefas — metadata --catalog-id vincula uma tarefa a uma; Os campos de retenção de catalogs create/update (--retention-action, --retention-period, --retention-bucket-id) controlam o que acontece com os dados do catálogo ao longo do tempo. --encrypted em catalogs create é imutável — não há como alterá-lo via catalogs update.

Resumo

uip tasks list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [--as-admin] [-l, --limit <n>]
uip tasks get <id> [--task-type <type>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks assign <task-id> (--user-id <id> | --user <email>)
uip tasks reassign <task-id> (--user-id <id> | --user <email>)
uip tasks unassign <task-id>
uip tasks complete <task-id> --type <type> [--data <json>] [--action <action>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks users [folder-id] [--folder-path <path> | --folder-key <key>] [-l, --limit <n>]

uip tasks catalogs list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [-l, --limit <n>]
uip tasks catalogs get <id> [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs create --name <name> [--description <text>] [--encrypted] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs update <id> [--name <name>] [--description <text>] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]

uip tasks comments list <task-id> [-l, --limit <n>] [folder options]
uip tasks comments add <task-id> --text <text> [folder options]

uip tasks labels <task-id> --labels <json> [folder options]
uip tasks metadata <task-id> [--title <text>] [--priority <level>] [--catalog-id <id> | --unset-catalog] [--note <text>] [folder options]

uip tasks data get <task-id> [folder options]
uip tasks data save <task-id> --data <json> [folder options]

lista de tarefas do uip

Liste tarefas em pastas (ou uma pasta, quando tiver o escopo definido).

Opções

Long	Valor	Description
--folder-id <id>	Número inteiro	Filtra por ID da pasta.
--folder-path <path>	String	Filtra por caminho de pasta (alternativo a --folder-id).
--folder-key <key>	GUID	Filtra por chave de pasta (alternativa a --folder-id).
--as-admin	Bandeira	Liste tarefas como administrador (visibilidade mais ampla do que suas próprias tarefas atribuídas/disponíveis).
-l, --limit <number>	Número inteiro	Máximo de itens a serem retornados. Busca tudo (paginando internamente) quando omitido.

Exemplo

uip tasks list --folder-path "Shared/Finance" --limit 20

Formato dos dados (--output json)

{ "Code": "TaskList", "Data": [ { "id": 1, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } ] }

tarefas do uip obter

Consegue os detalhes de uma tarefa por ID.

Argumentos

Name	Required	Finalidade
<id>	sim	ID da tarefa. Use tasks list para encontrar um.

Opções

Long	Valor	Description
--task-type <type>	um dos 7 tipos de tarefas	Tipo de tarefa. Requer uma opção de pasta quando aprovado — caso contrário, falhará rapidamente.
--folder-id <id> / --folder-path <path> / --folder-key <key>		Escopo da pasta. Necessário apenas quando --task-type está definido.

Exemplo

uip tasks get 123 --task-type FormTask --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskDetails", "Data": { "id": 123, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } }

tarefas do uip atribuir / reatribuir

Atribua uma tarefa a um usuário ou reatribua-a a uma diferente — formato de opção idêntico, diferente Code no sucesso.

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Opções

Long	Valor	Required	Description
--user-id <id>	Número inteiro	um desses dois	O ID de usuário numérico do destinatário.
--user <email>	String	um desses dois	O nome de usuário ou email do destinatário (alternativa a --user-id).

Ao passar, nenhuma falha com um erro explícito "destinatário ausente" erro.

Exemplo

uip tasks assign 123 --user [e-mail]
uip tasks reassign 123 --user-id 7

Formato dos dados (--output json)

{ "Code": "TaskAssigned", "Data": { "id": 123, "assignedTo": "[e-mail]" } }

Code é TaskReassigned para reassign.

cancelar atribuição de tarefas do uip

Remove o destinatário de uma tarefa. Não há opções além do ID da tarefa.

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Exemplo

uip tasks unassign 123

Formato dos dados (--output json)

{ "Code": "TaskUnassigned", "Data": { "id": 123 } }

tarefas do uip concluídas

Conclua uma tarefa com uma ação e carga de dados opcional.

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Opções

Long	Valor	Required	Description
--type <type>	um dos 7 tipos de tarefas	sim	Tipo de tarefa — validado do lado do cliente em relação ao enum.
--data <json>	JSON	não	Carga de dados da tarefa como uma string JSON.
--action <action>	String	condicionalmente	Nome da ação. Necessário na prática para FormTask e AppTask (não imposto no lado do cliente — a plataforma rejeita uma ação ausente para esses tipos).
Opções de pasta		não	Uma pasta é resolvida (interativa se omitida, em um TTY) antes da conclusão.

Exemplo

uip tasks complete 123 --type FormTask --action Approve --data '{"comment":"Looks good"}'

Formato dos dados (--output json)

{ "Code": "TaskCompleted", "Data": { "id": 123, "status": "Completed" } }

usuários de tarefas do uip

Listar usuários com permissões de tarefas em uma pasta — a origem dos valores --user-id/--user em assign/reassign.

Argumentos

Name	Required	Finalidade
[folder-id]	não	ID da pasta como um argumento posicional. mutuamente exclusivo com --folder-path/--folder-key — a passagem de ambos falha explicitamente.

Opções

Long	Valor	Description
--folder-path <path>	String	Caminho da pasta (alternativa ao argumento posicional).
--folder-key <key>	GUID	Chave da pasta (alternativa ao argumento posicional).
-l, --limit <number>	Número inteiro	Máximo de itens a serem retornados.

Exemplo

uip tasks users 42
uip tasks users --folder-path "Shared/Finance" --limit 10

Formato dos dados (--output json)

{
  "Code": "TaskUserList",
  "Data": [
    { "id": 1, "name": "Alice", "surname": "Smith", "userName": "alice", "emailAddress": "[e-mail]", "displayName": "Alice Smith" }
  ]
}

catálogos de tarefas da uip

Gerenciar catálogos de tarefas — agrupamentos nomeados de tarefas com política opcional de criptografia e retenção.

lista de catálogos de tarefas do uip

Opções

Long	Valor	Description
Opções de pasta		Pasta para listar catálogos (uma pasta é resolvida se omitida, de acordo com Conceitos).
-l, --limit <number>	Número inteiro	Máximo de itens a serem retornados.

Exemplo

uip tasks catalogs list --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskCatalogList", "Data": [ { "id": 5, "name": "Invoices", "encrypted": false } ] }

catálogos de tarefas do uip obter

Argumentos

Name	Required	Finalidade
<id>	sim	ID do catálogo de tarefas.

Exemplo

uip tasks catalogs get 5 --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskCatalogDetails", "Data": { "id": 5, "name": "Invoices", "encrypted": false } }

criação de catálogos de tarefas do uip

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome do catálogo.
--description <text>	String	não	Descrição do catálogo.
--encrypted	Bandeira	não	Criptografe os dados da tarefa neste catálogo. Imutável — não pode ser alterado por catalogs update posteriormente.
--retention-action <action>	Delete | Archive	não	O que acontece no limite de retenção. Qualquer outro valor falha no lado do cliente.
--retention-period <days>	Número inteiro	não	Período de retenção em dias.
--retention-bucket-id <id>	Número inteiro	não	ID do bucket de armazenamento, usado quando --retention-action Archive.

Exemplo

uip tasks catalogs create --name Invoices --retention-action Archive --retention-period 90 --retention-bucket-id 3 --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskCatalogCreated", "Data": { "id": 5, "name": "Invoices" } }

atualização de catálogos de tarefas do uip

Mesclações — apenas os sinalizadores que você aprovado mudam. Pelo menos --name/--description/--retention-action/--retention-period/--retention-bucket-id é necessário; a chamada sem nenhum falha antes de qualquer acesso ao arquivo/rede. Não é possível alterar --encrypted aqui.

Argumentos

Name	Required	Finalidade
<id>	sim	ID do catálogo de tarefas.

Opções

Mesmo definido como create menos --encrypted.

Exemplo

uip tasks catalogs update 5 --name "Invoices v2" --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskCatalogUpdated", "Data": { "id": 5, "name": "Invoices v2" } }

Comentários de tarefas do uip

lista de comentários de tarefas uip

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Opções

Long	Valor	Description
-l, --limit <number>	Número inteiro	Máximo de itens a serem retornados.
Opções de pasta		Pasta em que a tarefa está localizada.

Exemplo

uip tasks comments list 123 --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskCommentList", "Data": [ { "id": 1, "text": "Looks good", "createdBy": "alice" } ] }

tarefas uip comentários adicionar

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Opções

Long	Valor	Required	Description
--text <text>	String	sim	Texto do comentário. String vazia é rejeitada.
Opções de pasta		não	Pasta em que a tarefa está localizada.

Exemplo

uip tasks comments add 123 --text "Escalating to finance" --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskCommentCreated", "Data": { "id": 2, "text": "Escalating to finance" } }

rótulos de tarefas do uip

Definir ou limpar os rótulos (tags) em uma tarefa em uma chamada — isso é uma substituição completa, não uma mesclagem; passar todos os rótulos que deseja manter.

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Opções

Long	Valor	Required	Description
--labels <json>	Matriz JSON	sim	Rótulos a definir, por exemplo [{"name":"region","displayName":"Region","displayValue":"EMEA"}]). Transmita [] para limpar todos os rótulos. Deve ser uma matriz JSON — um valor que não é de array falha no lado do cliente.
Opções de pasta		não	Pasta em que a tarefa está localizada.

Exemplo

uip tasks labels 123 --labels '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]' --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskLabelsSaved", "Data": { "taskId": 123, "labels": [{ "name": "region", "displayName": "Region", "displayValue": "EMEA" }] } }

metadados de tarefas do uip

Edite o título, a prioridade, o link do catálogo de uma tarefa e grave uma observação com a edição. Mesclações — apenas os sinalizadores que você passa mudam; é necessário pelo menos um.

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Opções

Long	Valor	Description
--title <title>	String	Novo título.
--priority <priority>	Low | Medium | High | Critical	Nova prioridade. Um valor fora do conjunto falha no lado do cliente, nomeando o conjunto válido.
--catalog-id <id>	Número inteiro	Associar um catálogo de tarefas. mutuamente exclusivo com --unset-catalog.
--unset-catalog	Bandeira	Remova a associação do catálogo da tarefa. mutuamente exclusivo com --catalog-id.
--note <text>	String	Comentário gravado ao lado da edição.

Exemplo

uip tasks metadata 123 --priority High --note "Escalated per manager request" --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskMetadataEdited", "Data": { "taskId": 123 } }

dados de tarefas do uip

Ler ou escrever o objeto de formulário/dados de negócios subjacente de uma tarefa.

dados de tarefas uip obtidos

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Exemplo

uip tasks data get 123 --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskData", "Data": { "invoiceNumber": "INV-001", "amount": 250.0 } }

salvamento de dados de tarefas uip

Argumentos

Name	Required	Finalidade
<task-id>	sim	ID da tarefa.

Opções

Long	Valor	Required	Description
--data <json>	JsonObject	sim	Dados da tarefa a serem salvos. Deve ser um objeto JSON (não um array ou escalar) — qualquer outra coisa falhará no lado do cliente.

Exemplo

uip tasks data save 123 --data '{"invoiceNumber":"INV-001","amount":250.0}' --folder-id 42

Formato dos dados (--output json)

{ "Code": "TaskDataSaved", "Data": { "taskId": 123 } }

Veja também

• Conceitos: como o UiPath CLI é organizado — onde as ferramentas se encaixam no modelo de host + ferramenta.
• Sessões — como o contexto do tenant é resolvido.
• uip or folders — encontre IDs/caminhos/chaves de pastas para as opções de escopo de pastas nesta página.
• uip login — sessão usada para todas as chamadas do Action Center.
• Opções globais
• Códigos de saída