smemo

技術メモです。

【Dynamics】WebAPI 代替キーを使用してクエリ

WebAPIでデータをクエリするときに、代替キーを設定しているエンティティでは代替キーを指定してクエリすることが可能。その方法についてメモ。

コード

// accountnumberが代替キーで設定したフィールド
https://org.api.crm7.dynamics.com/api/data/v8.2/accounts(accountnumber='A001')
// 取得フィールドの絞り込みも可
https://org.api.crm7.dynamics.com/api/data/v8.2/accounts(accountnumber='A004')?$select=name,donotpostalmail,_ownerid_value
// 関連エンティティの取得も可
https://org.api.crm7.dynamics.com/api/data/v8.2/accounts(accountnumber='A004')?$select=name&$expand=primarycontactid($select=emailaddress1)
注意点

代替キーを使用したクエリでは、検索結果が0件の場合に404エラーが返却されるので注意が必要です。