createRecord (Client API 参照)
新しいテーブルを作成します。
構文
Xrm.WebApi.createRecord(entityLogicalName, data).then(successCallback, errorCallback);
パラメーター
| 件名 | 種類 | 必須出席者 | 内容 |
|---|---|---|---|
| entityLogicalName | String | 有効 | 作成するテーブルの論理的な名前です。 たとえば、「account」。 |
| data | オブジェクト | 有効 | 新しいテーブルレコードの列と値を定義する JSON オブジェクトです。 さまざまな作成のシナリオ向けに |
| successCallback | 関数 | 無効 | レコードを作成した場合に呼び出す関数。 次のプロパティを持つオブジェクトが渡され、新しいレコードが識別されます:
|
| errorCallback | 関数 | 無効 | 処理が失敗したときに呼び出す関数。 次のプロパティを持つオブジェクトが渡されます。
|
戻り値
成功時に、successCallback パラメーターの説明で指定済みの値を含む promise オブジェクトを戻します。
例
これらの例では、Web API を使用したテーブルの作成 で示した要求オブジェクトの一部を使用して、テーブル レコードを作成するためのデータ オブジェクトを定義しています。
基本的な作成
サンプルの取引先企業レコードを作成します。
// define the data to create new account
var data =
{
"name": "Sample Account",
"creditonhold": false,
"address1_latitude": 47.639583,
"description": "This is the description of the sample account",
"revenue": 5000000,
"accountcategorycode": 1
}
// create account record
Xrm.WebApi.createRecord("account", data).then(
function success(result) {
console.log("Account created with ID: " + result.id);
// perform operations on record creation
},
function (error) {
console.log(error.message);
// handle error conditions
}
);
プライマリ レコードとともに関連するテーブルレコードを作成します
ナビゲーション プロパティ値として定義することにより、相互に関連するテーブルを作成できます。 これを ディープ挿入 と言います。 この例では、取引先責任者レコードとそれに関連する営業案件レコードと共にサンプル取引先企業レコードを作成します。
注意
1回の作成操作で関連するテーブル レコードを作成することは、オフライン モードではサポートされていません。
// define data to create primary and related table records
var data =
{
"name": "Sample Account",
"primarycontactid":
{
"firstname": "John",
"lastname": "Smith"
},
"opportunity_customer_accounts":
[
{
"name": "Opportunity associated to Sample Account",
"Opportunity_Tasks":
[
{ "subject": "Task associated to opportunity" }
]
}
]
}
// create account record
Xrm.WebApi.createRecord("account", data).then(
function success(result) {
console.log("Account created with ID: " + result.id);
// perform operations on record creation
},
function (error) {
console.log(error.message);
// handle error conditions
}
);
新規レコードの作成時にテーブルを関連付ける
既存のテーブル レコードに新規テーブルを関連付けるには、 @odata.bind 注釈を使用して単一値ナビゲーション プロパティの値を設定します。 ただし、オフライン モードのモバイル クライアントの場合、@odata.bind 注釈を使用することはできません。代わりに、目的のレコードを示す 検索 オブジェクト (logicalname および id) を渡す必要があります。 これは両方のシナリオ用のコード例です。
オンライン シナリオ用 (サーバーに接続済み)
次の例は取引先企業レコードを作成して、既存の取引先担当者レコードに関連付け、後者を新しい取引先企業レコードの取引先責任者としてセットします。
var data =
{
"name": "Sample Account",
"primarycontactid@odata.bind": "/contacts(465b158c-541c-e511-80d3-3863bb347ba8)"
}
// create account record
Xrm.WebApi.createRecord("account", data).then(
function success(result) {
console.log("Account created with ID: " + result.id);
// perform operations on record creation
},
function (error) {
console.log(error.message);
// handle error conditions
}
);
モバイル オフライン シナリオ用
これは、オフライン モードで作業中にモバイル クライアントから取引先企業レコードを作成して、それを既存の取引先担当者レコードに関連付け、この取引先担当者レコードを新しい取引先企業レコードの取引先責任者として設定する、更新されたサンプル コードです。
var data =
{
"name": "Sample Account",
"primarycontactid":
{
"logicalname": "contact",
"id": "465b158c-541c-e511-80d3-3863bb347ba8"
}
}
// create account record
Xrm.WebApi.offline.createRecord("account", data).then(
function success(result) {
console.log("Account created with ID: " + result.id);
// perform operations on record creation
},
function (error) {
console.log(error.message);
// handle error conditions
}
);
関連トピック
注意
ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)
この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。
フィードバック
フィードバックの送信と表示