获取CRM客户对象的元数据

说明

调用本接口获取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	系统错误

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

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"
        }
      ]
    }
  ]
}

获取CRM客户对象的元数据

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码