SOAP API 開発者ガイド
jDescribeCompactLayoutsResult
describeCompactLayouts() コールは、渡された sObjectType に関する最上位のレコードタイプ情報を含む DescribeCompactLayoutsResult オブジェクトを返します。また、レコードタイプからコンパクトレイアウトへの対応付けも返します。使用しているクライアントアプリケーションは、このオブジェクトを詳細に辿り、コンパクトレイアウトの詳細なメタデータを取得します。
| 名前 | 型 | 説明 |
|---|---|---|
| compactLayouts | DescribeCompactLayout[] | オブジェクトにより使用中のすべてのコンパクトレイアウトのリスト。 |
| defaultCompactLayoutId | ID | オブジェクトに割り当てられた主コンパクトレイアウトの ID。 |
| recordTypeCompactLayoutMappings | RecordTypeCompactLayoutMapping[] | オブジェクトのレコードタイプの対応付け。オブジェクトに関連付けられたコンパクトレイアウトは、複数のレコードタイプに対応付けられている場合があります。 |
DescribeCompactLayout
DescribeCompactLayout リストの個別の項目を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| actions | DescribeLayoutButton[] | コンパクトレイアウトに関連付けられた 1 つ以上の DescribeLayoutButton 項目の配列。このリストは Salesforce によって設定され、参照のみ可能です。 |
| fieldItems | DescribeLayoutItem[] | コンパクトレイアウトに関連付けられた 1 つ以上の項目の配列。 |
| id | ID | このコンパクトレイアウトの一意の ID。ID についての詳細は、「ID データ型」を参照してください。 |
| imageItems | DescribeLayoutItem[] | コンパクトレイアウトに関連付けられた 1 つ以上の画像の配列。このリストは Salesforce によって設定され、参照のみ可能です。 |
| label | string | コンパクトレイアウトの表示ラベル。 |
| name | string | コンパクトレイアウトの API 名。 |
| objectType | string | コンパクトレイアウトが割り当てられているオブジェクトの名前。 |
RecordTypeCompactLayoutMapping
DescribeCompactLayoutsResult オブジェクトの recordTypeCompactLayoutMappings 項目の単一のレコードタイプの対応付けを表します。オブジェクトは、有効な recordTypeId の compactLayoutId に対する対応付けです。
| 名前 | 型 | 説明 |
|---|---|---|
| available | boolean | このレコードタイプが利用可能かどうかを示します (利用可能な場合は true、そうでない場合は false)。利用可能かどうかという情報は、新しいレコードの作成時に利用可能なレコードタイプの一覧をユーザに表示するのに使用します。 |
| compactLayoutId | ID | このレコードタイプに関連付けられたコンパクトレイアウトの ID。 |
| compactLayoutName | string | コンパクトレイアウトの API 名。 |
| recordTypeName | string | レコードタイプの API 名。 |
| recordTypeId | ID | レコードタイプの ID。 |