フィードバック

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

  • [アーティクル]

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

構文

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

パラメーター

Name 型 必要 内容
entityLogicalName String 有効 取得するレコードのテーブルの論理名。 たとえば、「account」。
ID String 有効 取得するテーブル レコードの GUID。
オプション String 無効

データを取得する OData システム クエリ オプション、$select および $expand。

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

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

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

さまざまな取得のシナリオ向けに options パラメーターを定義する方法については、この記事の後半にある例を参照してください。
successCallback 関数 無効

レコードを取得した場合に呼び出す関数。 取得したプロパティと値を持つ JSON オブジェクトが関数に渡されます。
errorCallback 関数 無効 処理が失敗したときに呼び出す関数。

戻り値

成功すると、取得した列とその値を持つ 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

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。