getRecords

レコードのデータを一括で一度に取得するには、このワイヤーアダプターを使用します。複数のオブジェクトまたは異なるレコードタイプを要求できます。

getRecords ワイヤーアダプターでは、このユーザーインターフェース API リソースが使用されますが、そのすべてのパラメーターはサポートされません。

  • records — 複数のオブジェクトまたはレコードタイプにわたる可能性があるレコードデータの配列。

  • recordIds — (少なくとも 1 つが必須) サポートされているオブジェクトから取得するレコードの ID。

  • fields — 返される項目の配列。コンテキストユーザーに項目へのアクセス権がない場合、エラーが返されます。コンテキストユーザーに項目へのアクセス権があるかどうかがわからず、ない場合に要求を失敗させないようにする場合は、optionalFields パラメーターを使用します。

    ObjectApiName.FieldName または ObjectApiName.JunctionIdListName 形式で項目名を指定します。

    多態的な項目はサポートされていません。fields に多態的な項目を含めると、無効な項目のエラーが発生することがあります。

  • optionalFields — (省略可能) 省略可能項目名の配列。コンテキストユーザーに項目へのアクセス権がある場合、その項目は応答に含まれます。コンテキストユーザーに項目へのアクセス権がない場合、その項目は応答に含まれませんが、エラーも発生しません。ObjectApiName.FieldName または ObjectApiName.JunctionIdListName 形式で項目名を指定します。

  • propertyOrFunction — ワイヤーサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

  • resultsバッチの結果
  • hasErrors — 結果セットに HTTP 状況コードが 400 番台または 500 番台の結果が 1 つ以上ある場合は true、それ以外の場合は false

1 つのレコードのデータを取得するには、getRecord を使用します。

条件による絞り込みや、動的なレコード ID の操作を容易にするには、代わりに GraphQL ワイヤーアダプターの使用について検討してください。

次の例では、レコード ID を使用して複数のレコードを読み込んでいます。recordId の値を適切な値に置き換えます。

代わりに、複数のオブジェクトにわたるレコードを要求できます。

動的なレコード ID を操作するには、代わりに GraphQL ワイヤーアダプターを使用してください。

動的なレコード ID を使用して getRecords ワイヤーアダプターを使用する場合は、レコードパラメーターを単一のプロパティとして転送できる parameterObject 配列を作成することをお勧めします。配列を使用すれば、複数のオブジェクトのレコード ID と項目を定義できます。

たとえば、Apex コントローラーで取引先ごとに取引先責任者 ID を取得し、それを parameterObject 配列に渡すことができます。配列は connectedCallback または renderedCallback で作成できます。また、親コンポーネントから、配列を初期化する子コンポーネントにレコードパラメーターを渡すこともできます。

この例は、parameterObject 配列の設定方法を示しています。IDs オブジェクトには、getRecords ワイヤーアダプターを使用して取得する連絡先レコードの ID が含まれています。

ワイヤーアダプターをコールすると、ユーザーインターフェース API によって要求の SOQL クエリが作成されます。この SOQL クエリには 10 万文字の制限があります。この制限を超えることが予想される場合は、クエリを複数のクエリに分割してバッチで実行することをお勧めします。

getRecordserror プロパティでエラーを返します。エラーを表示するには、then() ブロックと catch() ブロックが含まれる Promise を使用して lightning/platformShowToastEvent モジュールで提供されるトーストを使用できます。