SOAP API 開発者ガイド
jdescribeCompactLayouts()
構文
使用方法
このコールを使用し、指定されたオブジェクト種別のコンパクトレイアウトに関する情報を取得します。このコールは、レコードタイプの対応付けを含む、指定されたコンパクトレイアウトに関するメタデータを返します。コンパクトレイアウトについての詳細は、Salesforce オンラインヘルプを参照してください。
サンプルコード —Java
このサンプルでは、取引先 sObject のコンパクトレイアウトを取得する方法を示します。記述する sObject 種別の名前を使用して、describeCompactLayouts() をコールします。コンパクトレイアウトの取得後、各コンパクトレイアウトで検出された画像、項目、およびアクションボタンが出力されます。次に、オブジェクトのシステムデフォルトコンパクトレイアウト、コンパクトレイアウトへのレコードタイプの対応付け情報の順に出力されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| sObjectType | string | 指定された値は、組織で有効なオブジェクトである必要があります。オブジェクトが個人取引先である場合は Account を指定し、個人取引先責任者である場合は Contact を指定します。 |
| recordTypeId | ID[] | 任意で指定できるパラメータ。返されるコンパクトレイアウトデータを、指定されたレコードタイプに制限します。 |