获取合同对象对象描述接口
POST
https://open.fxiaoke.com/cgi/crm/v2/object/describe
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.fxiaoke.com/cgi/crm/v2/object/describe' \
--header 'Content-Type: application/json' \
--data-raw '{
"corpAccessToken": "${corpAccessToken}",
"corpId": "${corpId}",
"currentOpenUserId": "${currentOpenUserId}",
"includeDetail": true,
"apiName": "ContractObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-8bd67dcc13c44e5d",
"data": {
"describe": {
"api_name": "ContractObj",
"display_name_r": "合同",
"fields": {
"contract_amount": {
"describe_api_name": "ContractObj",
"is_index": true,
"is_active": true,
"create_time": 1559274422868,
"length": 14,
"description": "合同金额（元）",
"is_unique": false,
"label": "合同金额（元）",
"type": "currency",
"currency_unit": "￥",
"decimal_places": 2,
"is_need_convert": false,
"is_required": true,
"api_name": "contract_amount",
"define_type": "package",
"is_single": false,
"label_r": "合同金额",
"is_index_field": false,
"index_name": "d_1",
"config": {
"edit": 1,
"attrs": {
"wheres": 1,
"is_required": 0,
"default_value": 1,
"label": 1,
"help_text": 1,
"max_length": 1,
"decimal_places": 1
}
},
"round_mode": 4,
"max_length": 16
},
"lock_rule": {
"describe_api_name": "ContractObj",
"is_index": false,
"is_active": true,
"create_time": 1560615275557,
"description": "锁定规则",
"is_unique": false,
"default_value": "default_lock_rule",
"rules": [],
"label": "锁定规则",
"type": "lock_rule",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_rule",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "s_4"
},
"expired_time": {
"describe_api_name": "ContractObj",
"is_index": true,
"is_active": true,
"create_time": 1559274422868,
"description": "截止日期",
"is_unique": false,
"label": "截止日期",
"time_zone": "GMT+8",
"type": "date",
"is_need_convert": false,
"is_required": true,
"api_name": "expired_time",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_index_field": false,
"is_single": false,
"label_r": "截止日期",
"config": {
"edit": 1,
"enable": 1,
"attrs": {
"wheres": 1,
"default_value": 1,
"label": 1,
"help_text": 1
}
},
"index_name": "l_1"
},
"UDTel1__c": {
"describe_api_name": "ContractObj",
"is_index": true,
"is_active": true,
"create_time": 1559274422868,
"pattern": "^[0-9+\\-;,]{0,100}$",
"description": "自定义电话",
"is_unique": false,
"label": "自定义电话",
"type": "phone_number",
"field_num": 321,
"is_need_convert": false,
"is_required": false,
"api_name": "UDTel1__c",
"define_type": "custom",
"is_extend": true,
"is_index_field": false,
"is_single": false,
"index_name": "p_1"
},
"lock_user": {
"describe_api_name": "ContractObj",
"is_index": false,
"is_active": true,
"create_time": 1560615275557,
"description": "加锁人",
"is_unique": false,
"label": "加锁人",
"type": "employee",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_user",
"define_type": "package",
"is_index_field":请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-03-02 10:03:06