getRelatedListInfo

RelatedList のメタデータを取得するには、このワイヤアダプタを使用します。

「Get Related List Metadata (関連リストメタデータの取得)」を参照してください。

• parentObjectApiName — (必須) 関連リストを取得する必要がある親オブジェクトの API 参照名 (取引先など)。
• relatedListId — (必須) Contacts、Opportunities、Cases などの関連リストオブジェクトの API 名。
• recordTypeId — (省略可能) 親レコードタイプの ID。指定されていない場合は、デフォルトのレコードタイプが使用されます。
• fields — (省略可能) 関連リストの項目の API 参照名。
• optionalFields — (省略可能) 関連リスト内の追加項目の API 参照名。
• restrictColumnsToLayout — (省略可能) ページレイアウトのリスト列のメタデータのみを取得するか (true)、すべての列のメタデータを取得するか (false) を示します。デフォルト値は、true です。列をさらに絞り込むには、restrictColumnsToLayout を fields と optionalFields で使用します。

• data — 関連リストの情報
• error — FetchResponse

次のコード例では、Account オブジェクトの Contacts 関連リストのメタデータを取得し、表示列のリストを反復処理します。

関連トピック

• ワイヤサービスについて
• Lightning データサービスでのエラーの処理
• lightning/ui*Api モジュールでサポートされている Salesforce オブジェクト