获取CRM客户对象的元数据
GET
/v1.0/crm/personalCustomers/objectMeta最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口获取CRM客户对象的元数据描述。
服务地址:api.dingtalk.com
权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 获取CRM主数据的接口访问权限 | API Explorer |
第三方企业应用 | 支持 | 获取CRM主数据的接口访问权限 | API Explorer |
第三方个人应用 | 暂不支持 | 获取CRM主数据的接口访问权限 | 暂不支持 |
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | invalidParam | invalid param, %s | 参数非法 |
400 | systemError.notPermittedAccess | system error, %s | 无权限操作 |
500 | systemError | system error | 系统错误 |
500 | systemError | system error, %s | 系统错误 |
请求参数
Header 参数
x-acs-dingtalk-access-token
string
必需
调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。
Body 参数application/json
object {0}
示例
{}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
name
string
对象名称。
customized
boolean
是否自定义对象。
fields
array [object {12}]
字段列表。
name
string
字段名称。
customized
boolean
是否自定义字段。
label
string
字段展示名。
type
string
字段类型。
nillable
boolean
是否可空。
format
string
日期格式。
unit
string
可选
日期单位或金额单位。
selectOptions
array [object {2}]
选项列表。
quote
boolean
是否引用关联。
referenceTo
string
关联对象名称。
referenceFields
array [object {7}]
可选
引用的关联对象的字段列表。
rollUpSummaryFields
array [object {2}]
可选
对MasterDetail类型有效。
示例
{
"name": "string",
"customized": true,
"fields": [
{
"name": "string",
"customized": true,
"label": "string",
"type": "string",
"nillable": true,
"format": "string",
"unit": "string",
"selectOptions": [
{
"key": "string",
"value": "string"
}
],
"quote": true,
"referenceTo": "string",
"referenceFields": [
{
"label": "string",
"type": "string",
"nillable": true,
"unit": "string",
"format": "string",
"selectOptions": [
{
"key": "string",
"value": "string"
}
],
"name": "string"
}
],
"rollUpSummaryFields": [
{
"name": "string",
"aggregator": "string"
}
]
}
]
}
最后修改时间: 2 年前