スキーマ

エンティティスキーマ

エンティティスキーマは、エンティティ読み取り処理、およびエンティティ書き込み処理で使われるエンティティの内容を表すスキーマです。 

<?xml version="1.0" encoding="UTF-8"?>
<entitySet>
  <entity>
    <プロパティ名 null="true" empty="true">プロパティ値</プロパティ名>
    <プロパティ名 null="true">
      <プロパティ名 null="true" empty="true">プロパティ値</プロパティ名>
        ：
    </プロパティ名>
    <プロパティ名>
      <element null="true" empty="true">
        <プロパティ名 null="true" empty="true">プロパティ値</プロパティ名>
          ：
      </element>
        :
    </プロパティ名>
      :
  </entity>
</entitySet>
本アダプタでは、エンティティセットのエンティティの型によりスキーマの型(entity要素内の要素)が異なります。

Primitive (String, boolean, byte, short, int, long, float, double, BigDecimal, Date)型(Structuralプロパティ)

<プロパティ名 null="true" empty="true">プロパティ値</プロパティ名>
要素名属性名説明備考
プロパティ名 - Primitive型のプロパティ値を表します。  
- null プロパティ値がnullかどうかを表します。
  • true:
    プロパティ値はnullです。
  • エンティティ書き込み処理でtrueを指定した場合、プロパティ値を削除します。
  • プロパティ値よりもnull属性が優先されます。
  • empty属性よりもnull属性が優先されます。
- empty プロパティ値が空文字かどうかを表します。
  • true:
    プロパティ値が空文字です。
  • 文字列型の場合のみ利用します。
  • エンティティ書き込み処理でtrueを指定した場合、プロパティ値を空文字として更新します。
  • プロパティ値よりもempty属性が優先されます。
  • エンティティ書き込み処理でプロパティ値が空の場合、プロパティ値は更新されません。
Dynamics 365またはDynamics CRMのイメージ型の値は、Base64形式で入出力します。

Enum型(Structuralプロパティ)

<プロパティ名 null="true">プロパティ値</プロパティ名>
要素名属性名説明備考
プロパティ名 - Enum型のプロパティ値を表します。  
- null プロパティ値がnullかどうかを表します。
  • true:
    プロパティ値はnullです。
  • エンティティ書き込み処理でtrueを指定した場合、プロパティ値を削除します。
  • プロパティ値よりもnull属性が優先されます。

Complex型(Structuralプロパティ)

<プロパティ名 null="true">
  <サブプロパティ名 null="true" empty="true">プロパティ値</サブプロパティ名>
    ：
</プロパティ名>
要素名属性名説明備考
プロパティ名 - Complex型のプロパティ値を表します。  
- null プロパティ値がnullかどうかを表します。
  • true:
    プロパティ値はnullです。
  • エンティティ書き込み処理でtrueを指定した場合、プロパティ値を削除します。
  • プロパティ値よりもnull属性が優先されます。
サブプロパティ名 - Complex型プロパティの持つプロパティ値を表します。
  • このプロパティがComplex型の場合、再帰的に子要素を構成します。

Entity型(Navigationプロパティ)

<プロパティ名 null="true">
  <サブプロパティ名 null="true" empty="true">プロパティ値</サブプロパティ名>
    ：
</プロパティ名>
要素名属性名説明備考
プロパティ名 - Entity型のプロパティ値を表します。
  • [リソースパス]が表すエンティティが持つNavigationプロパティの一階層のみ表示します。関連先のエンティティが持つNavigationプロパティは表示しません。
- null プロパティ値がnullかどうかを表します。
  • true:
    プロパティ値はnullです。
  • エンティティ書き込み処理でtrueを指定した場合、関連付けを削除します。
  • プロパティ値よりもnull属性が優先されます。
サブプロパティ名 - Entity型プロパティの持つプロパティ値を表します。
  • このプロパティがComplex型の場合、再帰的に子要素を構成します。

Entity型(ownerid)

<ownerid type="systemuser|team">
  <ownerid null="true" empty="true">プロパティ値</ownerid>
</ownerid>
要素名属性名説明備考
ownerid - ownerid専用プロパティです。
  • 本プロパティはエンティティ書き込み処理で書き込み対象のフィールドにowneridを選択した場合に表示されます。
- type owneridの実装型を設定します。
  • systemuser:
    owneridの実装型がsystemuserの場合に設定します。
  • team:
    owneridの実装型がteamの場合に設定します。
  • systemuserまたはteam以外の値を設定した場合、実行時にエラーが発生します。
ownerid - owneridの持つプロパティ値を表します。
  • owneridの主キーを表します。

Structuralプロパティのコレクション

<プロパティ名>
  <element null="true" empty="true">...</element>
</プロパティ名>
要素名属性名説明備考
プロパティ名 - コレクションのプロパティ値を表します。
  • エンティティ書き込み処理で、一部の要素だけを変更することはできません。新しいコレクションの値ですべて上書きされます。
element - 値を表します。
  • Primitive型またはEnum型の場合、element要素の直下に値を持ちます。
  • Complex型の場合、element要素の直下にサブプロパティ名要素を持ちます。
- null プロパティ値がnullかどうかを表します。
  • true:
    プロパティ値はnullです。
  • エンティティ書き込み処理でtrueを指定した場合、Structuralプロパティコレクションの値を削除します。
  • プロパティ値よりもnull属性が優先されます。
  • empty属性よりもnull属性が優先されます。
- empty プロパティ値が空文字かどうかを表します。
  • true:
    プロパティ値が空文字です。
  • 文字列型の場合のみ利用します。
  • エンティティ書き込み処理でtrueを指定した場合、プロパティ値を空文字として更新します。
  • プロパティ値よりもempty属性が優先されます。
  • エンティティ書き込み処理でプロパティ値が空の場合、nullとして扱われます。

Navigationプロパティのコレクション

<プロパティ名>
  <element null="true" empty="true">
    <サブプロパティ名>サブプロパティ値</サブプロパティ名>
  </element>
</プロパティ名>
要素名属性名説明備考
プロパティ名 - コレクションのプロパティ値を表します。
  • エンティティ書き込み処理で、関連を一括で解除することはできません。
element - エンティティを表します。
  • element要素の直下にサブプロパティ名要素を持ちます。
  • エンティティを一意に特定するために、キーとなるサブプロパティを子要素として持ちます。
  • エンティティ書き込み処理でキーとなるサブプロパティが含まない場合、エンティティを新規作成し関連付けします。
  • エンティティ書き込み処理でキーとなるサブプロパティが含まれる場合、関連先のエンティティを更新します。
- null プロパティ値がnullかどうかを表します。
  • true:
    プロパティ値はnullです。
  • エンティティ書き込み処理でキーとなるサブプロパティが含まれておりtrueを指定した場合、関連を解除します。
  • プロパティ値よりもnull属性が優先されます。
サブプロパティ名 - Entity型プロパティの持つプロパティ値を表します。
  • このプロパティがComplex型の場合、再帰的に子要素を構成します。