UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

Recurso UIP

uip resource los recursos de Orchestrator de los que dependen las automatizaciones en runtime: activos, depósitos y archivos de depósito, bibliotecas, colas y artículos en cola, desencadenadores y webhooks. Es la superficie CRUD de propósito general sobre estas entidades, independiente de uip solution resource (que inspecciona las declaraciones de recursos de solución local) y de uip or (la herramienta de automatización de Orchestrator para trabajos, procesos, carpetas, etc.).

Nota:

El alias de la herramienta es resource (singular), no resources. Cada ejemplo utiliza uip resource <kind>.

uip resource lo proporciona el complemento @uipath/resource-tool . Si aún no está instalado, uip tools install resource lo añade. Consulta Herramientas (complementos).

Recursos

Cada recurso tiene su propia página de referencia. El verbo establecido en cada página coincide con los comandos registrados por uip resource — ejecuta uip resource --help para confirmar la superficie completa en tu instalación.

RecursoPropósito
ActivosValores de configuración con nombre (Texto, Bool, Entero, Credencial, Secreto) utilizados por las automatizaciones en runtime. Ámbito de carpeta.
DepósitosContenedores de almacenamiento para archivos utilizados por las automatizaciones. Ámbito de carpeta.
archivos-depósitoArchivos individuales dentro de un depósito. Enumerar, cargar, descargar, eliminar y obtener URL prefirmadas.
LibreríasPaquetes .nupkg reutilizables (actividades y lógica compartidas). Ámbito de tenant.
ColasContenedores para elementos de trabajo transaccionales. Ámbito de carpeta.
artículos en colaTransacciones individuales dentro de colas, con controles completos de máquina de estados. Ámbito de carpeta.
DesencadenadoresDesencadenadores de tiempo, cola y API que inician trabajos. Los desencadenadores de tiempo/cola tienen ámbito de carpeta; Los desencadenadores de API tienen ámbito de tenant.
WebhooksDevoluciones de llamada HTTP activadas en eventos de plataforma (finalización de trabajo, fallo de artículo en cola, …). Ámbito de tenant.

Sinopsis

uip resource <resource> <verb> [options]
uip resource <resource> <verb> [options]

La salida predeterminada es JSON. Cada subcomando respeta las opciones globales (--output, --output-filter, --log-level, --log-file) y devuelve los códigos de salida estándar.

Convenciones

  • Autenticación. Cada subcomando uip resource llama a Orchestrator. Ejecuta uip login primero, o pasa -t, --tenant <tenant-name> en cualquier subcomando para apuntar a un tenant específico dentro de tu organización autenticada.
  • Ámbito de carpeta. Los activos, depósitos, colas, artículos en cola y desencadenadores (tiempo/cola) tienen ámbito de carpeta. Proporcione --folder-path <path> por ejemplo "Shared") o --folder-key <guid> en list, create y llamadas relacionadas. get, update y delete se resuelven en varias carpetas por clave cuando es posible: la descripción de cada verbo en la página de recursos lo menciona explícitamente. Las bibliotecas, los desencadenadores de API y los webhooks tienen ámbito de tenant y no aceptan --folder-*.
  • Claves. La mayoría de los recursos se identifican por un GUID devuelto en la salida list (en key, identifier o, para artículos en cola, uniqueKey para un solo intento y key para la cadena de reintentos). Los campos numéricos id son internos y no deben pasarse a los comandos.
  • Paginación. Los verbos de lista aceptan -l, --limit <n>, --offset <n> y --order-by <field> (sintaxis de OData, p. ej. "Name asc"). El archivo de depósito list es la excepción y utiliza un continuationToken.
  • Filtrado. Cuando se admite, -n, --name <name> es una coincidencia de contenido en el nombre del recurso; algunos recursos añaden --enabled, --disabled, --status, etc.

Forma de datos

La salida correcta siempre sigue el sobre estándar:

{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}
{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}

Code por verbo se documenta en la página de recursos (AssetList, AssetCreated, BucketFile, QueueItemAdded, TriggerEnabled, WebhookPinged, etc.). Data es un único objeto (get, create, update) o una matriz (list, versions, event-types, history).

Los listados están actualmente abiertos : no incluyen un campo count o nextPage de nivel superior. El archivo de depósito list es la excepción; su carga útil incluye un continuationToken utilizado para la paginación.

Ejemplos resueltos

Enumerar colas en una carpeta

uip resource queues list --folder-path Shared
uip resource queues list --folder-path Shared

Crear un activo y luego compartirlo en todas las carpetas

uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production
uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production

Añadir artículos en cola de forma masiva desde un archivo JSON

ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json
ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json
  • uip solution deploy config link : vincula el recurso declarado de una solución a uno de los activos/colas/depósitos creados a través de uip resource.
  • uip solution resource list : inspecciona las declaraciones de recursos dentro de una solución local.
  • uip or : para carpetas, procesos, versiones, trabajos, máquinas, usuarios y almacenes de credenciales en los que a menudo necesitarás buscar claves al utilizar uip resource.

Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado