UIP 为触发器

“uip is 触发器”的语法和选项，可读取连接器触发器活动的事件挂钩元数据。

uip is triggers是连接器事件挂钩的只读视图，即支持触发器活动的元数据。当连接器对象为CREATED 、 UPDATED或DELETED时，触发器会触发。objects列出支持触发器操作的对象； describe返回一个对象的完整触发器元数据（事件模式、参数、筛选字段、输出字段）。两个动词都会缓存结果； --connection-id是可选项，但建议使用 — 没有它，自定义对象/字段可能会缺失，并且响应中会包含Warning 。

大纲

uip is triggers <verb> [options]

动词

动词	用途
objects	列出支持在连接器上执行触发器操作的对象。
describe	获取一项操作下一个对象的完整触发器元数据。

uip 是否为触发器对象

列出支持连接器上给定触发器操作的对象。仅在提供--connection-id时，才会写入缓存结果。

参数

名称	必填	用途
<connector-key>	是	连接器键，例如uipath-zoho-desk 。
<operation>	是	触发器操作： CREATED 、 UPDATED或DELETED （不区分大小写；已规范化为大写）。

选项

短	长	值	默认	描述
—	--connection-id	id	—	作用域为连接（启用自定义对象）。
—	--refresh	标记	关闭	强制从 API 重新获取，忽略缓存。

示例

uip is triggers objects uipath-zoho-desk CREATED

# Connection-scoped — includes custom objects
uip is triggers objects uipath-zoho-desk UPDATED \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

uip is triggers objects uipath-zoho-desk DELETED \
    --output-filter 'Data[].{name:name, display:displayName}'

数据形状（--输出 json）

{
  "Code": "TriggerObjectList",
  "Data": [
    {
      "hideEventIDField": false,
      "debugDisabled": false,
      "displayName": "Tickets",
      "name": "tickets",
      "isHidden": false,
      "supportedAuths": [],
      "isWebhookUrlVisible": false,
      "byoaConnection": false,
      "hasStaticLeftOperandFilterBuilder": false
    }
  ]
}

如果没有--connection-id ，响应会包含Warning ，表明自定义对象可能缺失。

UIP 正在触发器描述

在一次触发器操作下为一个对象返回完整的触发器元数据：事件模式（轮询与 Webhook）、事件参数、筛选器字段和输出字段。

参数

名称	必填	用途
<connector-key>	是	连接器密钥。
<operation>	是	触发器操作（ CREATED 、 UPDATED和DELETED ）。
<object-name>	是	对象名称（例如tickets ）。使用triggers objects查找。

选项

短	长	值	默认	描述
—	--connection-id	id	—	连接的作用域（启用自定义字段）。
—	--refresh	标记	关闭	强制从 API 重新获取，忽略缓存。

示例

uip is triggers describe uipath-zoho-desk CREATED tickets

uip is triggers describe uipath-zoho-desk CREATED tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

uip is triggers describe uipath-zoho-desk UPDATED tickets \
    --output-filter 'Data.outputFields[].name'

数据形状（--输出 json）

{
  "Code": "TriggerMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "operation": "CREATED",
    "eventMode": "polling",
    "byoaConnection": false,
    "isWebhookUrlVisible": false,
    "eventParameters": [],
    "filterFields": [
      { "name": "subject", "type": "string", "displayName": "Subject", "description": "The Subject" }
    ],
    "outputFields": [
      { "name": "id", "type": "string", "displayName": "ID", "description": "The ID" },
      { "name": "subject", "type": "string", "displayName": "Subject", "description": "The Subject" }
    ]
  }
}

对于 CRUD 样式的操作，响应还会显示Hint建议相邻的triggers objects命令。缺少--connection-id ，响应会包含关于缺少自定义字段的Warning 。

相关内容

• uip is activities — 传递--triggers以仅列出触发器活动。
• uip is connectors — 对于公开触发器的连接器， connectors get报告HasEvents: "Yes" 。
• uip is connections — 从此处的连接提供--connection-id ，以获取自定义感知元数据。
• uip is resources — 同一连接器的数据平面 (CRUD) 端的同级资源。

另请参阅

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