乐享知识库接口文档

# 编辑自定义属性

请求URL

PUT https://lxapi.lexiangla.com/cgi-bin/v1/kb/properties/{id}/schema

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"
x-staff-id 是 成员帐号，作为设置者需具有操作权限
若不希望指定设置者或忽略权限校验，可设置为固定值："system-bot"

其他说明

事项 说明
权限要求 自定义属性管理
授权范围 AppKey绑定团队时，入参id自定义属性需在授权的团队下
频率限制 3000次/分钟

URL 参数说明

参数 是否必须 说明
id 是 自定义属性ID

请求参数

{
  "data": {
    "attributes": {
      "name": "分类",
      "description": "分类描述",
      "multiple": false,
      "only_leaf": false,
      "default_value": "a/b",
      "options": [
        {
          "key": "hjdhs34hfgs",
          "value": "a",
          "children": [
            {
              "key": "1i0fnu398pd",
              "value": "b",
              "children": [
                {
                  "key": "4l9zp4y0jp5",
                  "value": "c",
                  "children": [
                    {
                      "key": "a71b6n5rq6v",
                      "value": "d",
                      "children": [
                        {
                          "key": "a71b6n5rq67",
                          "value": "e"
                        },
                        {
                          "key": "a71b6n5rqdd",
                          "value": "f"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "key": "6zd03auqbet",
          "value": "1",
          "children": [
            {
              "key": "kric8lq5gup",
              "value": "2"
            }
          ]
        }
      ]
    }
  }
}

参数说明

参数 说明
name 属性名称
description 属性备注、描述
multiple bool值为true表示多选：
文本类型表示文本可以是多行文本;
选项类型表示是多选;
only_leaf bool值为true表示仅可选择叶子节点，注意:仅分类类型有效，表示只能选择分类末尾的子节点
default_value 默认值
文本类型填写字符串 例:"text";
单选类型填写选项字符串 例: "a";
多选类型填写选项字符数组 例: ["a", "b"];
分类类型填写当前选择的path路径 例: "路径1/路径2/路径3"；
options 选项，注意:文本类型无效
选项类型表包含的选项;
分类类型表示包含的分类;
options[].key 选项或者分类的唯一标识，可用于更新该选项的value，该值被用于站内的搜索，知识属性的设置。 如果更新时候key值不正确或者没有填写，则新增选项且key由乐享后台生成。如需更新某个子选项的值，需确保父路径的所有key值都正确
options[].value 选项或者分类的值
options[].children 仅分类类型有效，分类的嵌套子类，数据结构等同 options
relationships.owner 属性创建者，可根据 id 在 included 中查找

响应

200 Ok 状态码

← 操作日志接口 →