修改数据范式

PATCH

https://open.feishu.cn/open-apis/search/v2/schemas/{schema_id}

修改数据范式。

错误码

HTTP状态码	错误码	描述	排查建议
500	1270001	系统内部错误	联系系统开发人员协助定位
400	1270002	参数错误	根据错误信息和文档排查非法参数
400	1270005	该功能仅对旗舰版可用	请联系销售人员升级套餐以使用此高级功能
400	1273004	记录不存在	检查请求的记录是否真实存在
400	1273005	请求体参数错误或缺失	根据错误信息和文档排查
400	1274002	定义的字段名称重复	修改重复字段
400	1274008	字段和类型不匹配	检查字段的名称是否可以设置为对应类型
400	1274010	字段名称不符合规范	检查对应字段是否包含非法字符和长度是否合规

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://open.feishu.cn/open-apis/search/v2/schemas/' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "display": {
        "card_key": "search_common_card",
        "fields_mapping": [
            {
                "data_field": "${description}",
                "display_field": "summary"
            }
        ]
    }
}'

响应示例

{
    "code": 0,
    "data": {
        "schema": {
            "display": {
                "card_key": "search_common_card",
                "fields_mapping": [
                    {
                        "data_field": "${description}",
                        "display_field": "summary"
                    }
                ]
            },
            "properties": [
                {
                    "is_returnable": true,
                    "is_searchable": true,
                    "name": "description",
                    "search_options": {
                        "enable_camel_match": false,
                        "enable_exact_match": false,
                        "enable_number_suffix_match": false,
                        "enable_prefix_match": false,
                        "enable_semantic_match": true
                    },
                    "type": "text"
                },
                {
                    "is_returnable": true,
                    "name": "icon_url",
                    "type": "text"
                },
                {
                    "name": "rank",
                    "sort_options": {
                        "order": "asc"
                    },
                    "type": "int"
                },
                {
                    "is_returnable": true,
                    "name": "priority",
                    "type": "tag",
                    "type_definitions": {
                        "tag": [
                            {
                                "color": "red",
                                "name": "type",
                                "text": "type"
                            }
                        ]
                    }
                }
            ],
            "schema_id": "example_schema"
        }
    },
    "msg": "success"
}

请求参数

Path 参数

schema_id

string

必需

用户自定义数据范式的唯一标识

示例值："custom_schema_id"

数据校验规则：

最大长度：40 字符

正则校验：^[a-zA-Z][a-zA-Z0-9-_].*$

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

display

object

数据展示相关配置

必需

card_key

string

必需

搜索数据的展示卡片卡片详细信息请参考通用模块接入指南 "请求创建数据范式"部分示例值："search_common_card" 可选值有： search_common_card：普通 common 卡片

fields_mapping

array [object {2}]

必需

数据字段名称和展示字段名称的映射关系。如果没有设置，则只会展示与展示字段名称同名的数据字段

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

data

object

必需

schema

object

数据范式实例

必需

msg

string

错误描述

必需

修改于 2023-02-03 07:33:44

删除数据范式

获取数据范式

修改数据范式

错误码#

请求参数

返回响应

错误码