本オペレーションではMicrosoft Dynamics 365 Web APIを使用します。API仕様については以下のページを参照してください。
本オペレーションではAzure Active Directoryを認証に使用します。Azure Active Directoryの構成については以下のページを参照してください。
Dynamics 365 (オンライン)またはDynamics CRM Online 2016の「設定」-「カスタマイズ」-「開発者リソース」にある「サービスのルートURL」を入力してください。
URLは「https://<ホスト名>/api/data/<APIのバージョン>/」の形式です。
[認証]のグローバルリソースの設定方法については、以下のページを参照してください。
各オペレーション対象への権限があるセキュリティロールが適用されたユーザーが必要です。権限については以下のページを参照してください。
グローバルリソースの[追加パラメータ]に以下の指定が必要です。
| [追加パラメータ/キー] | [追加パラメータ/値] | 備考 |
|---|---|---|
| resource | <[接続先]に設定した[サービスのルートURL]のうち、スキームとホスト名部分> |
|
[リソースパス]については、以下のページを参照してください。
Entity型(Navigationプロパティ)は[リソースパス]にキーが指定されエンティティが一意となっている場合のみ表示されます。
| [リソースパス]の例 | Entity型(Navigationプロパティ)が表示されるか |
|---|---|
| accounts | 表示されません |
| accounts(00000000-0000-0000-0000-000000000001) | 表示されます |
| accounts(accountid=00000000-0000-0000-0000-000000000001) | 表示されます |
| accounts(00000000-0000-0000-0000-000000000001)/contact_customer_accounts | 表示されません |
[フィルター]に設定するクエリについては、以下のページを参照してください。
[エンティティセット名一覧を更新]で取得した一部エンティティセットは、読み取りに対応していない場合があります。
[フィールド定義を更新]で取得した一部フィールドは、読み取りに対応していない場合があります。| 文字 | : | * | & | % | + |
|---|
[リソースパス]にキーを指定しても無視されます。
[エンティティセット名一覧を更新]で取得した一部エンティティセットは、書き込みに対応していない場合があります。
[フィールド定義を更新]で取得した一部フィールドは、書き込みに対応していない場合があります。
所有者(ownerid)に存在しないエンティティを指定した場合、処理はエラーになりますが[リソースパス]に設定したエンティティは作成されます。
以下の条件をすべて満たす場合、関連先のエンティティは作成されません。
代替キーを使用して以下の操作を行う場合、キーとするフィールドに使用できない文字があります。| 文字 | 更新操作 | エンティティを関連付ける操作 |
|---|---|---|
| : | × | ○ |
| ? | × | × |
| ' | × | × |
| * | × | ○ |
| / | × | × |
| \ | × | × |
| & | × | ○ |
| # | ○ | × |
| % | × | ○ |
| + | × | ○ |
| < | × | ○ |
| > | × | ○ |
[リソースパス]にキーを指定しても無視されます。
[エンティティセット名一覧を更新]で取得した一部エンティティセットは、削除に対応していない場合があります。| 例外名 | 原因 | 対策 |
|---|---|---|
| HttpClientException java.lang.IllegalStateException: Target host must not be null, or set in parameters. |
[サービスのルートURL]が不正です。 |
|
| HttpClientException org.apache.http.client.ClientProtocolException: Scheme '<プロトコル>' not registered. |
対応していないプロトコルです。 |
|
| HttpClientException java.net.UnknownHostException: <ホスト名> |
ホストが見つかりません。 |
|
| EdmException Cannot find EntitySet, entitySetName=<エンティティセット名> |
エンティティセットが存在しません。 |
|
| EdmException Cannot find EntityType, path=<エンティティ名>/<フィールド名> |
エンティティにフィールドが存在しません。 |
|
| ODataClientErrorException (401) Unauthorized [HTTP/1.1 401 Unauthorized] |
認証に失敗しました。 |
|
| ODataClientErrorException <エラーメッセージ> [<HTTPステータス>] |
処理に失敗しました。 |
|