Bes_Open_API
  1. 表结构
Bes_Open_API
  • 开发指南
    • 产品概述
    • 通用项&参数说明
    • 更新日志
  • 鉴权模块(新)
    • openapi-获取token
      POST
  • 线索
    • 市场线索列表V2
      POST
    • 新增/编辑线索
      POST
    • 删除线索
      POST
    • 获取备注列表
      POST
    • 获取线索详情
      POST
    • 新增跟进记录
      POST
    • 获取线索行为事件
      POST
    • 获取线索行为记录
      POST
    • 获取线索分值记录
      POST
    • 市场线索-变更归属人
      POST
    • 批量获取线索分值记录
      POST
    • 表单管理列表
      POST
    • 表单提交数据列表
      POST
    • 获取线索来源
      POST
    • 获取接口数据处理状态(API接口数据)
      POST
  • 标签
    • 标签管理-分组列表
      POST
    • 标签管理-分组创建
      POST
    • 标签管理-分组编辑/删除
      POST
    • 标签管理-标签列表
      POST
    • 标签管理-标签创建
      POST
    • 标签管理-标签/编辑/移动
      POST
    • 对象打标签&移除标签
      POST
    • 获取对象和对象标签(对象ID必传)
      POST
    • 获取对象所有打标签流水(打标签时间倒序)
      POST
  • 分组
    • 分组列表
    • 分组下用户列表
    • 获取对象列表
    • 市场线索移入/移出分组
  • 公司
    • 公司列表V2
    • 公司编辑(单字段)
    • 公司创建
  • 扩展对象(业务机会等)
    • 对象列表
    • 新增/编辑对象
    • 删除对象
    • 记录类型-全部列表
    • 记录类型-根据当前账号权限返回可以的列表
  • 表结构
    • 表结构列表
      POST
    • 表结构详情
      POST
  • 客群
    • 新增/编辑客群数据(仅支持外部数据源)
    • 获取客群对象列表(微信/外部数据源/企微外部联系人)
    • 获取客群列表数据-V2(企微外部联系人,外部数据源、留资客户、访客、潜在客户)
    • 客群字段列表(外部数据源)
  • 行为(新)
    • 新增应用
    • 获取应用
    • 添加事件
    • 获取事件
    • 添加事件属性
    • 获取事件属性
    • 添加属性选项值
    • 添加用户行为
    • 事件关联事件属性
    • 获取所有自定义事件属性
    • 获取浏览访客行为记录
  • 应用中心
    • 公众号管理
      • 获取微信授权链接
      • 根据微信code获取粉丝信息
      • 根据open_id,批量获取粉丝信息
      • 获取微信公众号列表
      • 获取粉丝信息
      • 获取取关粉丝信息
  • 系统管理
    • 获取某个用户信息
    • 获取组织信息
    • 自定义渠道-渠道列表
    • 获取管理员列表
    • 删除管理员
  • 资料下载
    • 资料下载-列表
  • 会议管理
    • 会议管理-列表数据
    • 会议管理-获取报名数据
    • 会议管理-获取签到参会数据
    • 获取分类列表(支持会议管理&资料下载)
    • 会议管理-会议报名
    • 会议管理-会议签到
    • 会议管理-获取会议详情
  • 内容中心
    • 获取内容分类
    • 获取内容列表
    • 获取内容详情
  • 会员管理
    • 会员管理-获取基础信息
    • 会员管理-获取自定义字段
    • 会员管理-变更积分
    • 根据会员id或会员手机号获取会员详细信息
    • 会员/员工(注册/更新)
    • 根据地区名称查询地区id
    • 获取会员/员工列表
    • 根据openid获取会员/员工信息
    • 会员管理-删除会员
  • 企业微信
    • 绑定外部联系人手机&邮箱&unionid
  • 其他
    • 错误码
  • 自动化工作流
    • 关闭工作流
    • 工作流列表
  1. 表结构

表结构详情

POST
/cdp/open-api/detail
客户数据平台(CDP)/CDP/表结构
最后修改时间:2024-03-08 07:13:06

接口描述#

可通过该接口,获取对象表结构详情
企业微信截图_8111e1a0-c9e2-42bf-8a02-2c368b55fbe6.png

请求参数说明#

参数名称参数类型必须说明
idstring否表结构ID
schema_namestring否表结构名称
表结构ID与表结构名称不能同时为空

返回参数说明#

参数名称说明
code返回码
msg错误信息
data数据集

请求参数

Query 参数
access_token
string 
可选
通过 鉴权模块-获取token接口
示例值:
{{access_token}}
Body 参数application/json
id
integer 
可选
表结构ID与表结构名称(schema_name) 不能同时为空
schema_name
string 
可选
表结构ID与表结构名称(schema_name) 不能同时为空
示例
{
    "schema_name":"Marketing"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://openapi.beschannels.com/cdp/open-api/detail?access_token=uURA1lnYsBr22I6UYoLZH0s9y3HU2Xsn7UHA4dIDgHN_67Z5EZskh4YMcymD5enS4GGjWpOERwQtug3Y4AGwvbvLB_A3TwKBpb_J4z0MUm6oaNQmqA-3Ef9Q-PHbVPk3' \
--header 'Content-Type: application/json' \
--data-raw '{
    "schema_name":"Marketing"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
返回码
必需
msg
string 
错误信息
必需
data
object 
数据集
必需
id
integer 
必需
org_id
string 
组织ID
必需
schema_name
string 
表结构名称
必需
display_name
string 
表结构显示名称
必需
template_id
integer 
必需
description
string 
表结构描述
必需
is_input_data
integer 
必需
is_used
integer 
必需
是否启用 1未启用 2启用
is_customer
integer 
必需
schema_type
integer 
必需
is_del
integer 
必需
creator
string 
表结构创建者
必需
create_time
integer 
表结构创建时间
必需
modifier
string 
表结构修改者
必需
modify_time
integer 
表结构修改时间
必需
schema_type_desc
string 
必需
schema_field
array [object {33}] 
字段集
必需
示例
{
    "code": 0,
    "msg": "请求成功",
    "data": {
        "id": 1406,
        "org_id": "org5d31bcdbd4f5f66feaeb990e06d31b23",
        "schema_name": "demo65",
        "display_name": "6.5测试",
        "template_id": 0,
        "description": "",
        "is_input_data": 2,
        "is_used": 1,
        "is_customer": 1,
        "schema_type": 2,
        "is_del": 1,
        "creator": "XXX",
        "create_time": 1697725599,
        "modifier": "XXX",
        "modify_time": 1699334196,
        "schema_type_desc": "",
        "schema_field": [
            {
                "id": 63656,
                "add_rule": [],
                "default_value": "",
                "description": "致趣百川自定义对象系统字段组,此字段分组不可自定义字段分组显示名称及描述,组内字段不可删除或移动至其他字段分组",
                "display_name": "系统字段",
                "field_name": "SystemFields",
                "field_parent_id": 0,
                "field_type": "",
                "identity_field_id": "",
                "is_field_group": 2,
                "is_identity": 1,
                "is_option": 1,
                "is_required": 1,
                "minus_rule": [],
                "num_range": null,
                "options": [],
                "placeholder": "",
                "primary_identity": 1,
                "schema_id": 1406,
                "sort": 1,
                "is_system": 1,
                "field_category": "",
                "field_editor_type": "",
                "group_editor_type": "system",
                "child": [
                    {
                        "id": 63657,
                        "add_rule": [],
                        "default_value": "",
                        "description": "创建或导入自定义对象数据的系统用户",
                        "display_name": "创建人",
                        "field_name": "CreatedBy",
                        "field_parent_id": 63656,
                        "field_type": "Select",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 2,
                        "is_system": 1,
                        "field_category": "sys_users",
                        "field_editor_type": "forbid",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 2,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 2
                    },
                    {
                        "id": 63658,
                        "add_rule": [],
                        "default_value": null,
                        "description": "创建或导入自定义对象的时间",
                        "display_name": "创建时间",
                        "field_name": "CreatedTime",
                        "field_parent_id": 63656,
                        "field_type": "DateTime",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 3,
                        "is_system": 1,
                        "field_category": "",
                        "field_editor_type": "forbid",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 2,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 2
                    },
                    {
                        "id": 63659,
                        "add_rule": [],
                        "default_value": "",
                        "description": "最近编辑、自定义对象数据的系统用户",
                        "display_name": "最近修改人",
                        "field_name": "UpdatedBy",
                        "field_parent_id": 63656,
                        "field_type": "Select",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 4,
                        "is_system": 1,
                        "field_category": "sys_users",
                        "field_editor_type": "forbid",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 2,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 2
                    },
                    {
                        "id": 63660,
                        "add_rule": [],
                        "default_value": null,
                        "description": "最近编辑、更新自定义对象数据的时间",
                        "display_name": "最近修改时间",
                        "field_name": "UpdatedDate",
                        "field_parent_id": 63656,
                        "field_type": "DateTime",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 5,
                        "is_system": 1,
                        "field_category": "",
                        "field_editor_type": "forbid",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 2,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 2
                    }
                ],
                "forbid_manual_input_company": 0,
                "is_mask": 2,
                "allow_mask": 2,
                "field_auth": 1,
                "field_auth_info": [],
                "is_track": 2,
                "field_data_update_auth": 1
            },
            {
                "id": 63661,
                "add_rule": [],
                "default_value": "",
                "description": "致趣百川系统预置自定义字段分组",
                "display_name": "未分组",
                "field_name": "Ungrouped",
                "field_parent_id": 0,
                "field_type": "",
                "identity_field_id": "",
                "is_field_group": 2,
                "is_identity": 1,
                "is_option": 1,
                "is_required": 1,
                "minus_rule": [],
                "num_range": null,
                "options": [],
                "placeholder": "",
                "primary_identity": 1,
                "schema_id": 1406,
                "sort": 6,
                "is_system": 2,
                "field_category": "",
                "field_editor_type": "",
                "group_editor_type": "",
                "child": [
                    {
                        "id": 63662,
                        "add_rule": [],
                        "default_value": "",
                        "description": "",
                        "display_name": "姓名",
                        "field_name": "name",
                        "field_parent_id": 63661,
                        "field_type": "Text",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": {
                            "min": "1",
                            "max": "255"
                        },
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 7,
                        "is_system": 2,
                        "field_category": "",
                        "field_editor_type": "",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 1,
                        "field_auth": 1,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 1
                    },
                    {
                        "id": 63664,
                        "add_rule": [],
                        "default_value": "",
                        "description": "",
                        "display_name": "手机号",
                        "field_name": "mobile",
                        "field_parent_id": 63661,
                        "field_type": "PhoneNumber",
                        "identity_field_id": "PhoneNumber",
                        "is_field_group": 1,
                        "is_identity": 2,
                        "is_option": 1,
                        "is_required": 2,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 2,
                        "schema_id": 1406,
                        "sort": 8,
                        "is_system": 2,
                        "field_category": "",
                        "field_editor_type": "",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 1,
                        "field_auth": 1,
                        "field_auth_info": [],
                        "is_track": 1,
                        "field_data_update_auth": 1
                    },
                    {
                        "id": 64926,
                        "add_rule": [],
                        "default_value": "",
                        "description": "",
                        "display_name": "邮箱",
                        "field_name": "email",
                        "field_parent_id": 63661,
                        "field_type": "Email",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 9,
                        "is_system": 2,
                        "field_category": "",
                        "field_editor_type": "",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 1,
                        "field_auth": 1,
                        "field_auth_info": [],
                        "is_track": 1,
                        "field_data_update_auth": 1
                    },
                    {
                        "id": 64940,
                        "add_rule": [],
                        "default_value": "",
                        "description": "",
                        "display_name": "日期时间",
                        "field_name": "dtime",
                        "field_parent_id": 63661,
                        "field_type": "DateTime",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 10,
                        "is_system": 2,
                        "field_category": "",
                        "field_editor_type": "",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 1,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 1
                    },
                    {
                        "id": 64941,
                        "add_rule": [],
                        "default_value": "",
                        "description": "",
                        "display_name": "日期",
                        "field_name": "dtime1",
                        "field_parent_id": 63661,
                        "field_type": "Date",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 1,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 11,
                        "is_system": 2,
                        "field_category": "",
                        "field_editor_type": "",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 1,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 1
                    },
                    {
                        "id": 64942,
                        "add_rule": [],
                        "default_value": "",
                        "description": "",
                        "display_name": "下拉",
                        "field_name": "xiala",
                        "field_parent_id": 63661,
                        "field_type": "Select",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 2,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [
                            {
                                "label": "A",
                                "value": "1",
                                "isShow": true,
                                "web_key_id": "4UBm2vAdKO"
                            },
                            {
                                "label": "B",
                                "value": "2",
                                "isShow": true,
                                "web_key_id": "b3rNZLz5aJ"
                            }
                        ],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 12,
                        "is_system": 2,
                        "field_category": "",
                        "field_editor_type": "",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 1,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 1
                    },
                    {
                        "id": 64943,
                        "add_rule": [],
                        "default_value": "",
                        "description": "",
                        "display_name": "多选",
                        "field_name": "duoxuan",
                        "field_parent_id": 63661,
                        "field_type": "CheckBox",
                        "identity_field_id": "",
                        "is_field_group": 1,
                        "is_identity": 1,
                        "is_option": 2,
                        "is_required": 1,
                        "minus_rule": [],
                        "num_range": null,
                        "options": [
                            {
                                "label": "A",
                                "value": "1",
                                "isShow": true,
                                "web_key_id": "RYfnEuyTrO"
                            },
                            {
                                "label": "B",
                                "value": "2",
                                "isShow": true,
                                "web_key_id": "B9jAqvQBId"
                            },
                            {
                                "label": "C",
                                "value": "3",
                                "isShow": true,
                                "web_key_id": "ln351UbJUf"
                            }
                        ],
                        "placeholder": "",
                        "primary_identity": 1,
                        "schema_id": 1406,
                        "sort": 13,
                        "is_system": 2,
                        "field_category": "",
                        "field_editor_type": "",
                        "group_editor_type": "",
                        "forbid_manual_input_company": 0,
                        "is_mask": 2,
                        "allow_mask": 2,
                        "field_auth": 1,
                        "field_auth_info": [],
                        "is_track": 2,
                        "field_data_update_auth": 1
                    }
                ],
                "forbid_manual_input_company": 0,
                "is_mask": 2,
                "allow_mask": 2,
                "field_auth": 1,
                "field_auth_info": [],
                "is_track": 2,
                "field_data_update_auth": 1,
                "no_delete": 1
            }
        ]
    }
}
上一页
表结构列表
下一页
新增/编辑客群数据(仅支持外部数据源)
Built with