获取客户地址对象描述接口
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": "AccountAddrObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-93cd41d486ad4048",
"data": {
"describe": {
"fields": {
"country": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436096,
"description": "国家",
"is_unique": false,
"label": "国家",
"type": "country",
"used_in": "component",
"is_need_convert": false,
"is_required": false,
"api_name": "country",
"options": [],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "国家",
"config": {
"edit": 1,
"attrs": {
"api_name": 1,
"header": 1,
"label": 1
}
},
"index_name": "s_1"
},
"lock_rule": {
"describe_api_name": "AccountAddrObj",
"is_index": false,
"is_active": true,
"create_time": 1607422436096,
"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_2"
},
"city": {
"describe_api_name": "AccountAddrObj",
"description": "市",
"is_unique": false,
"type": "city",
"used_in": "component",
"is_required": false,
"options": [],
"define_type": "package",
"cascade_parent_api_name": "province",
"is_single": false,
"label_r": "市",
"index_name": "s_3",
"is_index": true,
"is_active": true,
"create_time": 1607422436096,
"label": "市",
"is_need_convert": false,
"api_name": "city",
"is_index_field": false,
"config": {
"edit": 1,
"attrs": {
"api_name": 1,
"header": 1,
"label": 1
}
}
},
"remark": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436096,
"pattern": "",
"description": "备注",
"is_unique": false,
"label": "备注",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "remark",
"define_type": "package",
"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": "t_1",
"max_length": 1000
},
"contact_id": {
"describe_api_name": "AccountAddrObj",
"description": "联系人",
"is_unique": false,
"type": "object_reference",
"is_required": false,
"wheres": [
{
"connector": "OR",
"filters": [
{
"value_type": 2,
"operator": "EQ",
"field_name": "account_id",
"field_values": [
"$account_id$"
]
}
]
}
],
"define_type": "package",
"cascade_parent_api_name": "account_id",
"is_single": false,
"label_r": "联系人",
"index_name": "s_4",
"is_index": true,
"is_active": true,
"create_time": 1607422436096,
"label": "联系人",
"target_api_name": "ContactObj",
"target_related_list_name": "contact_accountaddr_list",
"target_related_list_label": "客户地址",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"api_name": "contact_id",
"is_index_field": false,
"config": {
"edit": 1,
"enable": 1,
"attrs": {
"target_related_list_label": 1,
"wheres": 1,
"default_value": 0,
"label": 1,
"help_text": 1
}
}
},
"lock_user": {
"describe_api_name": "AccountAddrObj",
"is_index": false,
"is_active": true,
"create_time": 1607422436096,
"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,
"label_r": "加锁人",
"index_name": "a_1"
},
"add_type": {
"describe_api_name": "AccountAddrObj",
"description": "地址类型",
"is_unique": false,
"type": "select_one",
"is_required": true,
"options": [
{
"label": "办公地址",
"value": "1",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"label": "仓储地址",
"value": "2",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"label": "注册地址",
"value": "3",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"label": "门店地址",
"value": "4",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"label": "家庭地址",
"value": "5",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"is_required": false,
"not_usable": false,
"label": "其他",
"value": "other",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
}
],
"define_type": "package",
"option_id": "a89f7b9e2c59f33765b3a4b9da41de64",
"is_single": false,
"label_r": "地址类型",
"index_name": "s_5",
"is_index": true,
"is_active": true,
"create_time": 1607422436109,
"default_value": "1",
"label": "地址类型",
"is_need_convert": false,
"api_name": "add_type",
"is_index_field": false,
"config": {
"add": 1,
"edit": 1,
"enable": 1,
"remove": 1,
"attrs": {
"wheres": 1,
"options": 1,
"is_unique": 1,
"default_value": 1,
"label": 1,
"help_text": 1
}
}
},
"geo_point": {
"describe_api_name": "AccountAddrObj",
"is_index": false,
"is_active": true,
"create_time": 1607422436109,
"description": "GeoPointDescribe",
"is_unique": false,
"label": "GeoPointDescribe",
"type": "geo_point",
"is_need_convert": false,
"is_required": false,
"api_name": "geo_point",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"config": {
"edit": 0,
"enable": 0,
"display": 0,
"remove": 0,
"attrs": {
"wheres": 1,
"is_required": 0,
"default_value": 1,
"help_text": 1
}
}
},
"extend_obj_data_id": {
"describe_api_name": "AccountAddrObj",
"default_is_expression": false,
"pattern": "",
"description": "extend_obj_data_id",
"is_unique": false,
"type": "text",
"default_to_zero": false,
"is_required": false,
"define_type": "system",
"is_extend": false,
"is_single": false,
"index_name": "t_2",
"max_length": 100,
"is_index": false,
"is_active": true,
"create_time": 1607422436109,
"default_value": "",
"label": "extend_obj_data_id",
"api_name": "extend_obj_data_id",
"is_index_field": false,
"help_text": ""
},
"province": {
"describe_api_name": "AccountAddrObj",
"description": "省",
"is_unique": false,
"type": "province",
"used_in": "component",
"is_required": false,
"options": [],
"define_type": "package",
"cascade_parent_api_name": "country",
"is_single": false,
"label_r": "省",
"index_name": "s_6",
"is_index": true,
"is_active": true,
"create_time": 1607422436109,
"label": "省",
"is_need_convert": false,
"api_name": "province",
"is_index_field": false,
"config": {
"edit": 1,
"attrs": {
"api_name": 1,
"header": 1,
"label": 1
}
}
},
"life_status_before_invalid": {
"describe_api_name": "AccountAddrObj",
"is_index": false,
"is_active": true,
"create_time": 1607422436109,
"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,
"label_r": "作废前生命状态",
"index_name": "t_3",
"max_length": 256
},
"owner_department": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436109,
"pattern": "",
"description": "负责人主属部门",
"is_unique": false,
"label": "负责人主属部门",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "owner_department",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "负责人主属部门",
"index_name": "owner_dept",
"max_length": 100
},
"owner": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436109,
"description": "负责人",
"is_unique": false,
"label": "负责人",
"type": "employee",
"is_need_convert": true,
"is_required": false,
"api_name": "owner",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"label_r": "负责人",
"index_name": "owner"
},
"address": {
"describe_api_name": "AccountAddrObj",
"pattern": "",
"description": "详细地址",
"is_unique": false,
"type": "text",
"used_in": "component",
"is_required": false,
"define_type": "package",
"is_single": false,
"label_r": "详细地址",
"index_name": "t_4",
"max_length": 256,
"is_index": true,
"is_active": true,
"create_time": 1607422436109,
"label": "详细地址",
"is_need_convert": false,
"api_name": "address",
"is_index_field": false,
"config": {
"edit": 1,
"attrs": {
"api_name": 1,
"header": 1,
"label": 1
}
}
},
"lock_status": {
"describe_api_name": "AccountAddrObj",
"description": "锁定状态",
"is_unique": false,
"type": "select_one",
"is_required": false,
"options": [
{
"label": "未锁定",
"value": "0"
},
{
"label": "锁定",
"value": "1"
}
],
"define_type": "package",
"option_id": "f8f6e3b07ca18b590c9a3cf86e014576",
"is_single": false,
"label_r": "锁定状态",
"index_name": "s_7",
"is_index": true,
"is_active": true,
"create_time": 1607422436125,
"default_value": "0",
"label": "锁定状态",
"is_need_convert": false,
"api_name": "lock_status",
"is_index_field": false,
"config": {}
},
"contact_way": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436125,
"description": "联系方式",
"is_unique": false,
"label": "联系方式",
"type": "phone_number",
"is_need_convert": false,
"is_required": false,
"api_name": "contact_way",
"define_type": "package",
"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": "p_1"
},
"life_status": {
"describe_api_name": "AccountAddrObj",
"description": "生命状态",
"is_unique": false,
"type": "select_one",
"is_required": false,
"options": [
{
"label": "未生效",
"value": "ineffective"
},
{
"label": "审核中",
"value": "under_review"
},
{
"label": "正常",
"value": "normal"
},
{
"label": "变更中",
"value": "in_change"
},
{
"label": "作废",
"value": "invalid"
}
],
"define_type": "package",
"option_id": "18de2c4eae8cf7a180ffb0f175010e6f",
"is_single": false,
"label_r": "生命状态",
"index_name": "s_8",
"is_index": true,
"is_active": true,
"create_time": 1607422436135,
"default_value": "normal",
"label": "生命状态",
"is_need_convert": false,
"api_name": "life_status",
"is_index_field": false,
"config": {}
},
"record_type": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436143,
"description": "record_type",
"is_unique": false,
"label": "业务类型",
"type": "record_type",
"is_need_convert": false,
"is_required": true,
"api_name": "record_type",
"options": [
{
"is_active": true,
"api_name": "default__c",
"description": "预设业务类型",
"label": "预设业务类型"
}
],
"define_type": "package",
"option_id": "504eae3cf17c3d7223be4a3e0e893ecb",
"is_index_field": false,
"is_single": false,
"label_r": "业务类型",
"index_name": "r_type",
"config": {}
},
"zipcode": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436143,
"pattern": "",
"description": "邮政编码",
"is_unique": false,
"label": "邮政编码",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "zipcode",
"define_type": "package",
"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": "t_5",
"max_length": 100
},
"account_id": {
"describe_api_name": "AccountAddrObj",
"description": "客户名称",
"is_unique": false,
"type": "master_detail",
"is_required": true,
"define_type": "package",
"is_single": false,
"label_r": "客户名称",
"index_name": "s_9",
"is_index": true,
"is_active": true,
"create_time": 1607422436143,
"label": "客户名称",
"target_api_name": "AccountObj",
"target_related_list_name": "account_accountaddr_list",
"target_related_list_label": "客户地址",
"action_on_target_delete": "cascade_delete",
"is_need_convert": false,
"api_name": "account_id",
"is_create_when_master_create": false,
"is_index_field": false,
"is_required_when_master_create": false,
"config": {
"edit": 1,
"attrs": {
"cascading_deletion": 1,
"follow_object_power": 1,
"wheres": 1,
"is_required": 0,
"is_unique": 1,
"default_value": 0,
"label": 1,
"target_related_list_name": 1,
"help_text": 1
}
}
},
"district": {
"describe_api_name": "AccountAddrObj",
"description": "区",
"is_unique": false,
"type": "district",
"used_in": "component",
"is_required": false,
"options": [],
"define_type": "package",
"cascade_parent_api_name": "city",
"is_single": false,
"label_r": "区",
"index_name": "s_10",
"is_index": true,
"is_active": true,
"create_time": 1607422436143,
"label": "区",
"is_need_convert": false,
"api_name": "district",
"is_index_field": false,
"config": {
"edit": 1,
"attrs": {
"api_name": 1,
"header": 1,
"label": 1
}
}
},
"is_default_add": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436154,
"description": "主地址",
"is_unique": false,
"default_value": false,
"label": "主地址",
"type": "true_or_false",
"is_need_convert": false,
"is_required": false,
"api_name": "is_default_add",
"options": [
{
"label": "是",
"value": true
},
{
"label": "否",
"value": false
}
],
"define_type": "package",
"option_id": "41b83a936f15f54cae7651bee294ff79",
"is_index_field": false,
"is_single": false,
"label_r": "主地址",
"index_name": "b_1"
},
"name": {
"describe_api_name": "AccountAddrObj",
"prefix": "Addr.{yyyy}-{mm}-{dd}_",
"description": "地址编号",
"is_unique": false,
"start_number": 1,
"type": "auto_number",
"is_required": true,
"define_type": "package",
"postfix": "",
"is_single": false,
"label_r": "地址编号",
"index_name": "name",
"is_index": true,
"is_active": true,
"create_time": 1607422436154,
"serial_number": 6,
"label": "地址编号",
"is_need_convert": false,
"api_name": "name",
"is_index_field": false,
"config": {
"edit": 1,
"attrs": {
"wheres": 1,
"is_required": 0,
"default_value": 1,
"label": 1,
"help_text": 1
}
}
},
"regional_location": {
"describe_api_name": "AccountAddrObj",
"is_unique": false,
"group_type": "area",
"type": "group",
"is_required": false,
"define_type": "package",
"is_single": false,
"label_r": "地区定位",
"index_name": "s_11",
"is_index": false,
"is_active": true,
"create_time": 1607422436154,
"label": "地区定位",
"api_name": "regional_location",
"fields": {
"area_country": "country",
"area_location": "location",
"area_detail_address": "address",
"area_city": "city",
"area_province": "province",
"area_district": "district"
},
"is_index_field": false,
"config": {
"edit": 1,
"attrs": {
"api_name": 1,
"header": 1,
"label": 1
}
},
"help_text": ""
},
"is_ship_to_add": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436164,
"description": "默认收货地址",
"is_unique": false,
"default_value": false,
"label": "默认收货地址",
"type": "true_or_false",
"is_need_convert": false,
"is_required": false,
"api_name": "is_ship_to_add",
"options": [
{
"label": "是",
"value": true
},
{
"label": "否",
"value": false
}
],
"define_type": "package",
"option_id": "41b83a936f15f54cae7651bee294ff79",
"is_index_field": false,
"is_single": false,
"label_r": "默认收货地址",
"index_name": "b_2"
},
"location": {
"describe_api_name": "AccountAddrObj",
"is_index": true,
"is_active": true,
"create_time": 1607422436164,
"description": "定位",
"is_unique": false,
"label": "定位",
"type": "location",
"used_in": "component",
"is_need_convert": false,
"is_required": false,
"api_name": "location",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "定位",
"config": {
"edit": 1,
"attrs": {
"api_name": 1,
"header": 1,
"label": 1
}
},
"index_name": "t_6"
},
"_id": {
"type": "text",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"max_length": 200,
"pattern": "",
"label": "_id",
"is_active": true,
"api_name": "_id",
"description": "_id",
"index_name": "_id",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"version": {
"type": "number",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"round_mode": 4,
"length": 8,
"decimal_places": 0,
"label": "version",
"api_name": "version",
"description": "version",
"index_name": "version",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"created_by": {
"type": "employee",
"define_type": "system",
"is_index": true,
"is_need_convert": true,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "created_by",
"label": "创建人",
"is_active": true,
"index_name": "crt_by",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"last_modified_by": {
"type": "employee",
"define_type": "system",
"is_index": true,
"is_need_convert": true,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "last_modified_by",
"is_active": true,
"index_name": "md_by",
"label": "最后修改人",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"create_time": {
"type": "date_time",
"define_type": "system",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"time_zone": "",
"date_format": "yyyy-MM-dd HH:mm:ss",
"label": "创建时间",
"api_name": "create_time",
"description": "create_time",
"index_name": "crt_time",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"last_modified_time": {
"type": "date_time",
"define_type": "system",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"time_zone": "",
"date_format": "yyyy-MM-dd HH:mm:ss",
"label": "最后修改时间",
"api_name": "last_modified_time",
"description": "last_modified_time",
"index_name": "md_time",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"is_deleted": {
"type": "true_or_false",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"label": "is_deleted",
"api_name": "is_deleted",
"description": "is_deleted",
"default_value": false,
"index_name": "is_del",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"out_tenant_id": {
"type": "text",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"max_length": 200,
"pattern": "",
"label": "外部企业",
"is_active": true,
"api_name": "out_tenant_id",
"description": "out_tenant_id",
"index_name": "o_ei",
"create_time": 1558683279991,
"config": {
"display": 0
},
"describe_api_name": "AccountAddrObj"
},
"out_owner": {
"type": "employee",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "out_owner",
"index_name": "o_owner",
"label": "外部负责人",
"is_active": true,
"config": {
"display": 1
},
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"data_own_department": {
"type": "department",
"define_type": "package",
"is_index": true,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"is_single": true,
"api_name": "data_own_department",
"label": "归属部门",
"is_active": true,
"index_name": "data_owner_dept_id",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
},
"order_by": {
"type": "number",
"define_type": "system",
"is_index": false,
"is_need_convert": false,
"is_required": false,
"is_unique": false,
"round_mode": 4,
"length": 8,
"decimal_places": 0,
"label": "order_by",
"api_name": "order_by",
"description": "order_by",
"index_name": "l_by",
"create_time": 1558683279991,
"describe_api_name": "AccountAddrObj"
}
},
"api_name": "AccountAddrObj",
"display_name_r": "客户地址"
},
"detailObjectDescribeList": []
},
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0
}请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-02-21 10:26:48