获取促销对象描述接口
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": "PromotionObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-00b536bf852b4186",
"data": {
"describe": {
"created_by": "-10000",
"icon_index": 20,
"api_name": "PromotionObj",
"display_name_r": "促销",
"fields": {
"lock_rule": {
"describe_api_name": "PromotionObj",
"is_index": false,
"is_active": true,
"create_time": 1529007974675,
"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"
},
"description": {
"describe_api_name": "PromotionObj",
"is_index": false,
"is_active": true,
"create_time": 1555515924400,
"pattern": "",
"is_unique": false,
"label": "促销说明",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "description",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"config": {
"edit": 1,
"attrs": {
"is_readonly": 0,
"is_required": 0,
"max_length": 1
}
},
"index_name": "t_1",
"max_length": 500
},
"type": {
"describe_api_name": "PromotionObj",
"is_index": true,
"is_active": true,
"create_time": 1533827722084,
"is_unique": false,
"label": "促销规则",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "type",
"options": [
{
"not_usable": false,
"label": "打折",
"value": "1"
},
{
"not_usable": false,
"label": "减免",
"value": "2"
},
{
"not_usable": false,
"label": "一口价",
"value": "3"
},
{
"not_usable": false,
"label": "买赠",
"value": "4"
},
{
"not_usable": false,
"label": "满折",
"value": "11"
},
{
"not_usable": false,
"label": "满减",
"value": "12"
},
{
"not_usable": false,
"label": "满赠",
"value": "13"
},
{
"not_usable": false,
"label": "减免(组合)",
"value": "22"
},
{
"not_usable": false,
"label": "打折(组合)",
"value": "21"
},
{
"not_usable": false,
"label": "一口价(组合)",
"value": "23"
},
{
"not_usable": false,
"label": "买赠(组合)",
"value": "24"
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "促销规则",
"index_name": "s_8",
"config": {}
},
请求参数
Body 参数application/json
返回响应
扫码加入交流群