getRelatedListRecordsBatch

RelatedLists のレコードを一括で取得するには、このワイヤーアダプターを使用します。

「Get a Batch of Related List Records with a Request Body (リクエストボディを使用した関連リストレコードの一括取得)」を参照してください。

  • parentRecordId — (必須) 関連リストを取得する必要がある親レコードの ID (取引先 ID など)。
  • relatedListParameters — (必須) 関連リストパラメーターコレクションの配列。パラメーターは次のとおりです。
    • relatedListId — (必須) Contacts、Opportunities、Cases などの関連リストオブジェクトの API 参照名。
    • fields — (省略可能) 関連リストの列項目の API 参照名。
    • optionalFields — (省略可能) 関連リスト内の追加項目の API 参照名。
    • pageSize — (省略可能) ページごとに返されるリストレコードの数。
    • sortBy — (省略可能) 関連リストを並び替える基準となる項目 API 参照名の配列。1 つの要求で受け入れる値は 1 つのみです。
    • where — (省略可能) GraphQL 構文で関連リストレコードに適用する検索条件。

次のコード例では、親 ID と複数の関連リストオブジェクトによって関連リストのレコードを一括取得し、レコードのリストを反復処理します。

関連トピック