getFields 方法
目的
您可以使用getFields方法获取特定模块中可用的字段详细信息。
请求 URL
XML 格式:
https://crm.zoho.com.cn/crm/private/xml/Tasks/getFields?authtoken=Auth Token&scope=crmapi
JSON 格式:
https://crm.zoho.com.cn/crm/private/json/Tasks/getFields?authtoken=Auth Token&scope=crmapi
注意:
- 您可以更改请求 URL 中的模块名称以便从其它模块中获取字段。
请求参数
参数 | 数据类型 | 说明 |
authtoken* | 字符串 | 验证您的 Zoho 凭据的加密字母数字字符串。 |
scope* | 字符串 | 将数值指定为crmapi。 |
类型 | 字符串 | 将数值指定为 1 或 2
注意: 如果您想要从模块中检索所有字段,请务必注意指定类型。 |
* - 必填参数
注意:
- 参考发布说明页面了解关于 API 执行中进行的强化的更多信息。
样本响应
<?xml version="1.0" encoding="UTF-8" ?>
- <Potentials>
- <section name="Potential Information" dv="Potential Information">
<FL req="false" type="Lookup" maxlength="120" label="Potential Owner" customfield="false" />
<FL req="false" type="Currency" maxlength="16" fval="$0.00" label="Amount" customfield="false" />
<FL req="true" type="Text" maxlength="120" label="Potential Name" customfield="false" />
<FL req="true" type="Date" maxlength="20" label="Closing Date" customfield="false" />
<FL req="true" type="Lookup" maxlength="100" label="Account Name" customfield="false" />
+ <FL req="true" type="Pick List" maxlength="100" label="Stage" customfield="false">
+ <FL req="false" type="Pick List" maxlength="120" label="Type" customfield="false">
<FL req="false" type="Integer" maxlength="3" label="Probability" customfield="false" />
<FL req="false" type="Text" maxlength="100" label="Next Step" customfield="false" />
<FL req="false" type="Currency" maxlength="16" fval="$0.00" label="Expected Revenue" customfield="false" />
+ <FL req="false" type="Pick List" maxlength="120" label="Lead Source" customfield="false">
<FL req="false" type="Lookup" maxlength="50" label="Campaign Source" customfield="false" />
<FL req="false" type="Lookup" maxlength="50" label="Contact Name" customfield="false" />
<FL req="false" type="OwnerLookup" maxlength="25" label="Created By" customfield="false" />
<FL req="false" type="OwnerLookup" maxlength="25" label="Modified By" customfield="false" />
<FL req="false" type="Text" maxlength="10" label="newfield" customfield="true" />
</section>
-<section name="Description Information" dv="Description Information">
<FL req="false" type="TextArea" maxlength="32000" label="Description" customfield="false" />
</section>
</Potentials>
其它说明
业务场景
- 与第 3 方应用程序集成时的字段映射