自定义模块数据管理

新增记录

• API 地址：customentity/add
• HTTP 方法：POST
• 授权方式：通用授权

请求参数

参数	类型	是否必须	参数说明
op_user	string(40)	是	操作用户ID。可通过 用户列表 接口获取
entity	string	是	自定义模块内部名称，如 c__lead，可通过 元数据 接口获取
POST流	json(map)	是	POST 方法提交的流数据，字段与值的键值对，例如 {"c__name":"企能软件"} 字段可通过 元数据 接口获取

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "record_id": "xxx"
  }
}

返回数据说明

字段	类型	字段说明
record_id	string(40)	新增记录的唯一ID，为 40 位 hash 字符串

获取单条记录

• API 地址：customentity/get
• HTTP 方法：GET
• 授权方式：通用授权

请求参数

参数	类型	是否必须	参数说明
op_user	string(40)	是	操作用户ID。可通过 用户列表 接口获取
record_id	string(40)	是	要获取的记录ID
entity	string	是	自定义模块内部名称，如 c__lead，可通过 元数据 接口获取
fields	string	是	要获取的字段列表，多个字段以逗号（,）分隔 字段可通过 元数据 接口获取

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "c__name": "企能软件",
    "c__phone": "021-34240127"
  }
}

返回数据说明

字段	类型	字段说明
data	json(map)	数据以键值对的形式放置在此字段

查询记录列表

• API 地址：customentity/list
• HTTP 方法：GET
• 授权方式：通用授权

请求参数

参数	类型	是否必须	参数说明
op_user	string(40)	是	操作用户。可通过 用户列表 接口获取
entity	string	是	自定义模块内部名称，如 c__lead，可通过 元数据 接口获取
fields	string	是	要查询的字段列表，多个字段以逗号（,）分隔 字段请通过 元数据 接口获取
qname	string	否	查询主显字段（name_field），支持使用星号模糊匹配，如 *企能软件 将查询以企能软件结尾的客户。如需更复杂的查询请参考 高级查询接口
page_no	int	否	页码，默认 1
page_size	int	否	页大小，默认 20，最大 200

此接口暂不支持排序参数，默认顺序为记录创建时间由近到远，如需使用排序请参考 高级查询接口

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "total_size": 10000,
  "page_size": 20,
  "page_no": 1,
  "data": [
    { "c__leadId": "xxx", "c__name": "企能软件", "c__phone": "021-34240127" },
    { "c__leadId": "xxx", "c__name": "企能软件", "c__phone": "021-34240127" }
  ]
}

返回数据说明

字段	类型	字段说明
total_size	int	总记录数
page_size	int	查询的页大小
page_no	int	查询的页码
data	json(array)	数据以 数组->键值对 的形式放置在此字段

修改记录

• API 地址：customentity/update
• HTTP 方法：POST
• 授权方式：通用授权

请求参数

参数	类型	是否必须	参数说明
op_user	string(40)	是	操作用户ID。可通过 用户列表 接口获取
record_id	string(40)	是	要修改的记录ID
entity	string	是	自定义模块内部名称，如 c__lead，可通过 元数据 接口获取
POST流	json(map)	是	POST 方法提交的流数据，字段与值的键值对，例如 {"c__phone":"021-54590135"} 字段请通过 元数据 接口获取

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "record_id": "xxx"
  }
}

返回数据说明

字段	类型	字段说明
record_id	string(40)	被修改的记录ID

删除记录

• API 地址：customentity/delete
• HTTP 方法：POST
• 授权方式：通用授权

请求参数

参数	类型	是否必须	参数说明
op_user	string(40)	是	操作用户ID。可通过 用户列表 接口获取
record_id	string(40)	是	要删除的记录ID
entity	string	是	自定义模块内部名称，如 c__lead，可通过 元数据 接口获取
cascade_delete	string	否	级联删除选项，详情参照 级联删除

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "record_id": "xxx"
  }
}

返回数据说明

字段	类型	字段说明
record_id	string(40)	被删除的记录ID