提取组件 API

目的

此 API 用于了解表单中可用的组件的详细信息。

请求 URL

https://people.zoho.com.cn/people/api/forms/<formLinkName>/components?authtoken=<token>

注:

  • 请参阅 API 参考页以查看表单列表。必须以管理员身份登录才可查看该页面。
  • 组件的查找值包含“值”作为键值,其查找 id 的键值为 ID。

请求参数

authtoken 指定身份验证令牌
formLinkName 要获取 formLinkName,请使用提取表单 API

示例

请求 URL:

https://people.zoho.com.cn/people/api/forms/department/components?authtoken=7d985878998943g4j09h43dd0b167dda34b

XML 响应:

<?xml version=""1.0"" encoding=""UTF-8""?>
<response uri=""/api/forms/department/components"">
<status>
0</status>
<message>
Data fetched successfully</message>
<result>
<Components>
<Component>
<labelname>
Department</labelname>
<ismandatory>
true</ismandatory>
<ishidden>
false</ishidden>
<comptype>
Text</comptype><displayname>Department Name</displayname>
</Component>
<Component>
<labelname>
MailAlias</labelname>
<ismandatory>
false</ismandatory>
<ishidden>
false</ishidden>&
lt;comptype>
Email</comptype>
<displayname>
Mail Alias</displayname>
</Component><Component>
<labelname>
Department_Lead</labelname><ismandatory>
false</ismandatory>
<ishidden>false</ishidden>
<comptype>
Lookup</comptype>
<Options>
<Option3>
<Value>11</Value>
<Id>
3000000024131</Id>
</Option3>
<Option1>
<Value>5</Value><Id>
3000000020481</Id>
</Option1>
<Option2>
<Value>
2</Value>
<Id>
3000000020509</Id>
</Option2>
</Options>
<displayname>
Department Lead</displayname>
</Component>
<Component>
<labelname>
Parent_Department</labelname><ismandatory>false</ismandatory>
<ishidden>false</ishidden><comptype>Lookup</comptype>
<Options><Option1><Value>People</Value><Id>
3000000032001</Id>
</Option1>
</Options><displayname>Parent Department</displayname>
</Component><Component>
<labelname>Dropdown_1</labelname><ismandatory>false</ismandatory>
<ishidden>false</ishidden><comptype>Picklist</comptype><Options>
<Option3>Option 3</Option3>
<Option1>
Option 1</Option1>
<Option2>
Option 2</Option2>
</Options>
<displayname>
Dropdown 1</displayname></Component>
</Components>
</result>
</response>

JSON 响应:

{"response":{"message":"Data fetched successfully","result":[{"labelname":"Department","ismandatory":"true","ishidden":"false","comptype":"Text","displayname":"Department Name"},{"labelname":"MailAlias","ismandatory":"false","ishidden":"false","comptype":"Email","displayname":"Mail Alias"},{"labelname":"Department_Lead","ismandatory":"false","ishidden":"false","comptype":"Lookup","Options":{"Option3":{"Value":"11","Id":3000000024131},"Option1":{"Value":"5","Id":3000000020481},"Option2":{"Value":"2","Id":3000000020509}},"displayname":"Department Lead"},{"labelname":"Parent_Department","ismandatory":"false","ishidden":"false","comptype":"Lookup","Options":{"Option1":{"Value":"People","Id":3000000032001}},"displayname":"Parent Department"},{"labelname":"Dropdown_1","ismandatory":"false","ishidden":"false","comptype":"Picklist","Options":{"Option3":"Option 3","Option1":"Option 1","Option2":"Option 2"},"displayname":"Dropdown 1"}],"status":0,"uri":"/api/forms/department/components"}

错误代码

请参阅错误代码