Dynamics 365 for Customer Engagement コネクターのメッセージおよび制限事項

 

オペレーションについては「Dynamics 365 for Customer Engagement」(オペレーショントップページ)を参照してください。

DYNAMICSCRMカテゴリのメッセージコード一覧

Dynamics 365 for Customer Engagement Connectorで発生するエラーに対応するメッセージコードです。

 

DYNAMICSCRM0000E

定義されていないエラーが発生した場合に出力されるメッセージコードです。

原因

対策

定義されていないエラーが発生しました。

エラーメッセージやエラーが発生した処理のヘルプなどを確認してください。

対応するエラー

  • 特になし

 

DYNAMICSCRM0001E

リソースパスが不正である場合に出力されるメッセージコードです。

原因

対策

リソースパスの形式が不正です。

リソースパスを確認してください。

対応するエラー

  • InvalidResourcePathException

 

DYNAMICSCRM0002E

エンティティのキーが未指定の場合に出力されるメッセージコードです。

原因

対策

キーが未指定です。

キーが含まれているかを確認してください。

対応するエラー

  • InvalidKeySegmentException

 

DYNAMICSCRMカテゴリの例外メッセージ

例外名

原因

対策

DateTimeParseException

型の変換に失敗しました。

日時型のフィールドに日付型に変換できる値が設定されているか確認してください。

IllegalArgumentException

Invalid UUID string: <キー値>

型の変換に失敗しました。

検索型(GUID)のフィールドに検索型(GUID)に変換できる値が設定されているか確認してください。

InvalidKeySegmentException

The key must not be null or empty

キーが未指定です。

キーが含まれているかを確認してください。

InvalidPropertyConfigurationException

<プロパティ名>が指定されていません。

<プロパティ名>が指定されていません。

<プロパティ名>を指定してください。

InvalidPropertyConfigurationException

エンティティフィールドに関連付けられたエンティティセットにキーフィールドが存在しません。[エンティティフィールド=<エンティティフィールド>][関連先キーフィールド=<関連先キーフィールド>]

関連先キー設定で<エンティティフィールド>に指定されたキーフィールドが存在しません。

関連先キー設定で、<エンティティフィールド>の関連先キーフィールドに存在するキーフィールドを設定してください。

InvalidResourcePathException

Invalid resource path: <リソースパス>

リソースパスの形式が不正です。

リソースパスを確認してください。

InvalidSchemaException

No such property: <フィールド名>

指定のフィールドが存在しません。

エンティティにフィールドが存在するか確認してください。

NumberFormatException

型の変換に失敗しました。

数値型のフィールドに数値型に変換できる値が設定されているか確認してください。

ResourceNotFoundException

リソース定義が見つかりませんでした。名前:[]

接続先または認証が指定されていません。

接続先または認証を指定してください。

ResourceNotFoundException

リソース定義が見つかりませんでした。名前:[<コネクションリソース名>]

接続先または認証で選択されたリソース定義が見つかりません。

接続先または認証で指定したコネクションリソースを確認してください。

HttpClientException

java.lang.IllegalStateException: Target host must not be null, or set in parameters.

サービスのルートURLが不正です。

サービスのルートURLを確認してください。

HttpClientException

org.apache.http.client.ClientProtocolException: Scheme '<プロトコル>' not registered.

対応していないプロトコルです。

サービスのルートURLを確認してください。

HttpClientException

java.net.UnknownHostException: <ホスト名>

ホストが見つかりません。

サービスのルートURLを確認してください。

EdmException

Cannot find EntitySet, entitySetName=<エンティティセット名>

エンティティセットが存在しません。

リソースパスに設定したエンティティセットが存在するか確認してください。

EdmException

Cannot find EntityType, path=<エンティティ名>/<フィールド名>

エンティティにフィールドが存在しません。

リソースパスに設定したエンティティのフィールドが存在するか確認してください。

ODataClientErrorException

(401) Unauthorized [HTTP/1.1 401 Unauthorized]

認証に失敗しました。

  • サービスのルートURLを確認してください。

  • 認証を確認してください。

    • 指定した認証のコネクションリソースでトークンを発行できることを確認してください。

    • 対象への権限があるセキュリティロールが適用されたユーザーであることを確認してください。

ODataClientErrorException

<エラーメッセージ> [<HTTPステータス>]

処理に失敗しました。

  • エラーメッセージの内容を確認してください。

  • HTTPステータスについては以下のページを参照してください。

    • 「HTTP 要求の作成とエラーの処理」(https://msdn.microsoft.com/library/gg334391.aspx)

  • 処理共通の対策

    • リソースパスに設定したエンティティが存在するか確認してください。

    • リソースパスに設定したエンティティのフィールドが存在するか確認してください。

    • リソースパスに対応したフィールド定義であるか確認してください。

  • エンティティ読み取り処理固有の対策

    • フィルターに設定した条件を確認してください。

    • リソースパスに設定したエンティティが読み取り可能か確認してください。

    • フィールド定義に設定したフィールドが読み取り可能か確認してください。読み取りできないフィールドの選択を外してください。

  • エンティティ書き込み処理固有の対策

    • 処理に失敗したエンティティをスキップするを確認してください。

    • キーが指定された場合の処理方式を確認してください。

    • リソースパスに設定したエンティティが書き込み可能か確認してください。

    • フィールド定義に設定したフィールドが書き込み可能か確認してください。書き込みできないフィールドの選択を外してください。

    • リソースパスのキーフィールドに設定したキーフィールドが、リソースパスに設定したエンティティに存在するか確認してください。

    • 関連先キー設定関連先キーフィールドに設定したキーフィールドが、同行の[関連先エンティティ]に表示されたエンティティに存在するか確認してください。

  • エンティティ削除処理固有の対策

    • 処理に失敗したエンティティをスキップするを確認してください。

    • リソースパスに設定したエンティティが削除可能か確認してください。

 

DYNAMICSCRMカテゴリの制限事項

本オペレーションではMicrosoft Dynamics 365 for Customer Engagement Web APIを使用します。API仕様については以下のページを参照してください。

  • 「Dynamics 365 for Customer Engagement Web API の使用」

    (https://docs.microsoft.com/ja-jp/dynamics365/customer-engagement/developer/use-microsoft-dynamics-365-web-api)

 

本オペレーションではAzure Active Directoryを認証に使用します。Azure Active Directoryの構成については以下のページを参照してください。

  • 「Azure Active Directory 開発者ガイド」

    (http://go.microsoft.com/fwlink/?LinkId=290817)

  • 「OAuth 2.0 と Azure Active Directory を使用した Web アプリケーションへのアクセスの承認」

    (https://msdn.microsoft.com/en-us/library/azure/dn645542.aspx)

 

全処理共通

[接続先]のサービスのルートURLの設定方法について

Dynamics 365 for Customer Engagementの「設定」-「カスタマイズ」-「開発者リソース」にある「サービスのルートURL」を入力してください。

= 補足 =

URLは「https://<ホスト名>/api/data/<APIのバージョン>/」の形式です。

[認証]のコネクションリソースの設定方法について

各オペレーション対象への権限があるセキュリティロールが適用されたユーザーが必要です。権限については以下のページを参照してください。

  • 「Customer Engagement のセキュリティ モデル」

    (https://docs.microsoft.com/ja-jp/dynamics365/customer-engagement/developer/security-dev/security-model)

コネクションリソースの追加パラメータに以下の指定が必要です。

[追加パラメータ/キー]

[追加パラメータ/値]

備考

resource

<接続先に設定したサービスのルートURLのうち、スキームとホスト名部分>

  • パラメータ値は「https://<ホスト名>」の形式です。

  • 「/api/data/<APIのバージョン>/」部分は不要です。

[リソースパス]について

[リソースパス]については、以下のページを参照してください。

  • 「OData Version 4.0. Part 2: URL Conventions Plus Errata 03」

    (http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html)

仕様制限

ありません。

注意事項

  • Dynamics 365 for Customer Engagementと本コネクターとの通信は、HTTPSを使用します。

  • Dynamics 365 for Customer Engagementの仕様変更により、予告なく仕様は変更されることがあります。

  • Azure Active Directoryの認証ではリフレッシュトークンに有効期限があります。 トークンが更新できない場合、指定した[認証]のコネクションリソースで再度トークンを発行する必要があります。

エンティティ読み込み処理

[フィールド定義]について

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

表示されません

[フィルター]に設定するクエリについて

フィルターに設定するクエリについては、以下のページを参照してください。

  • 「Web API を使用したクエリ データ」

    (https://msdn.microsoft.com/library/gg334767.aspx#bkmk_filter)

注意事項

  • エンティティセット名一覧を更新で取得した一部エンティティセットは、読み取りに対応していない場合があります。

  • フィールド定義を更新で取得した一部フィールドは、読み取りに対応していない場合があります。

エンティティ書き込み処理

仕様制限

  • 以下の条件をすべて満たす場合、エンティティを関連付ける操作でエラーが発生します。

    • キーが指定された場合の処理方式に、作成または更新または作成のみが選択されている

    • 関連先キー設定関連先キーフィールドに、代替キーで定義されているフィールドが選択されている

    • 関連先キー設定関連先キーフィールドで選択したフィールドに、以下の文字を含む値がマッピングされている

      文字

      :

      *

      &

      +

  • エンティティ関係がN:1のエンティティフィールドに関連付ける操作を行う場合、以下の条件を満たすとリソースパスで設定したエンティティの作成および更新に失敗します。

    • キーが指定された場合の処理方式の設定値が更新のみ

    • 関連先エンティティセットに設定値がキーであるエンティティが存在しない

注意事項

  • リソースパスにキーを指定しても無視されます。

  • エンティティセット名一覧を更新で取得した一部エンティティセットは、書き込みに対応していない場合があります。

  • フィールド定義を更新で取得した一部フィールドは、書き込みに対応していない場合があります。

  • 以下の条件をすべて満たす場合、関連先のエンティティは作成されません。

    • 関連先のエンティティセットがsystemusersまたはteams

    • 関連先のエンティティセットに、設定されたowneridのエンティティが存在しない

    • キーが指定された場合の処理方式の設定値が作成または更新または作成のみ

  • 代替キーを使用して更新操作またはエンティティを関連付ける操作を行う際に、以下の文字はキーとするフィールドに使用できない場合があります。

    文字

    更新操作

    エンティティを関連付ける操作

    :

    ×

    ?

    ×

    ×

    '

    ×

    ×

    *

    ×

    /

    ×

    ×

    ¥

    ×

    ×

    &

    ×

    #

    ×

    %

    ×

    ×

    +

    ×

    <

    ×

    >

    ×

    :

    使用できます。

    ×

    :

    使用できません。

エンティティ削除処理

  • リソースパスにキーを指定しても無視されます。

  • エンティティセット名一覧を更新で取得した一部エンティティセットは、削除に対応していない場合があります。