巫师 API
向导帮助您将一个长表单分成一系列屏幕,用户可以在每个屏幕上输入数据,然后继续到下一步,直到完成。向导减少了数据输入过程中出错的几率,因为屏幕可以部分保存为草稿,并在稍后提交。
更多详情,请参阅Zoho CRM中的向导。
目的
获取模块中巫师的详细信息。
请求详情
请求 URL
所有向导:
{api-domain}/crm/{version}/settings/wizards
特定布局的向导:
{api-domain}/crm/{version}/settings/wizards/{wizard_ID}?layout_id={layout_ID}
支持的模块
潜在客户、联系人、交易、Account和自定义模块。
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.wizards.READ
参数
- layout_id string,当你想获取特定布局的向导时是必需的
你想要从中获取向导详细信息的布局ID。使用布局元数据API来获取布局的ID。
注意
- 当您为向导设置条件规则时,响应包含execute_on和type键。
- execute_on 表示条件规则执行的时间。取值为 create、edit 和 create_edit。
- type 表示在满足条件时要执行的操作。其值包括 set_values、set_lock、show_component 和 show_widget。
- 当 type=set_lock 时,响应包含键 exempted_profiles。此数组包含允许在锁定特定字段后仍可编辑的配置文件列表。
- 添加了color_palette键,用于显示屏幕上按钮可用的颜色。请注意,只有当您为屏幕上的按钮选择了至少一种自定义颜色时,此键才会出现在响应中。
- 以下是从版本5开始,当您在布局中获取特定向导时对该API所做的更改:
- 响应中新增了一个JSON数组portal_user_types,显示有权访问该向导的门户用户类型列表。
- 响应中新增了一个JSON数组exempted_portal_user_types,表示有权访问被其他用户类型阻止的向导的门户用户类型列表。
- 在segments下,对于buttons,添加了Profiles JSON数组。这表示在该屏幕中有权访问该按钮的配置文件。
- 在Screens JSON数组中,segments JSON对象的"type"从fields更改为composite。
- 在segments JSON数组中,fields JSON数组重命名为elements。
- elements JSON数组中的每个对象包含序列号、resource和type键。resource包括屏幕上字段或查询组件的"name"和"id"。type表示资源是field还是query_component。
- From V6,你可以在向导中获取可用屏幕列表。请参阅示例响应以供参考。
响应 JSON
- 巫师JSON array
包含不同巫师在CRM中的详细信息。每个巫师都有自己的一套属性。
- created_timestring
表示创建向导的时间戳。
- modified_timestring
表示向导最后修改的时间戳。
- portal_user_typesJSON array
列出有权限访问向导的门户用户类型。
- moduleJSON object
表示与向导关联的模块的详细信息。
- api_namestring
表示模块的 API 名称。
- idstring
表示模块的唯一 ID。
- namestring
表示巫师的名字。
- modified_byJSON object
此对象包含有关最后修改向导的用户的信息。
- namestring
表示用户的姓名。
- idstring
表示用户的ID。
- profilesJSON array
此键包含一个可以访问此向导的配置文件数组。
每个配置文件包括:
- display_label - 表示配置文件在UI中的显示标签。
- name - 表示配置文件的API名称。
- id - 表示配置文件的唯一标识符。
- activeBoolean
表示向导当前是否处于活动状态("active": true)或不活动状态("active": false)。
- 容器JSON array
在一个向导中可以包含多个布局。“containers”JSON数组列出了向导中包含的布局以及与每个布局相关的屏幕。
- layoutJSON object
包含有关布局的详细信息。
- display_labelstring
表示在用户界面中显示的布局标签。
- namestring
表示布局的 API 名称。
- idstring
表示布局的唯一 ID。
- screensJSON array
包含每个布局中存在的屏幕的详细信息。
- display_labelstring
表示在UI中可见的屏幕的显示标签。
- api_namestring
表示屏幕的API名称。
- idstring
表示屏幕的唯一ID。
- idstring
Represents the unique ID of the layout.
- idstring
表示巫师的唯一ID。
- created_byJSON object
包含有关创建该向导的人的信息,包括他们的姓名和ID。
获取模块中所有巫师的示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/wizards"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"wizards": [
{
"created_time": "2024-05-09T23:25:22-07:00",
"modified_time": "2024-05-09T23:25:22-07:00",
"portal_user_types": [
{
"display_label": "ClientPortal",
"name": "ClientPortal",
"id": "5725767000004742018"
}
],
"module": {
"api_name": "Leads",
"id": "5725767000000002175"
},
"name": "Lead",
"modified_by": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
},
"profiles": [
{
"display_label": "Administrator",
"name": "Administrator",
"id": "5725767000000026011"
},
{
"display_label": "Standard",
"name": "Standard",
"id": "5725767000000026014"
},
{
"display_label": "asd",
"name": "asd",
"id": "5725767000000871001"
}
],
"active": true,
"containers": [
{
"layout": {
"display_label": "Standard",
"name": "Standard",
"id": "5725767000000091055"
},
"screens": [
{
"display_label": "Personal",
"api_name": "Personal1",
"id": "5725767000000526327"
},
{
"display_label": "Lead status",
"api_name": "Lead_status1",
"id": "5725767000000526329"
},
{
"display_label": "Income",
"api_name": "Income1",
"id": "5725767000000526331"
}
],
"id": "5725767000000091055"
},
{
"layout": {
"display_label": "Zoho",
"name": "Zoho",
"id": "5725767000000526001"
},
"screens": [
{
"display_label": "Save Page",
"api_name": "Save_Page1",
"id": "5725767000000526395"
},
{
"display_label": "save page2",
"api_name": "save_page21",
"id": "5725767000000526397"
}
],
"id": "5725767000000526001"
}
],
"id": "5725767000000526319",
"created_by": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
}
},
{
"created_time": "2024-12-05T02:58:12-08:00",
"modified_time": "2024-12-05T02:58:12-08:00",
"portal_user_types": [
{
"display_label": "ClientPortal",
"name": "ClientPortal",
"id": "5725767000004742018"
}
],
"module": {
"api_name": "Leads",
"id": "5725767000000002175"
},
"name": "test",
"modified_by": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
},
"profiles": [
{
"display_label": "Administrator",
"name": "Administrator",
"id": "5725767000000026011"
}
],
"active": true,
"containers": [
{
"layout": {
"display_label": "Standard",
"name": "Standard",
"id": "5725767000000091055"
},
"screens": [
{
"display_label": "Screen 1",
"api_name": "Screen_1",
"id": "5725767000004742097"
},
{
"display_label": "Screen 2",
"api_name": "Screen_2",
"id": "5725767000004742099"
},
{
"display_label": "Screen 3",
"api_name": "Screen_3",
"id": "5725767000004742101"
},
{
"display_label": "Screen 4",
"api_name": "Screen_4",
"id": "5725767000004742103"
},
{
"display_label": "Screen 5",
"api_name": "Screen_5",
"id": "5725767000004742105"
},
{
"display_label": "Screen 6",
"api_name": "Screen_6",
"id": "5725767000004742107"
}
],
"id": "5725767000000091055"
}
],
"id": "5725767000004742095",
"created_by": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
}
}
]
}可能的错误
- REQUIRED_PARAM_MISSINGHTTP 400
您在请求中未指定布局ID。
解决方法: 当您想要获取模块中特定向导的详细信息时,“layout_id”是一个必填参数。
- OAUTH_SCOPE_MISMATCHHTTP 401
您没有使用此API所需的范围。
解决方法: 使用正确的范围并生成授权和访问令牌以使用此API。 - NO_PERMISSIONHTTP 403
您没有使用此API的权限。
解决方法: 联系您的管理员。
获取特定布局向导的示例请求
Copiedcurl "https://www.zohoapis.com/crm/v5/settings/wizards/3652397000003875019?layout_id=3652397000000091055"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例响应
Copied{
"wizards": [
{
"created_time": "2023-12-06T16:56:25+05:30",
"modified_time": "2023-12-06T18:40:27+05:30",
"portal_user_types": null,
"module": {
"api_name": "Leads",
"id": "2423488000000000125"
},
"name": "test",
"modified_by": {
"name": "Patricia",
"id": "2423488000000483001"
},
"profiles": [
{
"display_label": "Administrator",
"name": "Administrator",
"id": "2423488000000015972"
},
{
"display_label": "Standard",
"name": "Standard",
"id": "2423488000000015975"
}
],
"active": true,
"containers": [
{
"layout": {
"name": "Standard",
"id": "2423488000000095055"
},
"chart_data": {
"nodes": [
{
"pos_y": 300,
"pos_x": 618,
"start_node": true,
"screen": {
"display_label": "Screen 1",
"id": "2423488000000709018"
}
},
{
"pos_y": 480,
"pos_x": 998,
"start_node": false,
"screen": {
"display_label": "Screen 2",
"id": "2423488000000709020"
}
},
{
"pos_y": 440,
"pos_x": 1498,
"start_node": false,
"screen": {
"display_label": "Screen 3",
"id": "2423488000000709022"
}
}
],
"connections": [
{
"source_screen": {
"display_label": "Screen 1",
"id": "2423488000000709018"
},
"target_screen": {
"display_label": "Screen 2",
"id": "2423488000000709020"
},
"id": "2423488000000709080"
},
{
"source_screen": {
"display_label": "Screen 2",
"id": "2423488000000709020"
},
"target_screen": {
"display_label": "Screen 3",
"id": "2423488000000709022"
},
"id": "2423488000000709082"
}
],
"color_palette": {
"button_background": [
"#ADD9FF",
"#C4F0B3",
"#FFD6BC",
"#F8E199",
"#FFC6C6"
]
}
},
"screens": [
{
"display_label": "Screen 1",
"api_name": "Screen_1",
"id": "2423488000000709018",
"conditional_rules": null,
"segments": [
{
"sequence_number": 1,
"display_label": "Lead Image",
"tab_traversal": "left_to_right",
"column_count": 1,
"elements": [
{
"sequence_number": 1,
"resource": {
"name": "Record_Image",
"id": "2423488000000179001"
},
"type": "field"
}
],
"id": "2423488000000712004",
"type": "composite"
},
{
"sequence_number": 2,
"display_label": "Segment Title",
"tab_traversal": "left_to_right",
"column_count": 2,
"elements": [
{
"sequence_number": 0,
"resource": {
"name": "Salutation",
"id": "2423488000000000601"
},
"type": "field"
},
{
"sequence_number": 1,
"resource": {
"name": "Last_Name",
"id": "2423488000000000559"
},
"type": "field"
},
{
"sequence_number": 3,
"resource": {
"name": "First_Name",
"id": "2423488000000000557"
},
"type": "field"
},
{
"sequence_number": 5,
"resource": {
"name": "Email",
"id": "2423488000000000563"
},
"type": "field"
},
{
"sequence_number": 7,
"resource": {
"name": "Image_Upload",
"id": "2423488000000534029"
},
"type": "field"
}
],
"id": "2423488000000709024",
"type": "composite"
},
{
"sequence_number": 3,
"display_label": "Dummy",
"buttons": [
{
"color": "#fff",
"shape": "square",
"visibility": "show",
"resource": null,
"criteria": null,
"profiles": null,
"target_screen": {
"name": "Screen 2",
"id": "2423488000000709020"
},
"type": "transition",
"transition": null,
"sequence_number": 1,
"display_label": "Screen1",
"background_color": "#00A3F3",
"name": "WB_Screen1",
"id": "2423488000000709038",
"category": "wizard_button"
}
],
"tab_traversal": "left_to_right",
"column_count": 2,
"id": "2423488000000709036",
"type": "buttons"
}
]
},
{
"display_label": "Screen 2",
"api_name": "Screen_2",
"id": "2423488000000709020",
"conditional_rules": null,
"segments": [
{
"sequence_number": 1,
"display_label": "Lead Image",
"tab_traversal": "left_to_right",
"column_count": 1,
"elements": [
{
"sequence_number": 1,
"resource": {
"name": "Record_Image",
"id": "2423488000000179001"
},
"type": "field"
}
],
"id": "2423488000000712012",
"type": "composite"
},
{
"sequence_number": 2,
"display_label": "Lead came from",
"tab_traversal": "left_to_right",
"column_count": 2,
"elements": [
{
"sequence_number": 1,
"resource": {
"name": "Lead_Source",
"id": "2423488000000000573"
},
"type": "field"
},
{
"sequence_number": 3,
"resource": {
"name": "Lead_Status",
"id": "2423488000000000575"
},
"type": "field"
}
],
"id": "2423488000000709046",
"type": "composite"
},
{
"sequence_number": 3,
"display_label": "Dummy",
"buttons": [
{
"color": "#fff",
"shape": "square",
"visibility": "show",
"resource": null,
"criteria": null,
"profiles": null,
"target_screen": {
"name": "Screen 3",
"id": "2423488000000709022"
},
"type": "transition",
"transition": null,
"sequence_number": 1,
"display_label": "screen2",
"background_color": "#00A3F3",
"name": "WB_screen2",
"id": "2423488000000709056",
"category": "wizard_button"
}
],
"tab_traversal": "left_to_right",
"column_count": 2,
"id": "2423488000000709054",
"type": "buttons"
}
]
},
{
"display_label": "Screen 3",
"api_name": "Screen_3",
"id": "2423488000000709022",
"conditional_rules": null,
"segments": [
{
"sequence_number": 1,
"display_label": "Revenue",
"tab_traversal": "left_to_right",
"column_count": 2,
"elements": [
{
"sequence_number": 1,
"resource": {
"name": "Annual_Revenue",
"id": "2423488000000000581"
},
"type": "field"
}
],
"id": "2423488000000709064",
"type": "composite"
},
{
"sequence_number": 2,
"display_label": "Dummy",
"buttons": [
{
"color": "#fff",
"shape": "square",
"visibility": "show",
"resource": null,
"criteria": null,
"profiles": null,
"target_screen": null,
"type": "save",
"message": null,
"transition": null,
"sequence_number": 1,
"display_label": "Screen 3",
"background_color": "#00A3F3",
"name": "WB_Screen_3",
"id": "2423488000000709072",
"category": "wizard_button"
}
],
"tab_traversal": "left_to_right",
"column_count": 2,
"id": "2423488000000709070",
"type": "buttons"
}
]
}
],
"id": "2423488000000095055"
}
],
"id": "2423488000000709012",
"created_by": {
"name": "Patricia",
"id": "2423488000000483001"
}
}
]
}