获取自定义对象的元数据旧版SDK

更新于 2023-01-18

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口读取钉钉CRM自定义对象的元数据描述。

什么是自定义对象

自定义对象就是用户自己创建的表单，不包含客户、联系人和跟进记录表单。

在客户管理应用，进入客户管理后台，依次单击内部表单 > 创建表单。

接口功能介绍

用户创建表单之后，调用本接口，可获取该表单内的各个字段详情信息，包含字段ID、字段类型、是否必传等。

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	获取CRM自定义对象数据的接口访问权限	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

基本信息

请求方式：POST

请求地址：https://oapi.dingtalk.com/topapi/crm/objectmeta/describe

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

是

dc73axxxx

调用该接口的应用凭证。

企业内部应用，通过获取企业内部应用的access_token接口获取。

Body参数

名称

类型

是否必填

示例值

描述

name

String

是

PROC-EF1xxxx

自定义表单code，进入表单编辑页面，最下方可查看。

返回参数

名称	类型	示例值	描述
result	DObject		返回结果。
name	String	crm_customer	对象名称。
customized	Boolean	false	是否自定义对象。 true：是 false：不是
fields	Fields[]		字段列表。
name	String	customer_name	字段名称。
customized	Boolean	false	是否自定义字段。 true：是 false：不是
label	String	客户名称	字段展示名。
type	String	Text	字段类型。
nillable	Boolean	false	是否可空。 true：可为空 false：不能为空
format	String	yyyy-MM-dd	日期格式。
unit	String	天	日期单位/金额单位。
select_options	SelectOptions[]		选项列表。
key	String	option_1	选项key。
value	String	选项1	选项名。
quote	Boolean	true	是否引用关联。 true：引用 false：不引用
reference_to	String	crm_contact	关联对象名称。
reference_fields	ReferenceFields[]		引用的关联对象的字段列表。
label	String	联系人名称	引用的关联对象字段显示名。
type	String	Text	引用的关联对象字段类型。
nillable	Boolean	false	引用的关联对象字段是否可空。 true：可为空 false：不能为空
format	String	yyyy-MM-dd	引用的关联对象字段格式。
unit	String	天	引用的关联对象字段单位。
select_options	SelectOptions[]	SelectOptions	引用的关联对象的字段选项列表。
key	String	option_2	引用的关联对象的字段选项key。
value	String	选项2	引用的关联对象的字段选项值。
name	String	crm_customer	引用的关联对象的字段名称。
roll_up_summary_fields	RollUpSummaryFields[]		对MasterDetail类型有效：roll-up summary字段列表。
name	String	Money-XDADDF	需要汇总的明细内字段名。
aggregator	String	SUM	汇总方法。
errcode	Number	0	返回码。
errmsg	String	ok	调用失败时返回的错误信息。