getFieldsメソッド
目的
getFieldsメソッドを使用すると、特定のタブで使用可能な項目の詳細を取得できます。
リクエストURL
XML形式：
https://crm.zoho.com/crm/private/xml/Tasks/getFields?authtoken=Auth Token&scope=crmapi
JSON形式：
https://crm.zoho.com/crm/private/json/Tasks/getFields?authtoken=Auth Token&scope=crmapi
注：
- リクエストURLのタブ名を変更すると、他のタブの項目を取得できます。
リクエストパラメーター
| パラメーター | データ型 | 説明 |
| authtoken* | 文字列 | Zoho認証情報の認証に使用する、暗号化された英数字文字列。 |
| scope* | 文字列 | 値をcrmapiと指定してください。 |
| type | 文字列 | 値を1または2で指定してください。
注：タブの全項目を取得する場合は、typeを指定しないでください。 |
* - 必須パラメーター
注：
- 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>
その他の注意事項
- Zoho CRMアカウントからデータを取得する際には、項目単位のセキュリティが適用されます。詳細については、セキュリティ管理を参照してください。
利用例
- 外部サービスアプリケーションと連携させる場合の項目の関連付け