- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- codificador UIP
- Contextualização da uip
- Documento da UIP
- Função UIP
- Proteções da UIP
- configuração-llm-uip
- gateway-llm-uip
- hub de modelo da uip
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- obter-repositório-objeto-da-Biblioteca
- obter-objeto-repositório
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- instâncias-da-lista
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- Publicar
- Remoto
- restore
- executar, depurar e adicionar; Execução
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- TM
- UIA
- tarefas do UIP
- Traces da UIP
- Feedback de traces da uip
- Migração
- Referência e suporte
Sintaxe e opções para "uip is connectors", que navega no catálogo de conectores do Integration Service e inspeciona os metadados de descoberta de um conector, esquema e histórico de auditoria.
uip is connectors navega no catálogo de conectores do Integration Service — cada integração que o tenant pode autenticar (Salesforce, Slack, Zoho Desk etc.) — e inspeciona os metadados de descoberta de um conector, documento OpenAPI, operações de eventos e histórico de auditoria. É somente leitura: nenhum desses verbos cria ou altera um conector. list armazena em cache seu resultado por tenant no disco; passe --refresh para forçar uma nova busca. get e todos os outros verbos abaixo sempre chamam a API diretamente e nunca afetam esse cache.
Resumo
uip is connectors <verb> [options]
uip is connectors <verb> [options]
Verbo
| Texto | Finalidade |
|---|---|
list | Listar conectores disponíveis para o tenant; Opcionalmente, filtre por nome ou chave. |
get | Busca os detalhes completos de um conector por chave. |
metadata | Buscar os metadados de descoberta de um conector (sinalizadores de capacidade, nível, tipo de descoberta). |
swagger | Busque o documento da OpenAPI para um elemento conector. |
event-operations | Liste as operações de evento compatíveis com um elemento de conector. |
audit-logs | Listar entradas de log de auditoria para uma versão do elemento conector. |
export | Exporte o pacote de um elemento de conector para um arquivo local. |
uip é lista de conectores
Lista os conectores disponíveis para o tenant atual. Armazenado em cache por tenant no disco.
Opções
| Short | Long | Valor | Padrão | Description |
|---|---|---|---|---|
-f | --filter | text | — | Correspondência de substring com o nome ou a chave do conector. |
| — | --refresh | Bandeira | desativada | Força a nova busca da API, ignorando o cache. |
Exemplos
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}'
Formato dos dados (--output json)
{
"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"
}
]
}
Se nenhum conector corresponder, o comando é bem-sucedido com Code: "Message" e Data: { "Message": "No connectors found." }.
uip é conectores obter
Retorne o registro completo de um conector por chave. Sempre chama a API diretamente — não em cache.
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<connector-key> | sim | Chave de conector, por exemplo uipath-zoho-desk Encontre-o com connectors list. |
Opções
Nenhuma além das opções globais.
Exemplos
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}'
Formato dos dados (--output json)
{
"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 completa de campos (todos retornados): Id, Name, Key, AppName, Vendor, Description, Image, Active, HasEvents, HasCruds, HasMethods, HasHttpRequest, DapCompatible, Categories, Tags, DocumentationUrl. Description lê "No description" e DocumentationUrl lê "No documentation" quando o catálogo não tem nada registrado para esse conector, em vez de uma string vazia.
uip são metadados de conectores
Busque os metadados de descoberta de um conector: sinalizadores de recursos (ele é compatível com eventos, CRUD, descoberta de objetos/campos personalizados,…), nível, tipo de descoberta e quaisquer sinalizadores de funcionalidades específicas do tenant.
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<connector-key> | sim | Chave de conector, por exemplo uipath-salesforce-sfdc |
Opções
Nenhuma além das opções globais.
Exemplo
uip is connectors metadata uipath-salesforce-sfdc
uip is connectors metadata uipath-salesforce-sfdc
Formato dos dados (--output json)
{
"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": {}
}
]
}
O comando expõe cada propriedade booleana que o catálogo retorna para um conector, não apenas o conjunto fixo mostrado acima — um novo sinalizador de recurso adicionado ao catálogo aparece aqui automaticamente, sem esperar uma versão da CLI.
uip é swagger de conectores
Busque o documento do OpenAPI (Swagger) que descreve as operações de um elemento conector.
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<connector-key> | sim | Chave do conector. |
Opções
| Long | Valor | Description |
|---|---|---|
--version | text | Versão do elemento. Omita para usar a versão padrão/mais recente do conector. |
Exemplo
uip is connectors swagger uipath-zoho-desk
uip is connectors swagger uipath-zoho-desk
Formato dos dados (--output json)
{
"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 é o documento bruto do OpenAPI retornado pelo catálogo — sua forma segue a especificação do OpenAPI, não as convenções de envelope PascalCase usuais dessa CLI.
uip é operações de evento de conectores
Liste as operações de evento compatíveis com um elemento de conector (as operações disponíveis para uip is triggers para esse conector).
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<connector-key> | sim | Chave do conector. |
Opções
| Long | Valor | Description |
|---|---|---|
--version | text | Versão do elemento. Omita para usar a versão padrão/mais recente do conector. |
Exemplo
uip is connectors event-operations uipath-zoho-desk
uip is connectors event-operations uipath-zoho-desk
Formato dos dados (--output json)
{
"Code": "ElementEventOperationList",
"Data": [
{ "name": "CREATED", "displayName": "Created" }
]
}
{
"Code": "ElementEventOperationList",
"Data": [
{ "name": "CREATED", "displayName": "Created" }
]
}
Um resultado vazio ainda é bem-sucedido, com Instructions: "No event operations found for connector '<connector-key>'.".
uip é conectores de auditoria-logs
Liste entradas de log de auditoria gravadas para uma versão do elemento de conector (alterações de esquema, publicações e eventos semelhantes do lado do catálogo).
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<connector-key> | sim | Chave do conector. |
Opções
| Long | Valor | Description |
|---|---|---|
--version | text | Obrigatório. Versão do elemento para o qual buscar logs de auditoria. |
--limit | Número | Tamanho da página |
--next-page | token | Cursor de uma resposta anterior, para buscar a próxima página. |
Exemplo
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
Formato dos dados (--output json)
{
"Code": "ElementAuditLogList",
"Data": [
{ "changeType": "Updated", "user": "user@example.com" }
]
}
{
"Code": "ElementAuditLogList",
"Data": [
{ "changeType": "Updated", "user": "user@example.com" }
]
}
Um resultado vazio ainda é bem-sucedido, com Instructions: "No audit logs found for connector '<connector-key>' version '<version>'.".
uip é exportação de conectores
Exporte o pacote de um elemento de conector para um arquivo local.
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<connector-key> | sim | Chave do conector. |
Opções
| Long | Valor | Description |
|---|---|---|
--output-file | Path | Obrigatório. Caminho do arquivo de destino. |
--version | text | Versão do elemento. Omita para usar a versão padrão/mais recente do conector. |
Exemplo
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
Formato dos dados (--output json)
{
"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 retorna o --version passado (string vazia se omitido) — ele não resolve o número da versão exportada real.
Relacionado
uip is connections— crie sessões OAuth nos conectores descobertos aqui.uip is activities— lista as operações que um conector expõe.uip is resources— descreva e execute os objetos do plano de dados de um conector.uip is triggers— operações de conector orientadas por eventos, apoiados porevent-operationsacima.
Veja também
- Resumo
- Verbo
- uip é lista de conectores
- Opções
- Exemplos
- Formato dos dados (--output json)
- uip é conectores obter
- Argumentos
- Opções
- Exemplos
- Formato dos dados (--output json)
- uip são metadados de conectores
- Argumentos
- Opções
- Exemplo
- Formato dos dados (--output json)
- uip é swagger de conectores
- Argumentos
- Opções
- Exemplo
- Formato dos dados (--output json)
- uip é operações de evento de conectores
- Argumentos
- Opções
- Exemplo
- Formato dos dados (--output json)
- uip é conectores de auditoria-logs
- Argumentos
- Opções
- Exemplo
- Formato dos dados (--output json)
- uip é exportação de conectores
- Argumentos
- Opções
- Exemplo
- Formato dos dados (--output json)
- Relacionado
- Veja também