UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
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.

UIP es conectores

Sintaxis y opciones para `uip is connectors`, que explora el catálogo de conectores de Integration Service e inspecciona los metadatos de descubrimiento, el esquema y el historial de auditoría de un conector.

uip is connectors navega por el catálogo de conectores de Integration Service (cada integración en la que el tenant puede autenticarse (Salesforce, Slack, Zoho Desk, etc.)) e inspecciona los metadatos de descubrimiento de un conector, el documento OpenAPI, las operaciones de eventos y el historial de auditoría. Es de solo lectura: ninguno de estos verbos crea o cambia un conector. list almacena en caché su resultado por tenant en el disco; introduzca --refresh para forzar una nueva obtención. get y todos los demás verbos siguientes siempre llaman a la API directamente y nunca tocan esa caché.

Sinopsis​

uip is connectors <verb> [options]
uip is connectors <verb> [options]

Verbos​

VerboPropósito
listEnumerar los conectores disponibles para el tenant; filtrar opcionalmente por nombre o clave.
getObtener detalles completos para un conector por clave.
metadataObtener los metadatos de descubrimiento de un conector (marcadores de capacidad, nivel, tipo de descubrimiento).
swaggerObtener el documento OpenAPI para un elemento de conector.
event-operationsEnumera las operaciones de eventos que admite un elemento conector.
audit-logsEnumerar las entradas de registro de auditoría para una versión de elemento de conector.
exportExporta un paquete de elementos de conector a un archivo local.

uip es la lista de conectores​

Enumera los conectores disponibles para el tenant actual. En caché por tenant en el disco.

Opciones​

CortoLargoValorPredeterminadoDescripción
-f--filtertext—Coincidencia de subcadena con el nombre o la clave del conector.
—--refreshMarcaDesactivadoFuerza la nueva recuperación desde la API, ignorando la caché.

Ejemplos​

uip is connectors list

uip is connectors list --filter zoho

uip is connectors list --filter slack \
    --output-filter 'Data[].{name:Name, key:Key}'
uip is connectors list

uip is connectors list --filter zoho

uip is connectors list --filter slack \
    --output-filter 'Data[].{name:Name, key:Key}'

Forma de datos (--json de salida)​

{
  "Code": "ConnectorList",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "Vendor": "",
      "Active": "No",
      "CatalogActive": "No",
      "Version": "",
      "Stage": "",
      "DapCompatible": "No"
    }
  ]
}
{
  "Code": "ConnectorList",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "Vendor": "",
      "Active": "No",
      "CatalogActive": "No",
      "Version": "",
      "Stage": "",
      "DapCompatible": "No"
    }
  ]
}

Si no coincide ningún conector, el comando tiene éxito con Code: "Message" y Data: { "Message": "No connectors found." }.

uip es obtener conectores​

Devuelve el registro completo para un conector por clave. Siempre llama a la API directamente, no en caché.

Argumentos​

NombreObligatorioPropósito
<connector-key>SíClave del conector, por ejemplo uipath-zoho-desk. Encuéntralo con connectors list.

Opciones​

Ninguno más allá de las opciones globales.

Ejemplos​

uip is connectors get uipath-zoho-desk

uip is connectors get uipath-zoho-desk \
    --output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'
uip is connectors get uipath-zoho-desk

uip is connectors get uipath-zoho-desk \
    --output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'

Forma de datos (--json de salida)​

{
  "Code": "Connector",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "AppName": "",
      "Vendor": "",
      "Description": "Zoho Desk streamlines customer service, boosts agent efficiency and deliver lasting customer experiences",
      "Image": "https://example.com/zoho-desk/image",
      "Active": "No",
      "HasEvents": "Yes",
      "HasCruds": "No",
      "HasMethods": "No",
      "HasHttpRequest": "Yes",
      "DapCompatible": "No",
      "Categories": "IT and help desk",
      "Tags": "Service desk, Agents, Tickets",
      "DocumentationUrl": "No documentation"
    }
  ]
}
{
  "Code": "Connector",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "AppName": "",
      "Vendor": "",
      "Description": "Zoho Desk streamlines customer service, boosts agent efficiency and deliver lasting customer experiences",
      "Image": "https://example.com/zoho-desk/image",
      "Active": "No",
      "HasEvents": "Yes",
      "HasCruds": "No",
      "HasMethods": "No",
      "HasHttpRequest": "Yes",
      "DapCompatible": "No",
      "Categories": "IT and help desk",
      "Tags": "Service desk, Agents, Tickets",
      "DocumentationUrl": "No documentation"
    }
  ]
}

Lista de campos completa (todos devueltos): Id, Name, Key, AppName, Vendor, Description, Image, Active, HasEvents, HasCruds, HasMethods, HasHttpRequest, DapCompatible, Categories, Tags, DocumentationUrl. Description lee "No description" y DocumentationUrl lee "No documentation" cuando el catálogo no tiene nada en el archivo para ese conector, en lugar de una cadena vacía.

uip son los metadatos de los conectores​

Obtener los metadatos de descubrimiento de un conector: marcadores de capacidad (admite eventos, CRUD, descubrimiento de objetos/campos personalizados, …), nivel, tipo de descubrimiento y cualquier marcador de característica específico del tenant.

Argumentos​

NombreObligatorioPropósito
<connector-key>SíClave del conector, por ejemplo uipath-salesforce-sfdc.

Opciones​

Ninguno más allá de las opciones globales.

Ejemplo​

uip is connectors metadata uipath-salesforce-sfdc
uip is connectors metadata uipath-salesforce-sfdc

Forma de datos (--json de salida)​

{
  "Code": "ConnectorMetadata",
  "Data": [
    {
      "Key": "uipath-salesforce-sfdc",
      "Name": "Salesforce",
      "Description": "CRM",
      "Vendor": "Salesforce",
      "Version": "1.0.0",
      "DiscoveryType": "dynamic",
      "Tier": "1",
      "IsActive": true,
      "IsPrivate": false,
      "IsOwner": true,
      "HasEvents": true,
      "HasCRUDs": true,
      "HasMethods": false,
      "HasSearchMethods": false,
      "HasHttpRequest": true,
      "HasExtensions": false,
      "HasObjectDiscovery": true,
      "HasFieldDiscovery": true,
      "HasCustomObjectDiscovery": true,
      "HasCustomFieldDiscovery": true,
      "DapCompatible": true,
      "UnifiedTypesCompatible": false,
      "HideActivities": false,
      "ShouldLocaliseOnlyCurated": false,
      "Flags": {}
    }
  ]
}
{
  "Code": "ConnectorMetadata",
  "Data": [
    {
      "Key": "uipath-salesforce-sfdc",
      "Name": "Salesforce",
      "Description": "CRM",
      "Vendor": "Salesforce",
      "Version": "1.0.0",
      "DiscoveryType": "dynamic",
      "Tier": "1",
      "IsActive": true,
      "IsPrivate": false,
      "IsOwner": true,
      "HasEvents": true,
      "HasCRUDs": true,
      "HasMethods": false,
      "HasSearchMethods": false,
      "HasHttpRequest": true,
      "HasExtensions": false,
      "HasObjectDiscovery": true,
      "HasFieldDiscovery": true,
      "HasCustomObjectDiscovery": true,
      "HasCustomFieldDiscovery": true,
      "DapCompatible": true,
      "UnifiedTypesCompatible": false,
      "HideActivities": false,
      "ShouldLocaliseOnlyCurated": false,
      "Flags": {}
    }
  ]
}
Nota:

El comando expone cada propiedad booleana que el catálogo devuelve para un conector, no solo el conjunto fijo que se muestra arriba: aquí aparece automáticamente un nuevo marcador de capacidad añadido al catálogo, sin esperar una versión CLI.

uip es conectores swagger​

Obtener el documento OpenAPI (Swagger) que describe las operaciones de un elemento del conector.

Argumentos​

NombreObligatorioPropósito
<connector-key>SíClave del conector.

Opciones​

LargoValorDescripción
--versiontextVersión del elemento. Omite utilizar la versión predeterminada/más reciente del conector.

Ejemplo​

uip is connectors swagger uipath-zoho-desk
uip is connectors swagger uipath-zoho-desk

Forma de datos (--json de salida)​

{
  "Code": "ElementSwagger",
  "Data": {
    "openapi": "3.0.1",
    "info": {
      "title": "Zoho Desk",
      "version": "1.0.0"
    }
  }
}
{
  "Code": "ElementSwagger",
  "Data": {
    "openapi": "3.0.1",
    "info": {
      "title": "Zoho Desk",
      "version": "1.0.0"
    }
  }
}

Data es el documento OpenAPI sin formato devuelto por el catálogo: su forma sigue la especificación OpenAPI, no las convenciones de sobre PascalCase habituales de esta CLI.

UIP es operaciones de evento de conectores​

Enumera las operaciones de eventos que admite un elemento de conector (las operaciones disponibles para uip is triggers para ese conector).

Argumentos​

NombreObligatorioPropósito
<connector-key>SíClave del conector.

Opciones​

LargoValorDescripción
--versiontextVersión del elemento. Omite utilizar la versión predeterminada/más reciente del conector.

Ejemplo​

uip is connectors event-operations uipath-zoho-desk
uip is connectors event-operations uipath-zoho-desk

Forma de datos (--json de salida)​

{
  "Code": "ElementEventOperationList",
  "Data": [
    { "name": "CREATED", "displayName": "Created" }
  ]
}
{
  "Code": "ElementEventOperationList",
  "Data": [
    { "name": "CREATED", "displayName": "Created" }
  ]
}

Un resultado vacío sigue teniendo éxito, con Instructions: "No event operations found for connector '<connector-key>'.".

UIP son los registros de auditoría de los conectores​

Enumera las entradas del registro de auditoría registradas para una versión de elemento del conector (cambios de esquema, publicaciones y eventos similares del catálogo).

Argumentos​

NombreObligatorioPropósito
<connector-key>SíClave del conector.

Opciones​

LargoValorDescripción
--versiontextObligatorio. Versión del elemento para el que obtener registros de auditoría.
--limitNúmeroTamaño de la página.
--next-pageTokenCursor de una respuesta anterior, para recuperar la página siguiente.

Ejemplo​

uip is connectors audit-logs uipath-zoho-desk --version 1.0.0 --limit 50
uip is connectors audit-logs uipath-zoho-desk --version 1.0.0 --limit 50

Forma de datos (--json de salida)​

{
  "Code": "ElementAuditLogList",
  "Data": [
    { "changeType": "Updated", "user": "user@example.com" }
  ]
}
{
  "Code": "ElementAuditLogList",
  "Data": [
    { "changeType": "Updated", "user": "user@example.com" }
  ]
}

Un resultado vacío sigue teniendo éxito, con Instructions: "No audit logs found for connector '<connector-key>' version '<version>'.".

UIP es exportación de conectores​

Exporta un paquete de elementos de conector a un archivo local.

Argumentos​

NombreObligatorioPropósito
<connector-key>SíClave del conector.

Opciones​

LargoValorDescripción
--output-fileRutaObligatorio. Ruta del archivo de destino.
--versiontextVersión del elemento. Omite utilizar la versión predeterminada/más reciente del conector.

Ejemplo​

uip is connectors export uipath-zoho-desk --output-file ./uipath-zoho-desk.zip
uip is connectors export uipath-zoho-desk --output-file ./uipath-zoho-desk.zip

Forma de datos (--json de salida)​

{
  "Code": "ElementExported",
  "Data": {
    "ConnectorKey": "uipath-zoho-desk",
    "Version": "",
    "OutputFile": "/work/uipath-zoho-desk.zip",
    "Bytes": 1024
  }
}
{
  "Code": "ElementExported",
  "Data": {
    "ConnectorKey": "uipath-zoho-desk",
    "Version": "",
    "OutputFile": "/work/uipath-zoho-desk.zip",
    "Bytes": 1024
  }
}

Version devuelve lo que --version se haya pasado (cadena vacía si se omite): no se resuelve en el número de versión exportado real.

  • uip is connections : crea sesiones OAuth para los conectores descubiertos aquí.
  • uip is activities : enumera las operaciones que expone un conector.
  • uip is resources : describe y ejecuta los objetos del plano de datos de un conector.
  • uip is triggers : operaciones de conector impulsadas por eventos, respaldadas por event-operations anterior.

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