uip 为资源

“uip 是资源”的语法和选项，用于列出、描述连接器数据平面对象并从中执行。

uip is resources适用于连接器处理的运行时对象 - 工单、联系人、记录、文件。list枚举连接器的对象， describe返回一个对象的字段架构和操作， execute针对连接调用连接器的数据平面（创建/列出/获取/更新/替换/删除）。每个execute动词都需要--connection-id ；缓存的元数据读取（ list 、 describe ）时，请选择是否接受它以显示自定义对象/字段。

大纲

uip is resources <verb> [options]

动词

动词	用途
list	列出连接器上的可用对象；可选择按操作筛选。
describe	描述一个对象的操作和字段架构。
execute	调用连接器的数据平面（创建/列出/获取/更新/替换/删除）。

uip 是资源列表

列出连接器上的可用对象。结果取决于是否提供--connection-id — 连接作用域列表包括自定义对象；无作用域列表则不需要（在这种情况下，CLI 显示Warning ）。

参数

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

选项

短	长	值	默认	描述
—	--operation	枚举	—	按操作筛选： List 、 Retrieve 、 Create 、 Update 、 Delete 、 Replace 。
—	--connection-id	id	—	作用域到特定连接（启用自定义对象）。
-t	--tenant	name	会话默认值	覆盖租户。
—	--refresh	标记	关闭	强制从 API 重新获取，忽略缓存。

示例

uip is resources list uipath-zoho-desk

# Only objects that support a Create operation
uip is resources list uipath-zoho-desk --operation Create

# Connection-scoped listing — includes custom objects
uip is resources list uipath-zoho-desk \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

数据形状（--输出 json）

{
  "Code": "ResourceList",
  "Data": [
    {
      "Name": "tickets",
      "DisplayName": "Tickets",
      "Path": "/tickets",
      "Type": "standard",
      "SubType": "standard",
      "Custom": "no",
      "ElementKey": "uipath-zoho-desk"
    }
  ]
}

uip 是资源描述

描述对象的字段和操作。如果没有--operation ，则返回可用操作的列表和提示。使用--operation ，可以缩小到一个操作，并返回其参数、请求字段和响应字段。

参数

名称	必填	用途
<connector-key>	是	连接器密钥。
<object-name>	是	对象名称（例如tickets ）。查找包含resources list名称。

选项

短	长	值	默认	描述
—	--connection-id	id	—	连接的作用域（启用自定义字段）。
-t	--tenant	name	会话默认值	覆盖租户。
—	--operation	枚举	—	List、 Retrieve 、 Create 、 Update 、 Delete或Replace 。
—	--refresh	标记	关闭	强制从 API 重新获取，忽略缓存。

示例

# List operations available on this object
uip is resources describe uipath-zoho-desk tickets

# Field schema for the Create operation
uip is resources describe uipath-zoho-desk tickets --operation Create

# Required request fields, scripting-friendly
uip is resources describe uipath-zoho-desk tickets --operation Create \
    --output-filter 'Data.requestFields[?required].name'

数据形状（--输出 json）

没有--operation ：

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "availableOperations": [
      { "method": "GET", "name": "List", "description": "Search for Tickets", "path": "/tickets" },
      { "method": "POST", "name": "Create", "description": "Create a Tickets", "path": "/tickets" }
    ],
    "hint": "Use --operation <Create|List|Retrieve|Update|Delete|Replace> to see fields for a specific operation."
  }
}

使用--operation Create时，系统会返回相同的Code: "ResourceMetadata" ，但有效负载不是availableOperations ，而是带有operation 、 parameters 、 requestFields和responseFields 。

uip 为资源执行权限

调用连接器的数据平面。execute本身是一个组；实际动词为create 、 list 、 get 、 update 、 replace和delete 。每个动词都需要--connection-id ； create 、 update和replace还需要--body具有 JSON 请求正文。

uip is resources execute create   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute list     <connector-key> <object-name> --connection-id <id>
uip is resources execute get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources execute update   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute delete   <connector-key> <object-name> --connection-id <id> [--query <params>]

HTTP 方法映射： create → POST， list → GET（集合）， get → 按 ID GET， update → PATCH， replace → PUT， delete → DELETE。

参数

名称	必填	用途
<connector-key>	是	连接器密钥。
<object-name>	是	对象名称（例如tickets ）。

共享选项

短	长	值	默认	描述
—	--connection-id	id	必填	用于授权数据平面调用的连接。
-t	--tenant	name	会话默认值	覆盖租户。
—	--query	参数	—	查询参数。接受key=value&key=value或 JSON 对象。
—	--body	JSON	—	请求正文。对于create 、 update 、 replace为必要项。

示例

# Create a ticket
uip is resources execute create uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"subject":"New issue","departmentId":"DEP-1"}'

# List tickets — first page
uip is resources execute list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID
uip is resources execute delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001'

数据形状（--输出 json）

{
  "Code": "ExecuteOperation",
  "Data": { "id": "TK-1001", "subject": "New issue", "status": "Open" }
}

list操作返回{ "items": [...] } ，当后端通过Elements-Has-More / Elements-Next-Page-Token标头发出更多页面信号时，请在其中包含具有HasMore和NextPageToken Pagination对象。

失败的调用会显示为Failure ，HTTP 状态为Message ，服务器正文为Instructions 。

相关内容

• uip is connections — --connection-id值来自connections list / connections create 。
• uip is connectors — 首先发现连接器密钥。
• uip is activities — 查看连接器公开的命名操作。
• uip is triggers — 此处数据平面动词的事件驱动对应项。

另请参阅

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