retrieveRecord (クライアント API 参照)

テーブル レコードを取得します。

構文

Xrm.WebApi.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Parameters

オプション

返される内容を制御するには、$select および $expand OData システム クエリ オプションを使用してデータを取得します。

プロパティ名のコンマ区切りリストを含めることにより返されるプロパティを制限するためには $select システム クエリ オプションを使用します。 特定のプロパティを選択することは、パフォーマンスに関する重要なベスト プラクティスです。 プロパティが $select を使用して指定されない場合、すべてのプロパティが返されます。

$expand システム クエリ オプションを使用して、関連テーブルからどのデータが返されるかをコントロールします。 単にナビゲーション プロパティ名を含めた場合は、関連レコードのすべてのプロパティが表示されます。 ナビゲーション プロパティ名の後にかっこで示される、$select システム クエリ オプションを使用して、関連レコードに対して返されるプロパティを制限できます。 これは、単一値とコレクション値のナビゲーション プロパティの両方で使用します。 オフラインの場合、$expand 内の入れ子になった $select オプションのみがサポートされます。

? で始まるクエリ オプションを指定します。 クエリ オプションを & で区切って複数のクエリ オプションを指定することもできます。 例:

?$select=name&$expand=primarycontactid($select=contactid,fullname)

複数取得のさまざまなシナリオ向けに パラメーターを定義する方法については、このトピックの以降の 例 を参照してください。

戻り値

成功すると、取得した列とその値を持つ JSON オブジェクトを含む Promise が返されます。 要求されたレコードが存在しない場合、エラーを返します。

使用例

次の例を参照してください。

• 基本的な取得
• 単一値ナビゲーション プロパティの拡張によるテーブル インスタンスに対する関連テーブルの取得

基本的な取得

レコード ID = 5531d753-95af-e711-a94e-000d3a11e605 の取引先企業レコードの名前と売り上げを取得します。

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name,revenue").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Revenue: " + result.revenue);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

上の例では、コンソールに以下のテキストが表示されます。データによっては、別の値が表示される場合があります。

Retrieved values: Name: Sample Account, Revenue: 5000000

単一値ナビゲーション プロパティの拡張によるテーブル インスタンスに対する関連テーブルの取得

以下の例は、記録 ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200 を持つアカウント レコードの連絡先を取得する方法について示しています。 関連する取引先担当者レコードの場合は、contactid および fullname プロパティのみを取得します。

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name&$expand=primarycontactid($select=contactid,fullname)").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Primary Contact ID: " + result.primarycontactid.contactid +
                ", Primary Contact Name: " + result.primarycontactid.fullname);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

上の例では、コンソールに以下のテキストが表示されます。データによっては、別の値が表示される場合があります。

Retrieved values: Name: Adventure Works, Primary Contact ID: 49a0e5b9-88df-e311-b8e5-6c3be5a8b200, Primary Contact Name: Adrian Dumitrascu

関連記事

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi