Dynamics 365 チャネル統合フレームワーク 1.0 の retrieveRecord (JavaScript API リファレンス)

  • [アーティクル]

エンティティ レコードを取得します。

構文

Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Parameters

件名 タイプ Required Description
entityLogicalName String あり 取得するレコードのエンティティの論理名。 たとえば、「account」。
ID String あり 取得するエンティティ レコードの GUID。
オプション String 無効

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

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

? で始まるクエリ オプションを指定します。 クエリ オプションを & で区切って複数のクエリ オプションを指定することもできます。 たとえば、次のようなものです。

?$select=name&$expand=primarycontactid($select=contactid,fullname)
successCallback 機能 なし

レコードを取得した場合に呼び出す関数。
errorCallback 機能 なし 処理が失敗したときに呼び出す関数。

戻り値

成功すると、取得した属性とその値を持つ文字列を含む Promise が返されます。

例

このサンプル コードは、ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200 を持つ取引先担当者レコードの名前と電話番号を取得します。

// retrieve contact record
var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
var entityLogicalName = "contact";
Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, "?$select=fullname,telephone1").then(
    function success(result) {
      res=JSON.parse(result);
        console.log(`Retrieved values: Full Name: ${res.fullname}, Telephone Number: ${res.telephone1}`);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);