自定義模塊數(shù)據(jù)管理

新增記錄

• API 地址：customentity/add
• HTTP 方法：POST
• 授權(quán)方式：通用授權(quán)

請求參數(shù)

參數(shù)	類型	是否必須	參數(shù)說明
op_user	string(40)	是	操作用戶ID。可通過 用戶列表 接口獲取
entity	string	是	自定義模塊內(nèi)部名稱，如 c__lead，可通過 元數(shù)據(jù) 接口獲取
POST流	json(map)	是	POST 方法提交的流數(shù)據(jù)，字段與值的鍵值對，例如 {"c__name":"企能軟件"} 字段可通過 元數(shù)據(jù) 接口獲取

返回數(shù)據(jù)示例

{
  "error_code": 0,
  "error_msg": "調(diào)用成功",
  "data": {
    "record_id": "xxx"
  }
}

返回數(shù)據(jù)說明

字段	類型	字段說明
record_id	string(40)	新增記錄的唯一ID，為 40 位 hash 字符串

獲取單條記錄

• API 地址：customentity/get
• HTTP 方法：GET
• 授權(quán)方式：通用授權(quán)

請求參數(shù)

參數(shù)	類型	是否必須	參數(shù)說明
op_user	string(40)	是	操作用戶ID。可通過 用戶列表 接口獲取
record_id	string(40)	是	要獲取的記錄ID
entity	string	是	自定義模塊內(nèi)部名稱，如 c__lead，可通過 元數(shù)據(jù) 接口獲取
fields	string	是	要獲取的字段列表，多個字段以逗號（,）分隔 字段可通過 元數(shù)據(jù) 接口獲取

返回數(shù)據(jù)示例

{
  "error_code": 0,
  "error_msg": "調(diào)用成功",
  "data": {
    "c__name": "企能軟件",
    "c__phone": "021-34240127"
  }
}

返回數(shù)據(jù)說明

字段	類型	字段說明
data	json(map)	數(shù)據(jù)以鍵值對的形式放置在此字段

查詢記錄列表

• API 地址：customentity/list
• HTTP 方法：GET
• 授權(quán)方式：通用授權(quán)

請求參數(shù)

參數(shù)	類型	是否必須	參數(shù)說明
op_user	string(40)	是	操作用戶。可通過 用戶列表 接口獲取
entity	string	是	自定義模塊內(nèi)部名稱，如 c__lead，可通過 元數(shù)據(jù) 接口獲取
fields	string	是	要查詢的字段列表，多個字段以逗號（,）分隔 字段請通過 元數(shù)據(jù) 接口獲取
qname	string	否	查詢主顯字段（name_field），支持使用星號模糊匹配，如 *企能軟件 將查詢以企能軟件結(jié)尾的客戶。如需更復(fù)雜的查詢請參考 高級查詢接口
page_no	int	否	頁碼，默認(rèn) 1
page_size	int	否	頁大小，默認(rèn) 20，最大 200

此接口暫不支持排序參數(shù)，默認(rèn)順序?yàn)橛涗泟?chuàng)建時間由近到遠(yuǎn)，如需使用排序請參考 高級查詢接口

返回數(shù)據(jù)示例

{
  "error_code": 0,
  "error_msg": "調(diào)用成功",
  "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" }
  ]
}

返回數(shù)據(jù)說明

字段	類型	字段說明
total_size	int	總記錄數(shù)
page_size	int	查詢的頁大小
page_no	int	查詢的頁碼
data	json(array)	數(shù)據(jù)以 數(shù)組->鍵值對 的形式放置在此字段

修改記錄

• API 地址：customentity/update
• HTTP 方法：POST
• 授權(quán)方式：通用授權(quán)

請求參數(shù)

參數(shù)	類型	是否必須	參數(shù)說明
op_user	string(40)	是	操作用戶ID。可通過 用戶列表 接口獲取
record_id	string(40)	是	要修改的記錄ID
entity	string	是	自定義模塊內(nèi)部名稱，如 c__lead，可通過 元數(shù)據(jù) 接口獲取
POST流	json(map)	是	POST 方法提交的流數(shù)據(jù)，字段與值的鍵值對，例如 {"c__phone":"021-54590135"} 字段請通過 元數(shù)據(jù) 接口獲取

返回數(shù)據(jù)示例

{
  "error_code": 0,
  "error_msg": "調(diào)用成功",
  "data": {
    "record_id": "xxx"
  }
}

返回數(shù)據(jù)說明

字段	類型	字段說明
record_id	string(40)	被修改的記錄ID

刪除記錄

• API 地址：customentity/delete
• HTTP 方法：POST
• 授權(quán)方式：通用授權(quán)

請求參數(shù)

參數(shù)	類型	是否必須	參數(shù)說明
op_user	string(40)	是	操作用戶ID。可通過 用戶列表 接口獲取
record_id	string(40)	是	要刪除的記錄ID
entity	string	是	自定義模塊內(nèi)部名稱，如 c__lead，可通過 元數(shù)據(jù) 接口獲取
cascade_delete	string	否	級聯(lián)刪除選項(xiàng)，詳情參照 級聯(lián)刪除

返回數(shù)據(jù)示例

{
  "error_code": 0,
  "error_msg": "調(diào)用成功",
  "data": {
    "record_id": "xxx"
  }
}

返回數(shù)據(jù)說明

字段	類型	字段說明
record_id	string(40)	被刪除的記錄ID