15-day free trial. No credit card required.
3-user packMore than 3 users
USDINREURGBPJPYSGDAUDAEDSARMXNCNY
USDINRGBPEUR
Most Popular
Starter
Monthly flat fee for 3 users
(billed annually)
Sales tracking tool for small businesses.
Sign upStandard
Monthly flat fee for 3 users
(billed annually)
Sales tracking tool for small businesses.
Sign upMost Popular
We also offer a free edition - 3 users, 5,000 records and 1GB file storage.
Start your free trial.
or sign in usingGoogleLinkedin
布局
目的
获取与特定模块关联的布局。
请求URL
https://www.zohoapis.com.cn/crm/v2/settings/layouts
请求方法
GET
范围
scope=ZohoCRM.settings.layouts.read
(或)
scope=ZohoCRM.settings.layouts.all
(或)
scope=ZohoCRM.settings.all
参数
| 参数名称 | 数据类型 | 描述 |
|---|---|---|
| module (必填) | 字符串 | 指定所需模块的API名称。例如，线索，联系人，客户，商机等。 |
可能的错误
| HTTP状态 | 错误码 | 消息 | 原因 |
|---|---|---|---|
| 400 | INVALID_MODULE | 给出的模块名称似乎无效 | 无效的模块名称或没有选项卡权限，或者模块可能已从已组织的模块中删除 |
| 400 | INVALID_MODULE | 在API中不支持给定的模块 | 当前API不支持文档和项目等模块。(一旦支持了这些模块，就不会显示此错误。) |
示例请求
curl "https://www.zohoapis.com.cn/crm/v2/settings/layouts?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" 示例响应
{
"layouts": [
{
"created_by": null,
"id": "4108880000380037",
"sections": [
{
"sequence": 1,
"name": "Lead Information",
"label": "Lead Information",
"column_count": 2,
"fields": [
{
"api_name": "Owner",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 1,
"id": "410888000000000553",
"view_type": {
"quick_create": false,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "ownerlookup",
"length": 120,
"decimal_place": null,
"auto_number": {},
"required": false,
"field_label": "Lead Owner"
},
{
"api_name": "Company",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 2,
"id": "4108880000000555",
"view_type": {
"quick_create": true,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "text",
"length": 100,
"decimal_place": null,
"auto_number": {},
"required": true,
"field_label": "Company"
}
]
}
],
"visible": true,
"modified_by": {
"id": "4108880000086001",
"name": "Patricia Boyle"
},
"status": 1,
"modified_time": "2016-06-08T14:35:17+05:30",
"name": "Test",
"profiles": [
{
"id": "4108880000015972",
"default": false,
"name": "Administrator"
}
],
"created_time": "2016-05-13T10:37:38+05:30"
}
]
} 示例请求
ZCRMModule module = ZCRMModule.getInstance("Products"); // 模块API名称
BulkAPIResponse response = module.getLayouts();
List<ZCRMLayout> layouts = (List<ZCRMLayout>) response.getData(); 示例响应
{
"layouts": [
{
"created_by": null,
"id": "4108880000380037",
"sections": [
{
"sequence": 1,
"name": "Lead Information",
"label": "Lead Information",
"column_count": 2,
"fields": [
{
"api_name": "Owner",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 1,
"id": "410888000000000553",
"view_type": {
"quick_create": false,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "ownerlookup",
"length": 120,
"decimal_place": null,
"auto_number": {},
"required": false,
"field_label": "Lead Owner"
},
{
"api_name": "Company",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 2,
"id": "4108880000000555",
"view_type": {
"quick_create": true,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "text",
"length": 100,
"decimal_place": null,
"auto_number": {},
"required": true,
"field_label": "Company"
}
]
}
],
"visible": true,
"modified_by": {
"id": "4108880000086001",
"name": "Patricia Boyle"
},
"status": 1,
"modified_time": "2016-06-08T14:35:17+05:30",
"name": "Test",
"profiles": [
{
"id": "4108880000015972",
"default": false,
"name": "Administrator"
}
],
"created_time": "2016-05-13T10:37:38+05:30"
}
]
} 示例请求
$zcrmModuleIns = ZCRMModule::getInstance("Products");
$apiResponse= $zcrmModuleIns->getAllLayouts();
$layouts =$apiResponse->getData(); //这里$layouts是ZCRMLayout实例的数组 示例响应
{
"layouts": [
{
"created_by": null,
"id": "4108880000380037",
"sections": [
{
"sequence": 1,
"name": "Lead Information",
"label": "Lead Information",
"column_count": 2,
"fields": [
{
"api_name": "Owner",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 1,
"id": "410888000000000553",
"view_type": {
"quick_create": false,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "ownerlookup",
"length": 120,
"decimal_place": null,
"auto_number": {},
"required": false,
"field_label": "Lead Owner"
},
{
"api_name": "Company",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 2,
"id": "4108880000000555",
"view_type": {
"quick_create": true,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "text",
"length": 100,
"decimal_place": null,
"auto_number": {},
"required": true,
"field_label": "Company"
}
]
}
],
"visible": true,
"modified_by": {
"id": "4108880000086001",
"name": "Patricia Boyle"
},
"status": 1,
"modified_time": "2016-06-08T14:35:17+05:30",
"name": "Test",
"profiles": [
{
"id": "4108880000015972",
"default": false,
"name": "Administrator"
}
],
"created_time": "2016-05-13T10:37:38+05:30"
}
]
} 示例请求
def get_all_layouts(self):
try:
module_ins=ZCRMModule.get_instance('Accounts') #module API Name
resp=module_ins.get_all_layouts()
print resp.status_code
layout_ins_arr=resp.data
for layout_ins in layout_ins_arr:
print "\n\n:::LAYOUT DETAILS:::"
print layout_ins.name
print layout_ins.id
print layout_ins.created_time
print layout_ins.modified_time
print layout_ins.convert_mapping
print layout_ins.is_visible
print layout_ins.modified_by.id
profiles=layout_ins.accessible_profiles
if profiles is not None:
for profile in profiles:
print "\n\n"
print profile.id
print profile.name
print profile.is_default
print layout_ins.created_by
sections= layout_ins.sections
if sections is not None:
print "\n:::SECTION DETAILS:::"
for secton in sections:
print secton.name
print secton.display_name
print secton.column_count
print secton.sequence_number
fields=secton.fields
if fields is not None:
print "\n:::FIELD DETAILS:::"
for field_ins in fields:
print field_ins.api_name
print field_ins.id
print field_ins.is_custom_field
print field_ins.lookup_field
print field_ins.convert_mapping
print field_ins.is_visible
print field_ins.field_label
print field_ins.length
print field_ins.created_source
print field_ins.default_value
print field_ins.is_mandatory
print field_ins.sequence_number
print field_ins.is_read_only
print field_ins.is_unique_field
print field_ins.is_case_sensitive
print field_ins.data_type
print field_ins.is_formula_field
print field_ins.is_currency_field
print field_ins.picklist_values
print field_ins.is_auto_number
print field_ins.is_business_card_supported
print field_ins.field_layout_permissions
print field_ins.decimal_place
print field_ins.precision
print field_ins.rounding_option
print field_ins.formula_return_type
print field_ins.formula_expression
print field_ins.prefix
print field_ins.suffix
print field_ins.start_number
print field_ins.json_type
except ZCRMException as ex:
print ex.status_code
print ex.error_message
print ex.error_code
print ex.error_details
print ex.error_content 示例响应
{
"layouts": [
{
"created_by": null,
"id": "4108880000380037",
"sections": [
{
"sequence": 1,
"name": "Lead Information",
"label": "Lead Information",
"column_count": 2,
"fields": [
{
"api_name": "Owner",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 1,
"id": "410888000000000553",
"view_type": {
"quick_create": false,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "ownerlookup",
"length": 120,
"decimal_place": null,
"auto_number": {},
"required": false,
"field_label": "Lead Owner"
},
{
"api_name": "Company",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 2,
"id": "4108880000000555",
"view_type": {
"quick_create": true,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "text",
"length": 100,
"decimal_place": null,
"auto_number": {},
"required": true,
"field_label": "Company"
}
]
}
],
"visible": true,
"modified_by": {
"id": "4108880000086001",
"name": "Patricia Boyle"
},
"status": 1,
"modified_time": "2016-06-08T14:35:17+05:30",
"name": "Test",
"profiles": [
{
"id": "4108880000015972",
"default": false,
"name": "Administrator"
}
],
"created_time": "2016-05-13T10:37:38+05:30"
}
]
} 示例请求
ZCRMModule moduleIns = ZCRMModule.GetInstance("Leads"); //模块API名称
BulkAPIResponse<ZCRMLayout> response = moduleIns.GetLayouts();
List<ZCRMLayout> layouts = response.BulkData; //layouts - ZCRMLayout实例的列表 示例响应
{
"layouts": [
{
"created_by": null,
"id": "4108880000380037",
"sections": [
{
"sequence": 1,
"name": "Lead Information",
"label": "Lead Information",
"column_count": 2,
"fields": [
{
"api_name": "Owner",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 1,
"id": "410888000000000553",
"view_type": {
"quick_create": false,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "ownerlookup",
"length": 120,
"decimal_place": null,
"auto_number": {},
"required": false,
"field_label": "Lead Owner"
},
{
"api_name": "Company",
"unique": {},
"read_only": false,
"visible": true,
"pick_list_values": [],
"custom_field": false,
"lookup": {},
"currency": {},
"sequence_number": 2,
"id": "4108880000000555",
"view_type": {
"quick_create": true,
"edit": true,
"view": true,
"create": true
},
"default_value": null,
"data_type": "text",
"length": 100,
"decimal_place": null,
"auto_number": {},
"required": true,
"field_label": "Company"
}
]
}
],
"visible": true,
"modified_by": {
"id": "4108880000086001",
"name": "Patricia Boyle"
},
"status": 1,
"modified_time": "2016-06-08T14:35:17+05:30",
"name": "Test",
"profiles": [
{
"id": "4108880000015972",
"default": false,
"name": "Administrator"
}
],
"created_time": "2016-05-13T10:37:38+05:30"
}
]
}