UIP 是连接器构建器活动
使用 Integration Service 连接器构建器编写连接器活动的语法和选项(资源、字段、方法和参数)。
uip is connectors builder activity创建连接器的活动:成为 Studio 活动的 API 端点(在标准资源文件中称为资源)及其字段、方法和参数。这是连接器构建器中最大、最详细的域 — 请参阅连接器构建器,了解也适用的共享概念(连接器目录解析、设计与发布、典型的创作流程)。
挂钩是附加到资源或全局的 JavaScript 请求前/请求后转换,是嵌套的activity hook子组,由于其自身大小和所需的 runtime 上下文详细信息量而单独记录在活动挂钩中。
activity create不适用于 auth-validation 或onProvision等生命周期端点 — 这些是使用builder auth system create创建的系统资源(请参阅身份验证)。activity 用于连接器面向用户的常规操作。
大纲
uip is connectors builder activity list [--method <method>] [--path <path>] [--connector-dir <path>]
uip is connectors builder activity get [<name>] [--name <name>] [--connector-dir <path>]
uip is connectors builder activity create --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity delete <name> [--connector-dir <path>]
uip is connectors builder activity field schema
uip is connectors builder activity field list --resource <name> [--connector-dir <path>]
uip is connectors builder activity field get [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity field create --resource <name> --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity field delete [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity method get --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity method set --resource <name> --method <method> [options...] [--connector-dir <path>]
uip is connectors builder activity method curate --resource <name> --method <method> --display-name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity param list --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity param get --resource <name> --method <method> --name <name> [--connector-dir <path>]
uip is connectors builder activity param create --resource <name> --method <method> --name <name> --type <type> [options...] [--connector-dir <path>]
uip is connectors builder activity param delete --resource <name> --method <method> --name <name> [--connector-dir <path>]
uip is connectors builder activity list [--method <method>] [--path <path>] [--connector-dir <path>]
uip is connectors builder activity get [<name>] [--name <name>] [--connector-dir <path>]
uip is connectors builder activity create --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity delete <name> [--connector-dir <path>]
uip is connectors builder activity field schema
uip is connectors builder activity field list --resource <name> [--connector-dir <path>]
uip is connectors builder activity field get [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity field create --resource <name> --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity field delete [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity method get --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity method set --resource <name> --method <method> [options...] [--connector-dir <path>]
uip is connectors builder activity method curate --resource <name> --method <method> --display-name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity param list --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity param get --resource <name> --method <method> --name <name> [--connector-dir <path>]
uip is connectors builder activity param create --resource <name> --method <method> --name <name> --type <type> [options...] [--connector-dir <path>]
uip is connectors builder activity param delete --resource <name> --method <method> --name <name> [--connector-dir <path>]
概念
- 资源—
element.json中的一个 API 端点条目,由名称、路径或METHOD:/path选取器(例如GET:/accounts)的存储库。activity create是“查找或附加”操作:对现有资源名称再次运行,系统会附加新方法/字段,而不会覆盖资源。 - 字段— 资源的面向用户界面的属性,存储在资源的标准资源 (SR) 文件中。字段包含每个 HTTP 方法的可见性(是否为请求正文、响应的一部分,是否为必填项)以及用于说明字段呈现方式的可选设计元数据(下拉列表、依赖下拉列表、隐藏、排序顺序)。
- 方法— 资源的每个 HTTP 方法的标准资源配置:其操作标签、内部路径、策划状态和说明。
activity method curate将方法提升为独立的 Studio 活动。 - 参数— 存储在
element.json并镜像到 SR 中的运行时请求参数(查询、路径、标头或正文)。与字段不同,参数描述了一个值如何到达供应商 API 调用,而不是它如何呈现为静态用户界面属性——尽管参数也可以通过与字段相同的引用/枚举标志变成下拉列表。 - 下拉列表/依赖下拉列表—
field create和param create共享一组相同的标志(--reference、--reference-object、--reference-path、--lookup-value、--lookup-names、--display-pattern、--filter-pattern、--load-by-default、--multi-select、--enable-user-override、--depends-on、--field-actions),用于将值连接到针对另一个“列表”资源的查找。--depends-on <parentField>是快捷方式,用于为依赖下拉列表生成标准显示/隐藏规则对(在父级具有值之前处于隐藏状态);--field-actions是原始 JSON 转义窗口,适用于--depends-on无法表达的条件。 - 合并语义—
field create、param create(通过create or replace— 见下文)和method set默认情况下全部合并到现有条目:您传递的密钥有效,您省略的密钥从现有定义中保留,并根据- 字段的方法可见性为深度合并,因此为一种方法添加可见性绝不会降低另一种方法的可见性。method set --replace是一个例外 — 它将覆盖整个方法的配置,删除任何未重新传递的内容(包括参数和策划状态)。 - 取消设置可见性标志—
field create --method 'GET=!request'(请注意!前缀)在合并时明确关闭GET的request可见性,而不是保持不变。如果没有!,标志只能是可加的。
uip 是连接器构建器活动列表
列出(可选)筛选的 element.json 资源条目。
选项
| 长 | 值 | 描述 |
|---|---|---|
--method <method> | 字符串 | 按 HTTP 方法筛选(GET、POST……)。 |
--path <path> | 字符串 | 按确切的资源路径筛选(例如/accounts)。 |
--connector-dir <path> | 路径 | 连接器目录。有关解决顺序,请参阅连接器构建器 → 概念。 |
示例
uip is connectors builder activity list
uip is connectors builder activity list --method GET
uip is connectors builder activity list
uip is connectors builder activity list --method GET
数据形状(--输出 json)
{ "Code": "ResourceList", "Data": { "Resources": [] } }
{ "Code": "ResourceList", "Data": { "Resources": [] } }
UIP 是连接器构建器活动“获取”
通过名称、路径或 element.json 选取器获取一个 METHOD:/path 资源条目。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
[name] | 否 | 资源名称、路径或 METHOD:/path 选取器(例如accounts 或 'GET:/accounts')。也可以作为 --name 传递。 |
选项
| 长 | 值 | 描述 |
|---|---|---|
--name <name> | 字符串 | 位置参数的替代方案,可与 create/field get/param get 实现对等。 |
--connector-dir <path> | 路径 | 连接器目录。 |
示例
uip is connectors builder activity get accounts
uip is connectors builder activity get 'GET:/accounts'
uip is connectors builder activity get accounts
uip is connectors builder activity get 'GET:/accounts'
数据形状(--输出 json)
{ "Code": "Resource", "Data": { "Resource": {} } }
{ "Code": "Resource", "Data": { "Resource": {} } }
UIP 是连接器构建器活动,用于创建
创建完整资源:一个标准资源文件加上每个方法一个 element.json 条目。重新运行现有的 --name 会找到并附加,而不是进行覆盖。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--name <name> | 字符串 | 是 | 资源名称(路径段)。 |
--display-name <name> | 字符串 | 否 | 用户界面显示名称。默认值为 --name。 |
--vendor-path <path> | 字符串 | 否 | 供应商 API 路径。默认为 /{name}。 |
--resource-path <path> | 字符串 | 否 | 显式资源路径(当与供应商路径不同时)。 |
--methods <csv> | csv | 否 | 要创建的 HTTP 方法。默认 GET,GETBYID,POST,PATCH,DELETE。 |
--method-vendor-path <kv> | key=value、可重复 | 否 | 按方法的供应商路径覆盖,例如GET=/me/teams。 |
--primary-key <name> | 字符串 | 否 | 主键字段名称。默认 id。 |
--no-body | 标记 | 否 | 省略 POST/PUT/PATCH 上自动添加的请求正文参数 — 对于仅需要路径的操作,例如仅需要路径中的 ID 的开始/停止调用。 |
--resource-type <type> | 字符串 | 否 | ResourceType 值(api、apiElementRequest、...)。默认 api。 |
--has-ceql | 标记 | 否 | 对 GET 启用 CEQL 筛选。 |
--has-events | 标记 | 否 | 将资源标记为支持事件。 |
--has-bulk | 标记 | 否 | 启用批量下载支持。 |
--pagination-type <type> | 字符串 | 否 | GET 的分页类型。 |
--root-key <key> | 字符串 | 否 | 保存记录的响应根键。 |
--next-page-key <key> | 字符串 | 否 | 携带下一页令牌的响应键。 |
--filter-param <vendorName> | 字符串 | 否 | CEQL 筛选器映射到的供应商查询参数名称。默认 where(例如sysparm_query对于 ServiceNow 样式 API)。 |
--page-size-param <vendorName> | 字符串 | 否 | 页面大小的供应商查询参数名称。默认 pageSize(例如sysparm_limit、per_page)。 |
--offset-param <vendorName> | 字符串 | 否 | 行偏移量的供应商查询参数名称/页码(例如sysparm_offset、page)。 |
--next-resource <selector> | 字符串 | 否 | 链接到下一个资源(例如'GET:/organization')。 |
--curated-metadata <json> | JSON | 否 | 按方法策划的内联元数据。与 --curated-metadata-file 互斥。 |
--curated-metadata-file <path> | 路径 | 否 | 文件中按方法策划的元数据。 |
--fields <json> | JSON | 否 | 内联 JSON 数组形式的字段规范。与 --fields-file 互斥。请参阅 activity field schema 以了解形状。 |
--fields-file <path> | 路径 | 否 | JSON 文件中的字段规范。 |
--skip-sr | 标记 | 否 | 跳过标准资源文件创建过程。 |
--no-curate | 标记 | 否 | 请勿将方法自动策划为独立的 Studio 活动。默认值为策划。 |
--overwrite-fields | 标记 | 否 | 附加到现有资源时,应以传入的字段定义胜出,以防名称冲突。默认保留现有定义。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
同时传递 --fields 和 --fields-file(或同时传递 --curated-metadata 和 --curated-metadata-file)即为错误。在写入任何内容之前, --fields / --fields-file有效负载会经过验证和规范化,因此格式错误的字段规范会快速失败,并显示精确的错误,而不是静默编写损坏的标准资源文件。
示例
# CRUD resource with default methods
uip is connectors builder activity create --name accounts --vendor-path /accounts --has-ceql
# List-only resource with cursor pagination
uip is connectors builder activity create --name orders --methods GET \
--pagination-type cursor --next-page-key nextCursor --root-key data
# CRUD resource with default methods
uip is connectors builder activity create --name accounts --vendor-path /accounts --has-ceql
# List-only resource with cursor pagination
uip is connectors builder activity create --name orders --methods GET \
--pagination-type cursor --next-page-key nextCursor --root-key data
数据形状(--输出 json)
{
"Code": "ResourceCreated",
"Data": {
"ResourceName": "accounts",
"ConnectorRoot": "/work/my-connector",
"ResourceType": "api",
"SrResolution": "created",
"MethodsAdded": ["GET", "GETBYID", "POST", "PATCH", "DELETE"],
"ElementEntriesAdded": 5,
"ElementEntriesSkipped": 0,
"FieldsCount": 0,
"ParamsSyncedFromElement": 0,
"StandardResourceFile": "app/element/accounts.js",
"SkipSr": false,
"Warnings": []
}
}
{
"Code": "ResourceCreated",
"Data": {
"ResourceName": "accounts",
"ConnectorRoot": "/work/my-connector",
"ResourceType": "api",
"SrResolution": "created",
"MethodsAdded": ["GET", "GETBYID", "POST", "PATCH", "DELETE"],
"ElementEntriesAdded": 5,
"ElementEntriesSkipped": 0,
"FieldsCount": 0,
"ParamsSyncedFromElement": 0,
"StandardResourceFile": "app/element/accounts.js",
"SkipSr": false,
"Warnings": []
}
}
uip 是将连接器构建器活动删除
删除资源:每个匹配的 element.json 条目及其标准资源文件。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<name> | 是 | 资源名称。 |
选项
| 长 | 值 | 描述 |
|---|---|---|
--connector-dir <path> | 路径 | 连接器目录。 |
示例
uip is connectors builder activity delete accounts
uip is connectors builder activity delete accounts
数据形状(--输出 json)
{
"Code": "ResourceRemoved",
"Data": {
"ResourceName": "accounts",
"RemovedEntries": 5,
"StandardResourceRemoved": true
}
}
{
"Code": "ResourceRemoved",
"Data": {
"ResourceName": "accounts",
"RemovedEntries": 5,
"StandardResourceRemoved": true
}
}
这将删除整个资源。要删除单个方法,请使用 activity method set --replace 编辑资源范围,或使用缩小的 create 列表删除并重新 --methods — 没有专用的“删除一个方法”选项动词。
活动字段
管理资源的标准资源字段,即其面向用户界面的形状。
uip 是连接器构建器活动字段架构
打印字段规范的架构(允许的键、类型、可见性)以及有效的示例,以便在--fields --fields-fileactivity create或 上编写activity field create 有效负载。不需要连接器 — 这是一个独立于连接器的静态参考命令。
除全局参数或选项外,没有参数或选项。
示例
uip is connectors builder activity field schema
uip is connectors builder activity field schema
数据形状(--输出 json)
返回时附带了原生小写密钥(非帕斯卡拼写法),因此 example 数组可直接复制粘贴创作:
{
"Code": "FieldSchema",
"Data": {
"keys": [
{ "key": "name", "required": true, "description": "REQUIRED. Field name; becomes the SR fields[] key (dotted a.b and arr[*].x allowed)." },
{ "key": "type", "required": false, "description": "Scalar type. Optional on merge; defaults to 'string' for a new field." }
],
"types": ["string", "..."],
"designPositions": ["primary", "secondary", "none"],
"visibilityMethods": ["GET", "..."],
"visibilityKeys": ["request", "response", "required", "requestCurated", "responseCurated"],
"notes": [
"Pass an ARRAY of these objects to --fields '<json>' or --fields-file <path> on `activity create`.",
"The array is validated + normalized before anything is written; a bad shape fails fast listing every problem.",
"Unknown top-level keys and duplicate names are rejected. Put 'required' inside a method entry, not at top level.",
"To bulk-add fields to an EXISTING activity, re-run `activity create --name <same> --fields-file <path>` — it merges."
],
"example": [
{ "name": "id", "type": "string", "primaryKey": true, "method": { "GET": { "response": true } } },
{ "name": "email", "type": "string", "displayName": "Email", "searchable": true, "searchableOperators": ["=", "!="], "method": { "GET": { "response": true }, "POST": { "request": true, "response": true, "required": true } } }
]
}
}
{
"Code": "FieldSchema",
"Data": {
"keys": [
{ "key": "name", "required": true, "description": "REQUIRED. Field name; becomes the SR fields[] key (dotted a.b and arr[*].x allowed)." },
{ "key": "type", "required": false, "description": "Scalar type. Optional on merge; defaults to 'string' for a new field." }
],
"types": ["string", "..."],
"designPositions": ["primary", "secondary", "none"],
"visibilityMethods": ["GET", "..."],
"visibilityKeys": ["request", "response", "required", "requestCurated", "responseCurated"],
"notes": [
"Pass an ARRAY of these objects to --fields '<json>' or --fields-file <path> on `activity create`.",
"The array is validated + normalized before anything is written; a bad shape fails fast listing every problem.",
"Unknown top-level keys and duplicate names are rejected. Put 'required' inside a method entry, not at top level.",
"To bulk-add fields to an EXISTING activity, re-run `activity create --name <same> --fields-file <path>` — it merges."
],
"example": [
{ "name": "id", "type": "string", "primaryKey": true, "method": { "GET": { "response": true } } },
{ "name": "email", "type": "string", "displayName": "Email", "searchable": true, "searchableOperators": ["=", "!="], "method": { "GET": { "response": true }, "POST": { "request": true, "response": true, "required": true } } }
]
}
}
完整的密钥列表(来自来源)还包括nativeType 、 description 、 sampleValue 、 format 、 mask (日期/数字格式的模式字符串,例如"yyyy-MM-dd'T'HH:mm:ssZ" — 不是布尔值)、design、methods(method 的别名,而不是两者同时存在)、enum、enhancedEnum、reference、sortOrder、searchableNames、defaultValue 、custom、order、isCuratedEventField、isPriority、key 和 fieldActions。
uip 是连接器构建器活动字段列表
列出资源的标准资源中的每个字段。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity field list --resource accounts
uip is connectors builder activity field list --resource accounts
数据形状(--输出 json)
{ "Code": "FieldList", "Data": { "Resource": "accounts", "Fields": [] } }
{ "Code": "FieldList", "Data": { "Resource": "accounts", "Fields": [] } }
UIP 是连接器构建器活动字段获取
按名称读取一个字段。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
[name] | 否 | 字段名称(或传递 --name)。 |
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--name <name> | 字符串 | 否 | 位置参数的替代方法。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity field get --resource accounts name
uip is connectors builder activity field get --resource accounts name
数据形状(--输出 json)
{ "Code": "Field", "Data": { "Resource": "accounts", "Field": {} } }
{ "Code": "Field", "Data": { "Resource": "accounts", "Field": {} } }
UIP 为连接器构建器活动字段创建
创建或更新资源的标准资源字段。在现有字段上重新运行合并:您传递的顶级键成功,保留未指定的键,并且每个方法的可见性进行深度合并,因此添加一个方法的可见性永远不会删除另一个方法的可见性。
不适用于添加运行时请求参数 — 请使用 activity param create。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--name <name> | 字符串 | 是 | 字段名称(成为 fields 映射键)。 |
--type <type> | 字符串 | 否* | 字段类型(string、integer、...)。新字段为必填项;合并到现有合并时为可选项。 |
--native-type <type> | 字符串 | 否 | 供应商原生类型名称。默认为 --type。 |
--display-name <name> | 字符串 | 否 | 用户界面显示名称。 |
--description <text> | 字符串 | 否 | 字段说明。 |
--sample-value <value> | 字符串 | 否 | 设计器中显示的示例值。 |
--format <format> | 字符串 | 否 | 字段格式提示(例如date-time、int32)。 |
--enum <json> | JSON | 否 | 允许的值 — 空白为 ["a","b"] 或 [{"value":"a"}]。 |
--enhanced-enum <json> | JSON | 否 | 已标记的选项:[{"name":"Label","value":"V"}]。 |
--reference <json> | JSON | 否 | JSON 格式的动态查找内容,例如{"objectName":"users","path":"/users","lookupValue":"id","lookupNames":["name"]}。 |
--reference-object <name> | 字符串 | 否 | 下拉列表:目标列表资源的对象名称(例如teams)。 |
--reference-path <path> | 字符串 | 否 | 下拉列表:“列表”资源路径(例如/teams)。对依赖下拉列表使用 {parent},例如/teams/{team_id}/channels。 |
--lookup-value <field> | 字符串 | 否 | 下拉列表:作为值发送的单个字段。 |
--lookup-names <csv> | csv | 否 | 下拉列表:显示模式的显示候选字段。 |
--display-pattern <pattern> | 字符串 | 否 | 下拉列表:可见的标签模板,例如"{displayName}" 或 "{name} - {id}"。 |
--filter-pattern <pattern> | 字符串 | 否 | 下拉列表:包含 {filter} 的服务器端预先输入筛选器模板。 |
--load-by-default | 标记 | 否 | 下拉列表:打开时填充列表。 |
--multi-select | 标记 | 否 | 下拉列表:允许选择多个值。 |
--enable-user-override | 标记 | 否 | 下拉列表:让用户键入原始值,而不是选取值。 |
--depends-on <parent> | 字符串 | 否 | 依赖项下拉列表:隐藏直到 <parent> 具有值(生成显示/隐藏规则对)。引用路径应包含 {<parent>}。 |
--field-actions <json> | JSON | 否 | 以 JSON 格式显示/隐藏/必需规则 — 使用 --depends-on 格式的转义填充。 |
--default-value <value> | 标量或 JSON | 否 | 默认值。 |
--mask <pattern> | 字符串 | 否 | 日期/数字格式模式,例如"yyyy-MM-dd'T'HH:mm:ssZ"。 |
--primary-key | 标记 | 否 | 将该字段标记为主键。 |
--sort-order <n> | 整数 | 否 | 排序顺序。 |
--searchable | 标记 | 否 | 将字段标记为可搜索。 |
--searchable-operators <csv> | csv | 否 | 可搜索的运算符。 |
--searchable-names <csv> | csv | 否 | 查询中要匹配的替代名称。 |
--method <method> | 可重复的字符串 | 否 | 可见性标志适用的 HTTP 方法。两种形式,可混合使用:统一(--method GET --method POST --response 对两者应用相同的标志)或按方法内联 (--method 'GET=response' --method 'POST=request,required')。在标志前面添加 !,可在合并时取消设置,例如--method 'GET=!request'。 |
--request | 标记 | 否 | 对于每个 --method,字段是请求的一部分。 |
--response | 标记 | 否 | 对于每个 --method,“字段”是响应的一部分。 |
--required | 标记 | 否 | 对于每个 --method,该字段为必填项。 |
--request-curated | 标记 | 否 | 字段按请求针对每个 --method 策划。 |
--response-curated | 标记 | 否 | 字段是针对每个 --method 策划的响应。 |
--design-position <position> | primary|secondary|none | 否 | 设计位置。 |
--component <component> | 字符串 | 否 | 设计组件覆盖。 |
--hidden | 标记 | 否 | 在设计器中隐藏字段。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
每个方法的内联可见性令牌为:request、response、required、requestCurated(或 request-curated)、responseCurated(或 response-curated)。无法识别的令牌会失败,并显示列出有效集的显式错误。
示例
# String field, visible as a response on both GET and POST
uip is connectors builder activity field create --resource accounts --name email \
--type string --method GET --method POST --response
# Add request visibility on PATCH without dropping the existing GET/POST visibility (merges)
uip is connectors builder activity field create --resource accounts --name email \
--type string --method PATCH --request
# String field, visible as a response on both GET and POST
uip is connectors builder activity field create --resource accounts --name email \
--type string --method GET --method POST --response
# Add request visibility on PATCH without dropping the existing GET/POST visibility (merges)
uip is connectors builder activity field create --resource accounts --name email \
--type string --method PATCH --request
数据形状(--输出 json)
{
"Code": "FieldWritten",
"Data": {
"Resource": "accounts",
"FieldName": "email",
"Field": { "name": "email", "type": "string" },
"Outcome": "created"
}
}
{
"Code": "FieldWritten",
"Data": {
"Resource": "accounts",
"FieldName": "email",
"Field": { "name": "email", "type": "string" },
"Outcome": "created"
}
}
uip 是将连接器构建活动字段删除
按名称删除字段。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
[name] | 否 | 字段名称(或传递 --name)。 |
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--name <name> | 字符串 | 否 | 位置参数的替代方法。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity field delete --resource accounts email
uip is connectors builder activity field delete --resource accounts email
数据形状(--输出 json)
{ "Code": "FieldRemoved", "Data": { "Resource": "accounts", "FieldName": "email" } }
{ "Code": "FieldRemoved", "Data": { "Resource": "accounts", "FieldName": "email" } }
活动方法
管理资源每种方法的标准资源配置:操作标签、内部路径、策划状态。
UIP 是连接器构建器活动方法获取
读取方法的标准资源配置。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--method <method> | 字符串 | 是 | HTTP 方法(GET、POST、...)。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity method get --resource accounts --method GET
uip is connectors builder activity method get --resource accounts --method GET
数据形状(--输出 json)
{
"Code": "Method",
"Data": { "Resource": "accounts", "Method": "GET", "VendorPath": "/accounts", "Config": {} }
}
{
"Code": "Method",
"Data": { "Resource": "accounts", "Method": "GET", "VendorPath": "/accounts", "Config": {} }
}
VendorPath单独显示,因为标准资源配置仅保存内部路径,面向供应商的路由位于element.json中。
UIP 是连接器构建器活动方法集
创建或编辑方法的标准资源配置。默认情况下,将您传递的标志合并到现有配置中; --replace 会覆盖整个块。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--method <method> | 字符串 | 是 | HTTP 方法。 |
--operation <operation> | 字符串 | 否 | 操作标签(List、Retrieve、...)。 |
--operation-id <id> | 字符串 | 否 | 操作标识符。 |
--description <text> | 字符串 | 否 | 方法说明。 |
--path <path> | 字符串 | 否 | 标准资源方法路径。 |
--hidden | 标记 | 否 | 从设计器中隐藏该方法。 |
--has-ceql | 标记 | 否 | 对此方法启用 CEQL。 |
--response-display-name <name> | 字符串 | 否 | 响应显示名称。 |
--response-description <text> | 字符串 | 否 | 响应说明。 |
--replace | 标记 | 否 | 覆盖整个方法配置,而不是合并。删除未重新传递的参数/策划状态。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity method set --resource accounts --method GET \
--operation List --path /accounts --has-ceql
uip is connectors builder activity method set --resource accounts --method GET \
--operation List --path /accounts --has-ceql
数据形状(--输出 json)
{ "Code": "MethodSet", "Data": { "Resource": "accounts", "Method": "GET", "Outcome": "updated" } }
{ "Code": "MethodSet", "Data": { "Resource": "accounts", "Method": "GET", "Outcome": "updated" } }
UIP 是策划的连接器构建器活动方法
将方法提升为独立的 Studio 活动。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--method <method> | 字符串 | 是 | HTTP 方法。 |
--display-name <name> | 字符串 | 是 | Studio 活动显示名称。 |
--name <name> | 字符串 | 否 | 活动标识符。默认为显示名称。 |
--description <text> | 字符串 | 否 | 活动说明。 |
--hidden | 标记 | 否 | 隐藏活动。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
仅发送您实际传递的标志。仅显示名称的调用将合并到现有的策划块中,而不是重置标识符或清空描述。
示例
uip is connectors builder activity method curate --resource accounts --method GET \
--display-name 'List Accounts'
uip is connectors builder activity method curate --resource accounts --method GET \
--display-name 'List Accounts'
数据形状(--输出 json)
{ "Code": "MethodCurated", "Data": { "Resource": "accounts", "Method": "GET", "Curated": {} } }
{ "Code": "MethodCurated", "Data": { "Resource": "accounts", "Method": "GET", "Curated": {} } }
活动参数
在 element.json 中管理资源方法的运行时参数(镜像到标准资源)。
uip 是连接器构建器活动参数列表
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--method <method> | 字符串 | 是 | HTTP 方法。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity param list --resource accounts --method GET
uip is connectors builder activity param list --resource accounts --method GET
数据形状(--输出 json)
{ "Code": "ParamList", "Data": { "Resource": "accounts", "Method": "GET", "Parameters": [] } }
{ "Code": "ParamList", "Data": { "Resource": "accounts", "Method": "GET", "Parameters": [] } }
UIP 是连接器构建器活动参数获取
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--method <method> | 字符串 | 是 | HTTP 方法。 |
--name <name> | 字符串 | 是 | 参数名称。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity param get --resource accounts --method GET --name where
uip is connectors builder activity param get --resource accounts --method GET --name where
数据形状(--输出 json)
{ "Code": "Param", "Data": { "Resource": "accounts", "Method": "GET", "Param": {} } }
{ "Code": "Param", "Data": { "Resource": "accounts", "Method": "GET", "Param": {} } }
UIP 是连接器构建器活动参数“创建”
创建或替换资源方法的参数。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--method <method> | 字符串 | 是 | HTTP 方法。 |
--name <name> | 字符串 | 是 | 参数名称。 |
--vendor-name <name> | 字符串 | 否 | 供应商端参数名称。 |
--type <type> | 字符串 | 是 | 参数类型 — 对于完整类型目录,运行 param create --help,其源自 CLI 的参数类型注册表(--type 接受纯标量类型等值,或 value/configuration 等值用于常量和 1:1配置映射 — 相对于编写挂钩,更喜欢此处使用声明性类型)。 |
--vendor-type <type> | 字符串 | 否 | 供应商端参数类型。 |
--data-type <type> | 字符串 | 否 | 数据类型(string、integer、...)。 |
--vendor-data-type <type> | 字符串 | 否 | 供应商端数据类型。 |
--source <source> | 字符串 | 否 | 参数来源(request、response)。 |
--required | 标记 | 否 | 将该参数标记为“必需”。 |
--description <text> | 字符串 | 否 | 参数说明。 |
--display-name <name> | 字符串 | 否 | 用户界面显示名称。 |
--sort-order <n> | 整数 | 否 | 排序顺序。 |
--enum <json> | JSON | 否 | 允许的值,形状与 field create --enum 相同 — 查询/正文参数可以是静态组合。 |
--enhanced-enum <json> | JSON | 否 | 已标记的选项,形状与 field create --enhanced-enum 相同。 |
--reference <json> / --reference-object / --reference-path / --lookup-value / --lookup-names / --filter-pattern / --display-pattern / --load-by-default / --multi-select / --enable-user-override / --depends-on / --field-actions | — | 否 | 下拉列表/依赖下拉列表标记与 field create 相同 — 请参阅上面的部分。路径或查询参数也可以是下拉列表。 |
--design-position <position> | primary|secondary|none | 否 | 设计位置。 |
--hidden | 标记 | 否 | 在设计器中隐藏参数。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
真正需要 --type;其确切允许的值来自 CLI 自己的参数类型注册表,并由 param create --help 完整打印,因此此页面不会硬编码可能与附带注册表偏差的列表。
示例
uip is connectors builder activity param create --resource accounts --method GET \
--name status --type query --data-type string
uip is connectors builder activity param create --resource accounts --method GET \
--name status --type query --data-type string
数据形状(--输出 json)
{
"Code": "ParamWritten",
"Data": {
"Resource": "accounts",
"Method": "GET",
"ParamName": "status",
"Param": { "name": "status", "type": "query" },
"Outcome": "created",
"SrSynced": true
}
}
{
"Code": "ParamWritten",
"Data": {
"Resource": "accounts",
"Method": "GET",
"ParamName": "status",
"Param": { "name": "status", "type": "query" },
"Outcome": "created",
"SrSynced": true
}
}
Warnings 仅在写入生成任何文件时才存在。
删除 UIP 为连接器构建器活动参数
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--resource <name> | 字符串 | 是 | 资源名称。 |
--method <method> | 字符串 | 是 | HTTP 方法。 |
--name <name> | 字符串 | 是 | 参数名称。 |
--connector-dir <path> | 路径 | 否 | 连接器目录。 |
示例
uip is connectors builder activity param delete --resource accounts --method GET --name status
uip is connectors builder activity param delete --resource accounts --method GET --name status
数据形状(--输出 json)
{
"Code": "ParamRemoved",
"Data": { "Resource": "accounts", "Method": "GET", "ParamName": "status", "SrSynced": true }
}
{
"Code": "ParamRemoved",
"Data": { "Resource": "accounts", "Method": "GET", "ParamName": "status", "SrSynced": true }
}
相关内容
- 连接器构建器— 概念和四个租户生命周期动词。
- 活动挂钩— 附加到资源或全局的 JavaScript 请求前/请求后转换。
- 初始化 & 连接器— 构建此活动所在的连接器。
- 身份验证— 配置连接器的身份验证方案,包括生命周期/系统资源。
- 触发器和状态— 事件触发器和低级别元素文件编辑。
另请参阅
- 大纲
- 概念
- uip 是连接器构建器活动列表
- 选项
- 示例
- 数据形状(--输出 json)
- UIP 是连接器构建器活动“获取”
- 参数
- 选项
- 示例
- 数据形状(--输出 json)
- UIP 是连接器构建器活动,用于创建
- 选项
- 示例
- 数据形状(--输出 json)
- uip 是将连接器构建器活动删除
- 参数
- 选项
- 示例
- 数据形状(--输出 json)
- 活动字段
- uip 是连接器构建器活动字段架构
- uip 是连接器构建器活动字段列表
- UIP 是连接器构建器活动字段获取
- UIP 为连接器构建器活动字段创建
- uip 是将连接器构建活动字段删除
- 活动方法
- UIP 是连接器构建器活动方法获取
- UIP 是连接器构建器活动方法集
- UIP 是策划的连接器构建器活动方法
- 活动参数
- uip 是连接器构建器活动参数列表
- UIP 是连接器构建器活动参数获取
- UIP 是连接器构建器活动参数“创建”
- 删除 UIP 为连接器构建器活动参数
- 相关内容
- 另请参阅