uip Maestro 流注册表

“uip Maestro 流注册表”的语法和选项，可浏览流中可用的内置活动和连接器节点的目录。

uip maestro flow registry用于浏览流节点注册表— .flow文件中可用的构建块目录。注册表包含 OOTB 活动（ uipath.agent 、 uipath.http等）和调用第三方 API（Slack、Salesforce、Jira 等）的连接器节点。登录后，注册表还包含租户中安装的连接器节点。

注册表还包含已发布的 UiPath IXP 模型的文档提取节点 ( uipath.ixp.* )。

注册表在 UiPath 工作流界面之间共享；相同的实现也支持 BPMN（请参阅通过uip maestro bpmn registry公开的Maestro 注册表）。

所有子命令都遵循全局选项。退出代码遵循标准合同。

大纲

uip maestro flow registry pull   [-f, --force]
uip maestro flow registry list   [-l, --limit <n>] [--local]
uip maestro flow registry search [<keyword>] [-f, --filter <expr>] [--local]
uip maestro flow registry get    <nodeType> [--connection-id <id>] [--local]

典型工作流

# 0. (Optional) Login for the full, tenant-enriched registry
uip login

# 1. Sync the registry (once per session — cache expires after 30 minutes)
uip maestro flow registry pull

# 2. Search for a candidate node
uip maestro flow registry search slack --filter "displayname:contains=send"

# 3. Inspect the full schema
uip maestro flow registry get uipath.connector.slack.send-message

# 4. Extract just the input field definitions (useful for building requests)
uip maestro flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields"

无需登录，仅返回内置 (OOTB) 节点。

---

uip Maestro 流注册表拉取

获取节点注册表并将其写入本地缓存。后续的list 、 search和get调用将从此缓存中读取。

选项

• -f, --force — 强制刷新，忽略缓存。

缓存行为

• 缓存将在 30 分钟后过期。缓存过期或缺失会触发实时提取。
• 未登录时，系统将返回 OOTB 节点，而不更新缓存。
• 如果通过身份验证的获取失败，命令将回退到 OOTB 节点，而不更新缓存。

数据形状 ( --output json )

{
  "Code": "NodePullSuccess",
  "Data": {
    "NodesCount":   184,
    "FromCache":    false,
    "AgeMinutes":   null,
    "Source":       "authenticated",
    "CacheWritten": true,
    "Message":      "Synced fresh nodes",
    "Info":         null
  }
}

Source为"ootb" （未验证）或"authenticated" （租户专属）。如果达到AgeMinutes ，则填充FromCache: true 。

---

uip Maestro 流注册表列表

缓存节点示例。默认为前 20 个条目。

选项

选项	默认	描述
-l, --limit <n>	20	要返回的节点数。为全部传递-1 。必须是正整数或-1 。
--local	关闭	仅显示解决方案内的项目节点。需要 CWD、父父项或祖父项中的.uipx 。

如果在没有先前list的情况下调用pull ，则该服务将首先获取实时数据。

数据形状

{
  "Code": "NodeListSuccess",
  "Data": [
    {
      "NodeType":    "uipath.slack.connector.send-message",
      "Category":    "connector",
      "DisplayName": "Send Message",
      "Description": "Post a message to a Slack channel",
      "Version":     "1.0.0",
      "Tags":        "slack, messaging"
    }
  ]
}

如果结果被截断，stderr 上会发出一个日志行，显示总计与显示数量。

---

uip Maestro 流注册表搜索

按关键字和/或结构化筛选器查找节点。

参数

• [keyword] — 根据nodeType 、 category 、 tags 、 display.label 、 description匹配的子字符串。

选项

选项	描述
-f, --filter <expr>	结构化字段筛选器（请参阅以下语法）。
--local	仅搜索解决方案内的节点（需要附近的.uipx ）。

至少需要<keyword>或--filter 。

筛选器语法

field=value                     # equality (default operator)
field:operator=value            # operator variant
field1=v1,field2=v2             # multiple conditions (AND)

运算符： equals （默认）以及contains 、 startsWith 、 endsWith 、 in 。

可筛选字段（别名显示在括号中）：

• category [ cat ] — 例如connector 、 agent 、 trigger
• type [ nodetype ] — 节点类型标识符
• tags [ tag ] — 节点标签
• displayname [ display_name 、 name 、 label ] — 人类可读的名称

示例

uip maestro flow registry search slack
uip maestro flow registry search --filter "category=connector"
uip maestro flow registry search --filter "displayname:contains=send message"
uip maestro flow registry search slack --filter "category=connector"
uip maestro flow registry search --filter "tags:in=ai,automation"
uip maestro flow registry search --filter "category=connector,displayname:contains=slack"
uip maestro flow registry search uipath.ixp

数据形状：与list相同的形状 — Code: "NodeSearchSuccess" 、 Data: [flattened nodes…] 。

---

uip Maestro 流注册表获取

返回单个节点的完整详细信息。

参数

• <nodeType> （必填项） — 节点类型标识符（不区分大小写）。

选项

选项	描述
--connection-id <id>	Integration Service 丰富的连接 ID。对于连接器触发器节点为必要项；对于连接器活动节点为可选。
--local	仅从解决方案项目中获取节点。

丰富 Integration Service

对于标记为"connector"节点， get会自动调用 Integration Service 并合并实时元数据：

连接器活动节点（ uipath.connector.* ，非触发器）：

• inputDefinition.fields[] — 要配置的字段。每个包含name 、 displayName 、 type 、 required ，也可以包含reference （查找： objectName 、 path 、 lookupValue 、 lookupNames 、 childPath ）或enum 。
• outputResponseDefinition — 节点运行后生成的字段。
• connectorMethodInfo — HTTP 方法、路径、操作 ID。
• --connection-id是可选项；如果输入为 1，则会添加特定于该帐户的自定义字段。

连接器触发器节点( uipath.connector.trigger.* )：

• eventParameters — 配置触发器的字段（例如，查看哪个文件夹）。
• filterFields — 用于筛选触发触发器的事件的字段。
• outputResponseDefinition — 由事件有效负载生成的字段。
• eventMode — "webhooks"或"polling" 。
• “登录名”和--connection-id为必填项 — 否则，不会返回任何丰富内容。

每个输入字段的元数据

inputDefinition.fields下的每个条目：

属性	描述
name	请求/响应的 JSON 密钥。
displayName	人类可读标签。
type	数据类型（ string 、 boolean 、 integer …）。
required	true 如果为必填项（仅输入字段）。
description	此字段的作用。
enum	允许的值（如果受到限制）。
reference	对象引用元数据 — 字段需要提供 ID，而不是纯名称。
responseOnly	true 在输出字段上。

数据形状

{
  "Code": "NodeGetSuccess",
  "Data": {
    "Node": {
      "nodeType":        "uipath.slack.connector.send-message",
      "category":        "connector",
      "display":         { "label": "Send Message" },
      "inputDefinition": {
        "fields": [
          { "name": "channel", "required": true, "type": "string" }
        ]
      }
    }
  }
}

示例

# Basic activity lookup (anonymous, OOTB)
uip maestro flow registry get uipath.agent

# Connector activity with optional account-specific enrichment
uip maestro flow registry get uipath.connector.uipath-salesforce-slack.send-message \
  --connection-id <connection-id>

# Connector trigger — requires login + connection-id
uip maestro flow registry get uipath.connector.trigger.uipath-microsoft-outlook365.email-received \
  --connection-id <connection-id>

# Just the input fields, for building a request body
uip maestro flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields" --output json

IXP 模型节点

已发布的 UiPath IXP 提取模型在注册表中显示为uipath.ixp.*命名空间下的节点类型。标识符对模型进行编码，例如：

• uipath.ixp.invoice-model.shared-invoice-model
• uipath.ixp.birth-certificates-oob.shared-birth-certificates-oob

若执行命名空间搜索，则会返回以下内容：

uip maestro flow registry search uipath.ixp

uip maestro flow registry get <nodeType>返回inputDefaults下的部署坐标（ inputDefaults.modelName和inputDefaults.folderKey ），当将节点添加到流中时，这些坐标会填充节点的inputs.model块。

实例规格

添加到.flow文件的uipath.ixp.*节点必须遵循以下形状：

字段	要求
inputs.model	具有非空字符串modelName和folderKey的对象。
inputs.fileRef	以=js:$vars.<upstream>.output.<field>形式引用上游输出的=js:$vars.…表达式。
outputs.output	存在于实例上。下游节点读取$vars.<nodeId>.output 。
outputs.error	存在于实例上。下游节点读取$vars.<nodeId>.error 。

要将发现的节点连接到工作流，请参阅uip maestro flow node add和uip maestro flow node configure 。

另请参阅

• uip maestro flow node add和uip maestro flow node configure — 使用此处发现的节点类型
• 流概述