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

Syntax and options for `uip is connectors`, which browses the Integration Service connector catalog and inspects a connector's discovery metadata, schema, and audit history.

uip is connectors browses the Integration Service connector catalog — every integration the tenant can authenticate against (Salesforce, Slack, Zoho Desk, etc.) — and inspects one connector's discovery metadata, OpenAPI document, event operations, and audit history. It is read-only: none of these verbs create or change a connector. list caches its result per-tenant on disk; pass --refresh to force a fresh fetch. get and every other verb below always call the API directly and never touch that cache.

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.
metadataFetch a connector's discovery metadata (capability flags, tier, discovery type).
swaggerFetch the OpenAPI document for a connector element.
event-operationsList the event operations a connector element supports.
audit-logsList audit log entries for a connector element version.
exportExport a connector element's package to a local file.

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--filtertextCoincidencia 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

Return the full record for one connector by key. Always calls the API directly — not cached.

Argumentos

NombreObligatorioPropósito
<connector-key>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"
    }
  ]
}

Full field list (all returned): Id, Name, Key, AppName, Vendor, Description, Image, Active, HasEvents, HasCruds, HasMethods, HasHttpRequest, DapCompatible, Categories, Tags, DocumentationUrl. Description reads "No description" and DocumentationUrl reads "No documentation" when the catalog has nothing on file for that connector, rather than an empty string.

uip is connectors metadata

Fetch a connector's discovery metadata: capability flags (does it support events, CRUD, custom object/field discovery, …), tier, discovery type, and any tenant-specific feature flags.

Argumentos

NombreObligatorioPropósito
<connector-key>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:

The command exposes every boolean property the catalog returns for a connector, not just the fixed set shown above — a new capability flag added to the catalog appears here automatically, without waiting on a CLI release.

uip is connectors swagger

Fetch the OpenAPI (Swagger) document describing a connector element's operations.

Argumentos

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

Opciones

LargoValorDescripción
--versiontextElement version. Omit to use the connector's default/latest version.

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 is the raw OpenAPI document returned by the catalog — its shape follows the OpenAPI spec, not this CLI's usual PascalCase envelope conventions.

uip is connectors event-operations

List the event operations a connector element supports (the operations available to uip is triggers for that connector).

Argumentos

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

Opciones

LargoValorDescripción
--versiontextElement version. Omit to use the connector's default/latest version.

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" }
  ]
}

An empty result still succeeds, with Instructions: "No event operations found for connector '<connector-key>'.".

uip is connectors audit-logs

List audit log entries recorded for a connector element version (schema changes, publishes, and similar catalog-side events).

Argumentos

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

Opciones

LargoValorDescripción
--versiontextRequired. Element version to fetch audit logs for.
--limitNúmeroTamaño de la página.
--next-pageTokenCursor from a previous response, to fetch the next page.

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" }
  ]
}

An empty result still succeeds, with Instructions: "No audit logs found for connector '<connector-key>' version '<version>'.".

uip is connectors export

Export a connector element's package to a local file.

Argumentos

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

Opciones

LargoValorDescripción
--output-fileRutaRequired. Destination file path.
--versiontextElement version. Omit to use the connector's default/latest version.

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 echoes back whatever --version was passed (empty string if omitted) — it does not resolve to the actual exported version number.

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