- 概述
- 开始使用
- 概念
- 使用 UiPath CLI
- 操作指南
- CI/CD 方法
- 命令参考
- 迁移
- 参考与支持
用于使用“uip is”工具管理 Integration Service 中的连接器、连接、活动、资源和触发器的命令。
uip is is the Integration Service tool: it manages the connector platform that brokers OAuth connections to external SaaS and runs CRUD activities against them. The tool is organized around seven resources — connectors (the catalog), connections (OAuth sessions for an account), activities (per-connector operation definitions), resources (connector objects and their data-plane operations), triggers (event-driven connector operations), typecache (the Studio activity catalog, filtered by project type), and webhooks (webhook URLs for webhook-mode triggers). Install it with uip tools install is, or invoke uip is … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation. is is the command prefix; the underlying package is @uipath/integrationservice-tool.
大多数读取命令会在磁盘上缓存每个租户的响应,以保持交互式使用的响应能力;在任何缓存的命令上传递--refresh ,以强制执行新的提取。
资源
每个资源都有其自己的参考页面。每个页面上设置的动词与uip is注册的命令匹配 — 运行uip is --help以确认安装的完整表面。
| 资源 | 用途 |
|---|---|
| 连接器 | 连接器目录 — 租户可以访问的每个集成。 |
| 连接 | 连接器的租户端 OAuth 凭据/会话。 |
| 活动 | 连接器公开的操作( CreateTicket 、 ListAllRecords等)。 |
| 资源 | 带有describe和运行时run连接器对象(工单、联系人、文件)。 |
| 触发器 | 连接器可能触发的事件挂钩( CREATED 、 UPDATED 、 DELETED )。 |
| typecache | The Studio activity catalog, filtered by project type (for example Agent) — a separate source from the connector catalog above. |
| Webhooks | The webhook URL for a connector trigger running in webhook event mode. |
大纲
uip is <resource> <verb> [options]
uip is <resource> <verb> [options]
始终为uip is ,从不uip integration-service 。is是工具的命令前缀(请参阅uip tools list中的commandPrefix列)。
常用标志
一少量标志在资源动词中重复出现。无论它们出现在何处,它们的行为方式均相同:
| 标记 | 使用人 | 用途 |
|---|---|---|
--refresh | 缓存读取的动词( list 、 describe 、 get 、 objects ) | 强制从 API 重新获取并更新磁盘缓存。 |
--connection-id <id> | 许多动词 | 将请求限定在一个连接范围内。每个resources run动词需要;在元数据读取上为可选,使服务器可以包含自定义对象/字段。 |
每个资源页面上都记录了特定于动词的标志(筛选器、正文、查询参数)。
全局选项和退出代码
另请参阅
- 概念:UiPath CLI 的组织方式— 工具在“主机 + 工具”模型中的位置。
- 会话— 如何解析租户上下文。
- 配置— 影响每个工具的环境变量和配置文件。
uip login— 用于所有 Integration Service 调用的会话。