获取会员对象描述接口
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": "MemberObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-5a4a417036fa425e",
"data": {
"describe": {
"created_by": "1453",
"icon_index": 10,
"api_name": "MemberObj",
"fields": {
"birthday": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626446914,
"is_unique": false,
"label": "生日",
"time_zone": "GMT+8",
"type": "date",
"is_required": false,
"api_name": "birthday",
"define_type": "package",
"date_format": "yyyy-MM-dd",
"is_index_field": false,
"is_single": false,
"index_name": "l_1"
},
"country": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626447170,
"is_unique": false,
"label": "国家",
"type": "country",
"used_in": "component",
"is_required": false,
"api_name": "country",
"options": [],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "s_8",
"config": {},
"help_text": ""
},
"lock_rule": {
"describe_api_name": "MemberObj",
"is_index": false,
"is_active": true,
"create_time": 1599447650811,
"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_1"
},
"gender": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626446200,
"is_unique": false,
"label": "性别",
"type": "select_one",
"is_required": false,
"api_name": "gender",
"options": [
{
"not_usable": false,
"label": "男",
"value": "male"
},
{
"not_usable": false,
"label": "女",
"value": "female"
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "s_7",
"config": {},
"help_text": ""
},
"city": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626447170,
"is_unique": false,
"label": "市",
"type": "city",
"used_in": "component",
"is_required": false,
"api_name": "city",
"options": [],
"define_type": "package",
"cascade_parent_api_name": "province",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "s_9",
"config": {},
"help_text": ""
},
"lock_user": {
"describe_api_name": "MemberObj",
"is_index": false,
"is_active": true,
"create_time": 1599447650811,
"description": "加锁人",
"is_unique": false,
"label": "加锁人",
"type": "employee",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_user",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"index_name": "a_1"
},
"extend_obj_data_id": {
"describe_api_name": "MemberObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1599447650770,
"pattern": "",
"is_unique": false,
"label": "extend_obj_data_id",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "extend_obj_data_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "t_1",
"max_length": 256
},
"is_deleted": {
"describe_api_name": "MemberObj",
"is_index": false,
"create_time": 1599447650822,
"is_unique": false,
"description": "is_deleted",
"default_value": false,
"label": "is_deleted",
"type": "true_or_false",
"is_need_convert": false,
"is_required": false,
"api_name": "is_deleted",
"define_type": "system",
"index_name": "is_del"
},
"province": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626447170,
"is_unique": false,
"label": "省",
"type": "province",
"used_in": "component",
"is_required": false,
"api_name": "province",
"options": [],
"define_type": "package",
"cascade_parent_api_name": "country",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "s_10",
"config": {},
"help_text": ""
},
"card_no": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626444892,
"pattern": "",
"is_unique": true,
"label": "会员卡号",
"type": "text",
"is_required": false,
"api_name": "card_no",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "t_3",
"max_length": 256
},
"grade_id": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650817,
"is_unique": false,
"label": "等级名称",
"target_api_name": "MemberGradeObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_member_grade__c",
"target_related_list_label": "会员",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": false,
"api_name": "grade_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"is_index_field": true,
"index_name": "s_4"
},
"life_status_before_invalid": {
"describe_api_name": "MemberObj",
"is_index": false,
"is_active": true,
"create_time": 1599447650811,
"pattern": "",
"description": "作废前生命状态",
"is_unique": false,
"label": "作废前生命状态",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "life_status_before_invalid",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "t_2",
"max_length": 256
},
"owner_department": {
"describe_api_name": "MemberObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1599447650770,
"pattern": "",
"is_unique": false,
"label": "负责人所在部门",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "owner_department",
"define_type": "package",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "owner_dept",
"max_length": 256
},
"out_owner": {
"describe_api_name": "MemberObj",
"is_index": false,
"is_active": true,
"create_time": 1599447650822,
"is_unique": false,
"label": "外部负责人",
"type": "employee",
"is_need_convert": false,
"is_required": false,
"api_name": "out_owner",
"define_type": "system",
"is_single": true,
"index_name": "o_owner",
"config": {
"display": 1
}
},
"email": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626445315,
"is_unique": false,
"label": "邮箱",
"type": "email",
"is_required": false,
"api_name": "email",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "w_1",
"help_text": ""
},
"owner": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650816,
"is_unique": false,
"label": "负责人",
"type": "employee",
"is_need_convert": false,
"is_required": true,
"api_name": "owner",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": true,
"index_name": "owner"
},
"integral_value": {
"describe_api_name": "MemberObj",
"return_type": "number",
"is_unique": false,
"type": "count",
"decimal_places": 2,
"sub_object_describe_apiname": "MemberIntegralDetailObj",
"is_required": false,
"wheres": [
{
"connector": "OR",
"filters": [
{
"fieldName": "life_status",
"connector": "AND",
"objectReference": false,
"fieldValues": [
"normal"
],
"fieldNum": 0,
"operator": "EQ"
}
]
}
],
"define_type": "package",
"is_extend": false,
"is_single": false,
"index_name": "d_1",
"field_api_name": "member_id",
"is_index": false,
"is_active": true,
"create_time": 1599447650765,
"count_type": "sum",
"count_field_api_name": "change_integral_value",
"label": "积分",
"is_need_convert": false,
"api_name": "integral_value",
"count_field_type": "number",
"is_index_field": false
},
"area_location": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626447137,
"is_unique": false,
"group_type": "area",
"label": "地区定位",
"type": "group",
"is_need_convert": false,
"is_required": false,
"api_name": "area_location",
"define_type": "package",
"is_extend": false,
"is_single": false,
"fields": {
"area_country": "country",
"area_location": "location",
"area_detail_address": "address",
"area_city": "city",
"area_province": "province",
"area_district": "district"
},
"is_index_field": false,
"index_name": "s_11"
},
"lock_status": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650811,
"description": "锁定状态",
"is_unique": false,
"default_value": "0",
"label": "锁定状态",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_status",
"options": [
{
"label": "未锁定",
"value": "0"
},
{
"label": "锁定",
"value": "1"
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "s_2",
"config": {}
},
"address": {
"describe_api_name": "MemberObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1605626447170,
"pattern": "",
"is_unique": false,
"default_value": "",
"label": "详细地址",
"type": "text",
"default_to_zero": false,
"used_in": "component",
"is_required": false,
"api_name": "address",
"define_type": "package",
"input_mode": "",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "t_4",
"max_length": 100,
"help_text": ""
},
"last_modified_time": {
"describe_api_name": "MemberObj",
"is_index": true,
"create_time": 1599447650822,
"is_unique": false,
"description": "last_modified_time",
"label": "最后修改时间",
"type": "date_time",
"time_zone": "",
"is_need_convert": false,
"is_required": false,
"api_name": "last_modified_time",
"define_type": "system",
"date_format": "yyyy-MM-dd HH:mm:ss",
"index_name": "md_time"
},
"create_time": {
"describe_api_name": "MemberObj",
"is_index": true,
"create_time": 1599447650822,
"is_unique": false,
"description": "create_time",
"label": "创建时间",
"type": "date_time",
"time_zone": "",
"is_need_convert": false,
"is_required": false,
"api_name": "create_time",
"define_type": "system",
"date_format": "yyyy-MM-dd HH:mm:ss",
"index_name": "crt_time"
},
"life_status": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650811,
"description": "生命状态",
"is_unique": false,
"default_value": "normal",
"label": "生命状态",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "life_status",
"options": [
{
"label": "未生效",
"value": "ineffective"
},
{
"label": "审核中",
"value": "under_review"
},
{
"label": "正常",
"value": "normal"
},
{
"label": "变更中",
"value": "in_change"
},
{
"label": "作废",
"value": "invalid"
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "s_3",
"config": {}
},
"growth_value": {
"describe_api_name": "MemberObj",
"return_type": "number",
"is_unique": false,
"type": "count",
"decimal_places": 2,
"sub_object_describe_apiname": "MemberGrowthValueDetailObj",
"is_required": false,
"wheres": [
{
"connector": "OR",
"filters": [
{
"fieldName": "life_status",
"connector": "AND",
"objectReference": false,
"fieldValues": [
"normal"
],
"fieldNum": 0,
"operator": "EQ"
}
]
}
],
"define_type": "package",
"is_extend": false,
"is_single": false,
"index_name": "d_2",
"field_api_name": "member_id",
"is_index": false,
"is_active": true,
"create_time": 1599447650764,
"count_type": "sum",
"count_field_api_name": "change_growth_value",
"label": "成长值",
"is_need_convert": false,
"api_name": "growth_value",
"count_field_type": "number",
"is_index_field": false
},
"avatar": {
"describe_api_name": "MemberObj",
"file_amount_limit": 10,
"is_index": false,
"is_active": true,
"create_time": 1605626447009,
"is_unique": false,
"label": "头像",
"type": "image",
"is_watermark": false,
"file_size_limit": 10485760,
"is_required": false,
"api_name": "avatar",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "a_2",
"support_file_types": []
},
"last_modified_by": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650822,
"is_unique": false,
"label": "最后修改人",
"type": "employee",
"is_need_convert": true,
"is_required": false,
"api_name": "last_modified_by",
"define_type": "system",
"is_single": true,
"index_name": "md_by"
},
"out_tenant_id": {
"describe_api_name": "MemberObj",
"is_index": false,
"is_active": true,
"create_time": 1599447650822,
"pattern": "",
"is_unique": false,
"description": "out_tenant_id",
"label": "外部企业",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "out_tenant_id",
"define_type": "system",
"index_name": "o_ei",
"config": {
"display": 0
},
"max_length": 200
},
"version": {
"describe_api_name": "MemberObj",
"is_index": false,
"create_time": 1599447650822,
"length": 8,
"is_unique": false,
"description": "version",
"label": "version",
"type": "number",
"decimal_places": 0,
"is_need_convert": false,
"is_required": false,
"api_name": "version",
"define_type": "system",
"index_name": "version",
"round_mode": 4
},
"created_by": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650822,
"is_unique": false,
"label": "创建人",
"type": "employee",
"is_need_convert": true,
"is_required": false,
"api_name": "created_by",
"define_type": "system",
"is_single": true,
"index_name": "crt_by"
},
"relevant_team": {
"describe_api_name": "MemberObj",
"embedded_fields": {
"teamMemberEmployee": {
"is_index": true,
"is_need_convert": true,
"is_required": false,
"api_name": "teamMemberEmployee",
"is_unique": false,
"define_type": "package",
"description": "成员员工",
"label": "成员员工",
"type": "employee",
"is_single": true,
"help_text": "成员员工"
},
"teamMemberRole": {
"is_index": true,
"is_need_convert": false,
"is_required": false,
"api_name": "teamMemberRole",
"options": [
{
"label": "负责人",
"value": "1"
},
{
"label": "普通成员",
"value": "4"
}
],
"is_unique": false,
"define_type": "package",
"description": "成员角色",
"label": "成员角色",
"type": "select_one",
"help_text": "成员角色"
},
"teamMemberPermissionType": {
"is_index": true,
"is_need_convert": false,
"is_required": false,
"api_name": "teamMemberPermissionType",
"options": [
{
"label": "只读",
"value": "1"
},
{
"label": "读写",
"value": "2"
}
],
"is_unique": false,
"define_type": "package",
"description": "成员权限类型",
"label": "成员权限类型",
"type": "select_one",
"help_text": "成员权限类型"
}
},
"is_index": true,
"is_active": true,
"create_time": 1599447650820,
"is_unique": false,
"label": "相关团队",
"type": "embedded_object_list",
"is_need_convert": false,
"is_required": false,
"api_name": "relevant_team",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "a_team",
"help_text": "相关团队"
},
"record_type": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650819,
"description": "record_type",
"is_unique": false,
"label": "业务类型",
"type": "record_type",
"is_need_convert": false,
"is_required": false,
"api_name": "record_type",
"options": [
{
"is_active": true,
"api_name": "default__c",
"label": "客户",
"config": {
"edit": 1,
"enable": 0,
"remove": 0
}
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "r_type",
"config": {}
},
"data_own_department": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650822,
"is_unique": false,
"label": "归属部门",
"type": "department",
"is_need_convert": false,
"is_required": false,
"api_name": "data_own_department",
"define_type": "package",
"is_single": true,
"index_name": "data_owner_dept_id"
},
"phone": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626445130,
"is_unique": true,
"label": "手机",
"type": "phone_number",
"is_required": false,
"api_name": "phone",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "p_1"
},
"district": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626447170,
"is_unique": false,
"label": "区",
"type": "district",
"used_in": "component",
"is_required": false,
"api_name": "district",
"options": [],
"define_type": "package",
"cascade_parent_api_name": "city",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "s_12",
"config": {},
"help_text": ""
},
"name": {
"describe_api_name": "MemberObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1599447650770,
"pattern": "",
"description": "name",
"is_unique": false,
"label": "名称",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": true,
"api_name": "name",
"define_type": "system",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "name",
"max_length": 1000
},
"order_by": {
"describe_api_name": "MemberObj",
"is_index": false,
"create_time": 1599447650822,
"length": 8,
"is_unique": false,
"description": "order_by",
"label": "order_by",
"type": "number",
"decimal_places": 0,
"is_need_convert": false,
"is_required": false,
"api_name": "order_by",
"define_type": "system",
"index_name": "l_by",
"round_mode": 4
},
"location": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626447170,
"is_unique": false,
"is_geo_index": false,
"label": "定位",
"type": "location",
"used_in": "component",
"is_required": false,
"api_name": "location",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "t_5",
"help_text": ""
},
"_id": {
"describe_api_name": "MemberObj",
"is_index": false,
"is_active": true,
"create_time": 1599447650822,
"pattern": "",
"is_unique": false,
"description": "_id",
"label": "_id",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "_id",
"define_type": "system",
"index_name": "_id",
"max_length": 200
},
"customer_id": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1599447650818,
"is_unique": true,
"label": "客户",
"target_api_name": "AccountObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_account__c",
"target_related_list_label": "会员",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": false,
"api_name": "customer_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"is_index_field": true,
"index_name": "s_5"
},
"add_source": {
"describe_api_name": "MemberObj",
"is_index": true,
"is_active": true,
"create_time": 1605626445553,
"is_unique": false,
"label": "来源",
"type": "select_one",
"is_required": false,
"api_name": "add_source",
"options": [
{
"not_usable": false,
"label": "微信",
"value": "wechat"
},
{
"not_usable": false,
"label": "门店",
"value": "store"
},
{
"not_usable": false,
"label": "其他",
"value": "other"
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "s_6",
"config": {},
"help_text": ""
}
}
},
"detailObjectDescribeList": []
},
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0
}请求参数
Body 参数application/json
返回响应
扫码加入交流群