SOAP API 開発者ガイド
jretrieve()
指定した ID に基づいて 1 つ以上のレコードを取得します。
構文
使用方法
retrieve() コールを使用すると、オブジェクトから個別のレコードを取得できます。クライアントアプリケーションは、取得する項目、オブジェクト、および取得するレコード ID の配列を渡します。retrieve() コールは、削除されたレコードを返しません。
一般に、取得するレコードの ID が前もってわかっている場合に、retrieve() を使用します。ID がわかっていないか、他の選択条件を指定する場合は、代わりに query() を使用します。
クライアントアプリケーションは、retrieve() を使用してクライアント側で結合を実行できます。たとえば、クライアントアプリケーションは、query() を実行して、一連の Opportunity レコードを取得し、返された商談レコードを反復処理しながら、商談ごとに accountId を取得し、retrieve() をコールしてその accountId の Account 情報を取得できます。
特定のオブジェクトのレコードは、API からは取得できません。retrieve() コールからレコードを取得するには、そのオブジェクトが取得可能に設定されている (retrieveable が true) 必要があります。取得可能かどうかを決定するために、クライアントアプリケーションは、オブジェクトで describeSObjects() コールを呼び出すことができ、retrievable プロパティを確認することができます。
クライアントアプリケーションは、指定したオブジェクト内のレコードを取得し、指定した項目リストの項目を取得するのに十分なアクセス権限でログインする必要があります。詳細は、「データアクセスに影響する要素」を参照してください。
サンプルコード —C#
このサンプルでは、指定の取引先レコードの「ID」、「Name」、「Website」を取得します。取得したレコードの項目をコンソールに書き込みます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| fieldList | string | カンマで区切られた指定オブジェクトの 1 つ以上のリスト。有効な項目名を指定する必要があり、各指定項目の参照レベルの権限を持っている必要があります。fieldList は、result 内の項目の順序を定義します。 |
| sObjectType | string | データ取得元のオブジェクト。指定された値は、組織で有効なオブジェクトである必要があります。完全なオブジェク���のセットについては、「標準オブジェクト」を参照してください。 |
| ids | ID[] | 取得するオブジェクトの 1 つ以上の ID の配列。retrieve() コールには、最大 2000 個のオブジェクト ID を渡すことができます。ID についての詳細は、「ID データ型」を参照してください。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| result | sObject[] | 指定されたオブジェクトの個別レコードを表す、1 つ以上の sObject からなる配列。配列で返される sObject の数は、retrieve() コールに渡す ID の数と同じになります。オブジェクトへのアクセスを持たないか、パスされた ID が無効の場合、配列は、そのオブジェクトに null を返します。ID についての詳細は、「ID データ型」を参照してください。 |