APIs

Las API te permiten acceder e interactuar con los servicios ofrecidos en el menú Gestionar paquetes. Puedes utilizar estas API al diseñar automatizaciones. Visita Automatizaciones codificadas para obtener más información sobre las automatizaciones codificadas y cómo diseñarlas utilizando API.

Nota: Al utilizar Ir a definición (F12), puedes acceder a la definición de las API de UiPath para un determinado servicio. Recomendamos confiar solo en las API expuestas directamente al implementar automatizaciones codificadas. Otras API que no estén expuestas directamente a un servicio serán sujeto de cambios sin notificación previa.

Sobrecargas

Las API tienen sobrecargas con frecuencia, lo que significa que proporcionan varias versiones del mismo método con diferentes opciones de parámetros. Las sobrecargas te permiten personalizar el comportamiento de la API en función de tus requisitos específicos. Por ejemplo, una API de automatización de IU puede tener una sobrecarga que acepte un parámetro de tiempo de espera para especificar el tiempo máximo de espera para que aparezca un elemento de IU antes de finalizar la ejecución.

Al utilizar las API con sus respectivas sobrecargas, puedes lograr fácilmente la lógica y el comportamiento de automatización deseados.

API del sistema

API	Descripción
Añadir fila de datos	Agrega una FilaDeDatos a una TablaDeDatos especificada.
AddQueueItem	Agrega un nuevo elemento en una cola de Orchestrator.
Añadir elemento de transacción	Agrega un nuevo elemento a la cola e inicia una transacción.
Anexar línea	Añade la cadena especificada a un archivo, creando el archivo si aún no existe.
BulkAddQueueItems	Agrega una colección de elementos de un DataTable especificado a una cola especificada en Orchestrator.
Borrar tabla de datos	Borra todos los datos de la TablaDeDatos especificada.
ComprimirArchivosZip	Agrega los archivos o carpetas especificados a un archivo comprimido (zip).
Copiar archivo	Copia un archivo desde una ubicación especificada a otra.
Crear archivo	Crea un archivo vacío en la ubicación especificada. Si ya existe un archivo en esa ubicación,
Crear carpeta	Crea una carpeta en la ubicación especificada.
Eliminar archivo o carpeta	Elimina un archivo o carpeta especificados.
Eliminar elementos de la cola	Te permite eliminar elementos con el estado Nuevo de una cola de Orchestrator especificada.
Eliminar archivo de almacenamiento	Elimina un archivo de un Depósito de almacenamiento especificado en Orchestrator.
Descargar archivo de almacenamiento	Descarga una copia de un archivo en un depósito de almacenamiento de Orchestrator de forma local.
ExtraerDescomprimir	Extrae todos los contenidos de una archivo zip en una carpeta especificada.
Filtrar tabla de datos	Filtra una TablaDeDatos especificando las condiciones en el widget Filtro.
Obtener activo	Obtiene un activo de Orchestrator especificado mediante el NombreDeActivoproporcionado.
Obtener credencial	Obtiene un activo de credenciales especificado utilizando un nombre de activo proporcionado.
GetJobs	Recupera una lista de trabajos de Orchestrator de acuerdo con un filtro personalizado, utilizando la API de Orchestrator.
Obtener elemento de la cola	El método obtiene un elemento de la cola para que puedas procesarlo (iniciar la transacción) y establece su estado en En curso.
GetQueueItems	Te permite recuperar una lista de hasta 100 transacciones de una cola de Orchestrator indicada, de acuerdo con múltiples filtros, como la fecha de creación, la prioridad, el estado y la referencia.
Obtener recurso para ruta local	Cree un recurso a partir de la ruta local del archivo o carpeta.
Obtener elemento de fila	Recupera un valor de una fila de una TablaDeDatos de acuerdo con una columna especificada.
Obtener elemento de transacción	Obtiene un elemento de la cola de Orchestrator para que pueda procesarlo (iniciar la transacción) y establece su estado en En curso.
Invocar proceso	Ejecuta un proceso de UiPath que está disponible para la máquina local.
Unir tablas de datos	Combina filas de dos tablas mediante valores comunes entre sí, de acuerdo con una regla de unión, que se especifica en el parámetro JoinType .
Enumerar archivos de almacenamiento	Enumera archivos que coinciden con un patrón determinado desde un Depósito de almacenamiento especificado en Orchestrator.
Buscar tabla de datos	Este método emula el comportamiento de la fórmula de Excel de BUSCARV. Te permite buscar un valor proporcionado en un DataTable especificado y devuelve el RowIndex en el que se encontró.
Fusionar tabla de datos	Combina el destino con el origen, indicando si se deben conservar los cambios y cómo gestionar esquemas faltantes en el origen.
Mover archivo	Mueve un archivo de una ubicación especificada a otra.
Solicitud HTTP de Orchestrator	Realiza solicitudes HTTP a la API de Orchestrator mediante la autenticación bajo el robot en el que se ejecuta.
OutputDataTable	Escribe una TablaDeDatos en una cadena usando el formato CSV.
Ruta existente	Comprueba si existe la ruta especificada. La ruta puede representar una ruta de archivo o una ruta de directorio.
Posponer elemento de la transacción	Añade parámetros de tiempo entre los que se debe procesar una transacción de Orchestrator (no antes de Posponer ni después de la Fecha límite).
Leer texto de almacenamiento	Descarga un archivo desde un Depósito de almacenamiento especificado en Orchestrator y lo almacena en una variable de cadena.
Leer archivo de texto	Lee todos los caracteres de un archivo especificado y lo guarda en una variable de cadena.
Quitar columna de datos	Elimina una ColumnaDeDatos de una TablaDeDatos especificada.
Quitar filas duplicadas	Elimina las filas duplicadas de una variable DataTable especificada y mantiene solo la primera repetición.
Reemplazar	Dentro de una cadena de entrada especificada, reemplaza las cadenas que coinciden con un patrón de expresión regular con una cadena de reemplazo especificada.
Establecer activo	Te permite actualizar el valor de un activo indicado, que ya está disponible en Orchestrator, ya sea un activo global o por robot.
Establecer credencial	Te permite actualizar el valor de un activo de credenciales indicado que ya está disponible en Orchestrator, ya sea un activo global o un activo por robot.
SetTransactionProgress	Te ayuda a crear estados de progreso personalizados para tus transacciones de Orchestrator en curso.
Establecer estado de la transacción	Establece el estado de un elemento de transacción de Orchestrator en Error o Correcto.
Ordenar tabla de datos	Ordena toda una DataTable por orden ascendente o descendente en función de los valores de una columna específica.
Iniciar trabajo	Te permite iniciar un trabajo en Orchestrator en un número especificado de UiPath Robots.
Detener trabajo	Le permite detener o eliminar un trabajo en Orchestrator.
Actualizar un elemento de la fila	Asigna un valor especificado a la columna indicada de una fila de TablaDeDatos.
Cargar archivo de almacenamiento	Carga un archivo en un Depósito de almacenamiento especificado en Orchestrator.
Esperar a elemento de la cola	Recupera un elemento de la cola de Orchestrator de una cola especificada y lo almacena en una variable QueueItem .
Escribir texto de almacenamiento	Carga una cadena en un Depósito de almacenamiento especificado en Orchestrator.
Escribir archivo de texto	Escribe el texto especificado en un archivo. Si el archivo ya existe, se sobreescribe el texto preexistente.

Uso de API

Utiliza el siguiente formato para llamar a una API desde el servicio correspondiente: service.API. Por ejemplo, system.GetAsset.