获取自定义对象的元数据
POST
/topapi/crm/objectmeta/describe最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口读取钉钉CRM自定义对象的元数据描述。
服务地址:https://oapi.dingtalk.com
权限
服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 是 | 开发者后台申请 | 调试 |
第三方企业应用 | 否 | — | — |
第三方个人应用 | 否 | — | — |
请求参数
Query 参数
access_token
string
必需
调用服务端接口的授权凭证,可通过调用access_token接口获得。
示例值:
dc73axxxx
Body 参数application/json
name
string
目标名称。
示例
{
"name": "PROC-EF1xxxx"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
result
object
返回结果。
name
string
对象名称。
customized
boolean
是否自定义对象。
fields
array [object {12}]
字段列表。
errcode
number
返回码。
errmsg
string
可选
调用失败时返回的错误信息。
示例
{
"result": {
"name": "string",
"customized": true,
"fields": [
{
"name": "string",
"customized": true,
"label": "string",
"type": "string",
"nillable": true,
"format": "string",
"unit": "string",
"select_options": [
{
"key": "string",
"value": "string"
}
],
"quote": true,
"reference_to": "string",
"reference_fields": [
{
"label": "string",
"type": "string",
"nillable": true,
"format": "string",
"unit": "string",
"select_options": [
{
"key": "string",
"value": "string"
}
],
"name": "string"
}
],
"roll_up_summary_fields": [
{
"name": "string",
"aggregator": "string"
}
]
}
]
},
"errcode": 0,
"errmsg": "string"
}
最后修改时间: 2 年前