获取商机2.0对象描述接口
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": "NewOpportunityObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-e771f0c1680b4db8",
"data": {
"describe": {
"created_by": "-1000",
"icon_index": 12,
"api_name": "NewOpportunityObj",
"display_name_r": "商机2.0",
"fields": {
"lock_rule": {
"describe_api_name": "NewOpportunityObj",
"is_index": false,
"is_active": true,
"create_time": 1547706693515,
"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,
"label_r": "锁定规则",
"index_name": "s_4"
},
"close_date": {
"describe_api_name": "NewOpportunityObj",
"default_is_expression": true,
"is_index": true,
"is_active": true,
"create_time": 1553570568247,
"is_unique": false,
"default_value": "$currentDate__g$+DAYS(8)",
"label": "预计成交日期",
"type": "date",
"time_zone": "GMT+8",
"default_to_zero": false,
"is_required": true,
"api_name": "close_date",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_single": false,
"label_r": "预计成交日期",
"is_index_field": false,
"index_name": "l_1",
"config": {
"add": 1,
"edit": 1,
"enable": 1,
"display": 1,
"remove": 1,
"attrs": {
"api_name": 1,
"is_unique": 1,
"default_value": 1,
"label": 1,
"help_text": 1
}
}
},
"field_SF9aR__c": {
"describe_api_name": "NewOpportunityObj",
"is_index": true,
"is_active": true,
"create_time": 1595335363042,
"is_unique": false,
"label": "国家",
"type": "country",
"field_num": 1,
"used_in": "component",
"is_required": false,
"api_name": "field_SF9aR__c",
"options": [],
"define_type": "custom",
"is_extend": true,
"is_index_field": false,
"is_single": false,
"index_name": "s_11",
"config": {},
"help_text": ""
},
"extend_obj_data_id": {
"describe_api_name": "NewOpportunityObj",
"default_is_expression": false,
"is_index": false,
"is_active": true,
"create_time": 1547706693532,
"pattern": "",
"description": "extend_obj_data_id",
"is_unique": false,
"default_value": "",
"label": "extend_obj_data_id",
"type": "text",
"default_to_zero": false,
"is_required": false,
"api_name": "extend_obj_data_id",
"define_type": "system",
"is_extend": false,
"is_single": false,
"label_r": "extend_obj_data_id",
"is_index_field": false,
"index_name": "t_1",
"max_length": 100
},
"cost_time": {
"describe_api_name": "NewOpportunityObj",
"expression_type": "js",
"return_type": "number",
"description": "结单周期",
"is_unique": false,
"type": "formula",
"decimal_places": 0,
"default_to_zero": true,
"is_required": false,
"define_type": "package",
"is_single": false,
"index_name": "d_2",
"max_length": 14,
"is_index请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-02-23 06:35:42