获取自定义对象的元数据

POST

/topapi/crm/objectmeta/describe

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

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

什么是自定义对象

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

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

接口功能介绍

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

权限

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

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

请求参数

Query 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://oapi.dingtalk.com/topapi/crm/objectmeta/describe?access_token=dc73axxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
        "name":"PROC-EF1xxxx"
}'

响应示例

{
    "result": {
        "customized": false,
        "name": "crm_customer",
        "fields": [
            {
                "reference_fields": [
                    {
                        "unit": "天",
                        "select_options": [
                            {
                                "value": "选项2",
                                "key": "option_2"
                            }
                        ],
                        "format": "yyyy-MM-dd",
                        "name": "crm_customer",
                        "label": "联系人名称",
                        "type": "Text",
                        "nillable": false
                    }
                ],
                "unit": "天",
                "customized": false,
                "quote": true,
                "reference_to": "crm_contact",
                "select_options": [
                    {
                        "value": "选项1",
                        "key": "option_1"
                    }
                ],
                "roll_up_summary_fields": [
                    {
                        "aggregator": "SUM",
                        "name": "Money-XDADDF"
                    }
                ],
                "name": "customer_name",
                "format": "yyyy-MM-dd",
                "label": "客户名称",
                "type": "Text",
                "nillable": false
            }
        ]
    },
    "errcode": 0,
    "errmsg": "ok"
}

修改于 2024-01-18 08:46:51

更新自定义对象数据

根据指定条件查询自定义对象数据

获取自定义对象的元数据

什么是自定义对象#

接口功能介绍#

权限#

请求参数

返回响应

什么是自定义对象

接口功能介绍

权限