uip 为连接器

“uip is 连接器”的语法和选项，可浏览 Integration Service 连接器目录，并检查连接器的发现元数据、架构和审核历史记录。

uip is connectors 用于浏览 Integration Service 连接器目录（租户可以对其进行身份验证的每个集成（Salesforce、Slack 和 Zoho Desk 等）），并检查一个连接器的发现元数据、OpenAPI 文档、事件操作和审核历史记录。它是只读的：这些动词都不会创建或更改连接器。list 在磁盘上每个租户缓存其结果；传递 --refresh 以强制执行新的提取。get 以及以下所有其他动词始终直接调用 API，从不接触该缓存。

大纲

uip is connectors <verb> [options]

动词

动词	用途
list	列出租户可用的连接器；可选择按名称或键进行筛选。
get	按键获取一个连接器的完整详细信息。
metadata	获取连接器的发现元数据（功能标志、层级、发现类型）。
swagger	获取连接器元素的 OpenAPI 文档。
event-operations	列出连接器元素支持的事件操作。
audit-logs	列出连接器元素版本的审核日志条目。
export	将连接器元素的包导出到本地文件。

uip 是连接器列表

列出当前租户可用的连接器。在磁盘上按租户缓存。

选项

短	长	值	默认	描述
-f	--filter	text	—	子字符串与连接器名称或键匹配。
—	--refresh	标记	关闭	强制从 API 重新获取，忽略缓存。

示例

uip is connectors list

uip is connectors list --filter zoho

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

数据形状（--输出 json）

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

如果没有匹配的连接器，则该命令将与Code: "Message"和Data: { "Message": "No connectors found." }一起成功。

UIP 是连接器获取

按键返回一个连接器的完整记录。始终直接调用 API — 不缓存。

参数

名称	必填	用途
<connector-key>	是	连接器键，例如uipath-zoho-desk 。使用connectors list查找。

选项

除全局选项外无其他选项。

示例

uip is connectors get uipath-zoho-desk

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

数据形状（--输出 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"
    }
  ]
}

完整字段列表(返回全部字段)：Id、Name、Key、AppName、Vendor、Description、Image、Active、HasEvents、HasCruds、HasMethods、HasHttpRequest、DapCompatible、Categories、Tags、DocumentationUrl。当目录未记录该连接器的任何内容而非空字符串时，Description 读取 "No description"，且 DocumentationUrl 读取 "No documentation"。

uip 是连接器元数据

获取连接器的发现元数据：功能标志（是否支持事件、CRUD、自定义对象/字段发现等）、层级、发现类型和任何特定于租户的功能标志。

参数

名称	必填	用途
<connector-key>	是	连接器键，例如uipath-salesforce-sfdc 。

选项

除全局选项外无其他选项。

示例

uip is connectors metadata uipath-salesforce-sfdc

数据形状（--输出 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": {}
    }
  ]
}

备注：

此命令会公开目录为连接器返回的每个布尔属性，而不仅仅是上面显示的固定集。添加到目录中的新功能标志会自动显示在此处，无需等待 CLI 发布。

uip 是连接器 Swagger

获取描述连接器元素操作的 OpenAPI (Swagger) 文档。

参数

名称	必填	用途
<connector-key>	是	连接器密钥。

选项

长	值	描述
--version	text	元素版本。省略操作，以使用连接器的默认/最新版本。

示例

uip is connectors swagger uipath-zoho-desk

数据形状（--输出 json）

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

Data 是目录返回的原始 OpenAPI 文档 — 其形式遵循 OpenAPI 规范，而不遵循此 CLI 的常规帕斯卡信封约定。

uip 是连接器事件操作

列出连接器元素支持的事件操作（该连接器上uip is triggers可以使用的操作）。

参数

名称	必填	用途
<connector-key>	是	连接器密钥。

选项

长	值	描述
--version	text	元素版本。省略操作，以使用连接器的默认/最新版本。

示例

uip is connectors event-operations uipath-zoho-desk

数据形状（--输出 json）

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

如果使用 Instructions: "No event operations found for connector '<connector-key>'."，空结果仍会成功。

uip 是连接器审核日志

列出为连接器元素版本（架构更改、发布和类似的目录端事件）记录的审核日志条目。

参数

名称	必填	用途
<connector-key>	是	连接器密钥。

选项

长	值	描述
--version	text	必需。要为其获取审核日志的元素版本。
--limit	数字	页面大小。
--next-page	令牌	光标来自上一个响应，以获取下一页。

示例

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

数据形状（--输出 json）

{
  "Code": "ElementAuditLogList",
  "Data": [
    { "changeType": "Updated", "user": "[e-mail]" }
  ]
}

如果使用 Instructions: "No audit logs found for connector '<connector-key>' version '<version>'."，空结果仍会成功。

UIP 为连接器导出

将连接器元素的包导出到本地文件。

参数

名称	必填	用途
<connector-key>	是	连接器密钥。

选项

长	值	描述
--output-file	路径	必需。目标文件路径。
--version	text	元素版本。省略操作，以使用连接器的默认/最新版本。

示例

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

数据形状（--输出 json）

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

Version 会回显传递的任何 --version（如果省略，则为空字符串）— 它不会解析为实际导出的版本号。

相关内容

• uip is connections — 针对此处发现的连接器创建 OAuth 会话。
• uip is activities — 列出连接器公开的操作。
• uip is resources — 描述和运行连接器的数据平面对象。
• uip is triggers — 事件驱动的连接器操作，由上述event-operations支持。

另请参阅

• Integration Service 工具概述
• 全局选项
• 退出代码