Tareas de UIP

Comandos para gestionar tareas, catálogos, comentarios, etiquetas, metadatos y datos de tareas de Action Center utilizando la herramienta "tareas de uip".

uip tasks las tareas de Action Center : los elementos de trabajo con intervención humana (relleno de formularios, aprobaciones, validación/clasificación de documentos, etiquetado de datos) que los procesos y agentes de RPA crean para que una persona los complete. La herramienta te permite enumerar e inspeccionar tareas, asignarlas o reasignarlas, completarlas con una acción y carga útil de datos, y gestionar los recursos auxiliares adjuntos a una tarea: catálogos (configuración de agrupación/retención), comentarios, etiquetas (tags), metadatos ( título/prioridad/enlace de catálogo) y el propio formulario/datos empresariales de la tarea. tasks es el prefijo del comando; el paquete subyacente es @uipath/tasks-tool.

Conceptos

• Ámbito de carpeta : cada verbo que opera en una tarea o catálogo específico acepta --folder-id <id>, --folder-path <path> o --folder-key <key> (mutuamente excluyentes; aplicado en tiempo de análisis a través de conflictos de Commander). Cuando no se pasa ninguno en un terminal interactivo, la CLI muestra un selector de carpetas; en una ejecución no interactiva (CI, agentes de codificación) falla rápidamente al pedir uno. uip tasks list y uip tasks get son las dos excepciones: una carpeta es opcional allí y simplemente reduce los resultados/búsqueda cuando se proporciona.
• Tipo de tarea : varios verbos (get --task-type, complete --type) toman uno de FormTask, ExternalTask, AppTask, DocumentValidationTask, DocumentClassificationTask, DataLabelingTask, QuickFormTask. Un valor no reconocido falla en el lado del cliente con la lista completa nombrada en el error.
• Paginación : verbos de estilo de lista (list, catalogs list, comments list, users) paginan internamente con un tamaño de página de 100 elementos y siguen nextCursor hasta que se agotan o se alcanza --limit , devolviendo una matriz plana de cualquier manera: no hay un marcador de cursor que gestionar tú mismo.
• Los catálogos son configuraciones de agrupación/retención opcionales para tareas : metadata --catalog-id vincula una tarea a una; Los campos de retención de catalogs create/update (--retention-action, --retention-period, --retention-bucket-id) controlan lo que sucede con los datos del catálogo a lo largo del tiempo. --encrypted en catalogs create es inmutable: no hay forma de cambiarlo a través de catalogs update.

Sinopsis

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 tareas de uip

Enumerar tareas en carpetas (o una carpeta, cuando esté en el ámbito).

Opciones

Largo	Valor	Descripción
--folder-id <id>	Entero	Filtrar por ID de carpeta.
--folder-path <path>	String	Filtrar por ruta de carpeta (alternativa --folder-id a).
--folder-key <key>	GUID	Filtrar por clave de carpeta (alternativa --folder-id a).
--as-admin	Marca	Enumerar tareas como administrador (visibilidad más amplia que tus propias tareas asignadas/disponibles).
-l, --limit <number>	Entero	Máximo de elementos a devolver. Obtiene todo (paginación interna) cuando se omite.

Ejemplo

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

Forma de datos (--json de salida)

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

obtener tareas de uip

Obtener detalles de una tarea por ID.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de la tarea. Usa tasks list para encontrar uno.

Opciones

Largo	Valor	Descripción
--task-type <type>	uno de los 7 tipos de tareas	Tipo de tarea. Requiere una opción de carpeta cuando se aprueba ; de lo contrario, falla rápidamente.
--folder-id <id> / --folder-path <path> / --folder-key <key>		Ámbito de la carpeta. Solo es necesario cuando se establece --task-type.

Ejemplo

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

Forma de datos (--json de salida)

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

Asignar/reasignar tareas de UIP

Asigne una tarea a un usuario o reasígnela a uno diferente: forma de opción idéntica, Code diferente en caso de éxito.

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Opciones

Largo	Valor	Obligatorio	Descripción
--user-id <id>	Entero	uno de estos dos	ID de usuario numérico del destinatario.
--user <email>	String	uno de estos dos	Nombre de usuario o correo electrónico del destinatario (alternativa a --user-id).

Pasar ninguno falla con un explícito "asignado que falta" error.

Ejemplo

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

Forma de datos (--json de salida)

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

Code es TaskReassigned para reassign.

desasignar tareas de uip

Eliminar al asignado de una tarea. No hay opciones más allá del ID de la tarea.

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Ejemplo

uip tasks unassign 123

Forma de datos (--json de salida)

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

Tareas de UIP completadas

Completa una tarea con una acción y una carga útil de datos opcional.

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Opciones

Largo	Valor	Obligatorio	Descripción
--type <type>	uno de los 7 tipos de tareas	Sí	Tipo de tarea: validado del lado del cliente contra el enum.
--data <json>	JSON	No	Carga útil de datos de la tarea como cadena JSON.
--action <action>	String	condicionalmente	Nombre de la acción. Obligatorio en la práctica para FormTask y AppTask (no se aplica en el lado del cliente: la plataforma rechaza una acción faltante para esos tipos).
Opciones de carpeta		No	Una carpeta se resuelve (de forma interactiva si se omite, en un TTY) antes de completarse.

Ejemplo

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

Forma de datos (--json de salida)

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

Usuarios de tareas de UIP

Enumerar usuarios con permisos de tareas en una carpeta: el origen de los valores --user-id/--user en assign/reassign.

Argumentos

Nombre	Obligatorio	Propósito
[folder-id]	No	ID de carpeta como argumento posicional. Mutuamente exclusivo con --folder-path/--folder-key: pasar ambos falla explícitamente.

Opciones

Largo	Valor	Descripción
--folder-path <path>	String	Ruta de la carpeta (alternativa al argumento posicional).
--folder-key <key>	GUID	Clave de carpeta (alternativa al argumento posicional).
-l, --limit <number>	Entero	Máximo de elementos a devolver.

Ejemplo

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

Forma de datos (--json de salida)

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

catálogos de tareas de UIP

Gestionar catálogos de tareas: agrupaciones de tareas con nombre con cifrado opcional y política de retención.

lista de catálogos de tareas de uip

Opciones

Largo	Valor	Descripción
Opciones de carpeta		Carpeta en la que enumerar los catálogos (se resuelve una carpeta si se omite, según Conceptos).
-l, --limit <number>	Entero	Máximo de elementos a devolver.

Ejemplo

uip tasks catalogs list --folder-id 42

Forma de datos (--json de salida)

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

los catálogos de tareas de uip obtienen

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID del catálogo de tareas.

Ejemplo

uip tasks catalogs get 5 --folder-id 42

Forma de datos (--json de salida)

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

creación de catálogos de tareas de uip

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre del catálogo.
--description <text>	String	No	Descripción del catálogo.
--encrypted	Marca	No	Cifrar los datos de la tarea en este catálogo. Inmutable : no se puede cambiar catalogs update más tarde.
--retention-action <action>	Delete | Archive	No	Qué sucede en el límite de retención. Cualquier otro valor falla en el lado del cliente.
--retention-period <days>	Entero	No	Período de retención en días.
--retention-bucket-id <id>	Entero	No	ID de depósito de almacenamiento, utilizado cuando --retention-action Archive.

Ejemplo

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

Forma de datos (--json de salida)

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

actualización de catálogos de tareas de uip

Fusiones: solo cambian los marcadores que pasas. Se requiere al menos uno de --name/--description/--retention-action/--retention-period/--retention-bucket-id; llamar con none falla antes de cualquier acceso a archivos/red. --encrypted no se puede cambiar aquí.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID del catálogo de tareas.

Opciones

El mismo conjunto que create menos --encrypted.

Ejemplo

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

Forma de datos (--json de salida)

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

Comentarios de tareas de UIP

lista de comentarios de tareas de uip

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Opciones

Largo	Valor	Descripción
-l, --limit <number>	Entero	Máximo de elementos a devolver.
Opciones de carpeta		Carpeta en la que se encuentra la tarea.

Ejemplo

uip tasks comments list 123 --folder-id 42

Forma de datos (--json de salida)

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

agregar comentarios de tareas uip

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Opciones

Largo	Valor	Obligatorio	Descripción
--text <text>	String	Sí	Texto de comentario. Se ha rechazado la cadena vacía.
Opciones de carpeta		No	Carpeta en la que se encuentra la tarea.

Ejemplo

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

Forma de datos (--json de salida)

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

etiquetas de tareas de UIP

Establecer o borrar las etiquetas en una tarea en una llamada: se trata de una sustitución completa, no de una fusión; pasar cada etiqueta que quieras conservar.

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Opciones

Largo	Valor	Obligatorio	Descripción
--labels <json>	MatrizJson	Sí	Etiquetas para establecer, por ejemplo [{"name":"region","displayName":"Region","displayValue":"EMEA"}]. Pulse [] para borrar todas las etiquetas. Debe ser una matriz JSON: un valor que no sea de matriz falla en el lado del cliente.
Opciones de carpeta		No	Carpeta en la que se encuentra la tarea.

Ejemplo

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

Forma de datos (--json de salida)

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

metadatos de tareas de UIP

Edita el título, la prioridad y el enlace del catálogo de una tarea, y graba una nota con la edición. Fusiones: solo cambian los marcadores que pasas; se requiere al menos uno.

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Opciones

Largo	Valor	Descripción
--title <title>	String	Nuevo título.
--priority <priority>	Low | Medium | High | Critical	Nueva prioridad. Un valor fuera de conjunto falla en el lado del cliente, nombrando el conjunto válido.
--catalog-id <id>	Entero	Asociar un catálogo de tareas. Mutuamente exclusivo con --unset-catalog.
--unset-catalog	Marca	Elimina la asociación del catálogo de la tarea. Mutuamente exclusivo con --catalog-id.
--note <text>	String	Comentario grabado junto con la edición.

Ejemplo

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

Forma de datos (--json de salida)

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

datos de tareas de uip

Leer o escribir el formulario subyacente/objeto de datos empresariales de una tarea.

Obtener datos de tareas de uip

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Ejemplo

uip tasks data get 123 --folder-id 42

Forma de datos (--json de salida)

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

Guardar datos de tareas UIP

Argumentos

Nombre	Obligatorio	Propósito
<task-id>	Sí	ID de la tarea.

Opciones

Largo	Valor	Obligatorio	Descripción
--data <json>	ObjetoJson	Sí	Datos de la tarea que se van a guardar. Debe ser un objeto JSON (no una matriz o escalar); cualquier otra cosa falla en el lado del cliente.

Ejemplo

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

Forma de datos (--json de salida)

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

Ver también

• Conceptos: cómo se organiza UiPath CLI : dónde encajan las herramientas en el modelo host + herramienta.
• Sesiones : cómo se resuelve el contexto del tenant.
• uip or folders : busca los ID/rutas/claves de carpeta para las opciones de ámbito de carpeta en esta página.
• uip login — sesión utilizada para todas las llamadas de Action Center.
• Opciones globales
• Códigos de salida