Schema

Entity Schema

Entity schema shows contents of entity used in Read Entity operation and Write Entity operation. 

<?xml version="1.0" encoding="UTF-8"?>
<entitySet>
  <entity>
    <Property name null="true" empty="true">Property value</Property name>
    <Property name null="true">
      <Property name null="true" empty="true">Property value</Property name>
        :
    </Property name>
    <Property name>
      <element null="true" empty="true">
        <Property name null="true" empty="true">Property value</Property name>
          :
      </element>
        :
    </Property name>
      :
  </entity>
</entitySet>
In this adapter, schema type (element in entity element) varies depending on entity type of entity set.

Primitive (String, boolean, byte, short, int, long, float, double, BigDecimal, Date) Type (Structural Property)

<Property name null="true" empty="true">Property value</Property name>
Element nameAttribute nameDescriptionRemarks
Property name - Shows property value of Primitive type.  
- null Shows whether property value is null or not.
  • true:
    Property value is null.
  • Property value is deleted when true is specified in Write Entity operation.
  • null attribute is prior to property value.
  • null attribute is prior to empty attribute.
- empty Shows whether property value is empty character or not.
  • true:
    Property value is empty character.
  • Uses in the case of string type only.
  • Property value is updated as empty string when true is specified in Write Entity operation, .
  • empty attribute is prior to property value.
  • Property value is not updated when property value is empty in Write Entity operation.
You need to input the value of Dynamics 365 for Customer Engagement image type as Base64 format.

Enum Type (Structural Property)

<Property name null="true">Property value</Property name>
Element nameAttribute nameDescriptionRemarks
Property name - Shows property value of Enum type.  
- null Shows whether property value is null or not.
  • true:
    Property value is null.
  • Property value is deleted when true is specified in Write Entity operation.
  • null attribute is prior to property value.

Complex Type(Structural Property)

<Property name null="true">
  <Sub property name null="true" empty="true">Property value<Sub property name>
    :
</Property name>
Element nameAttribute nameDescriptionRemarks
Property name - Shows property value of Complex type.  
- null Shows whether property value is null or not.
  • true:
    Property value is null.
  • Property value is deleted when true is specified in Write Entity operation.
  • null attribute is prior to property value.
Sub property name - Shows property value which Complex type property has.
  • When this property is Complex type, child elements are structured recursively.

Entity Type (Navigation Property)

<Property name null="true">
  <Sub property name null="true" empty="true">Property value<Sub property name>
    :
</Property name>
Element nameAttribute nameDescriptionRemarks
Property name - Shows property value of Entity type.
  • Displays only one hierarchy of Navigation property owned by the entity in [Resource path] Does not show Navigation property owned by the related entity.
- null Shows whether property value is null or not.
  • true:
    Property value is null.
  • Relation is deleted when true is specified in Write Entity operation.
  • null attribute is prior to property value.
Sub property name - Shows property value which Entity type property has.
  • When this property is Complex type, child elements are structured recursively.

Entity Type (ownerid)

<ownerid type="systemuser|team">
  <ownerid null="true" empty="true">Property value</ownerid>
</ownerid>
Element nameAttribute nameDescriptionRemarks
ownerid - Dedicated property of ownerid.
  • This property is displayed when ownerid is selected in the field of write target in Write entity.
- type Set the mount type of ownerid.
  • systemuser:
    Set it when the mount type of ownerid is systemuser.
  • team:
    Set it when the mount type of ownerid is team.
  • When a value other than systemuser or team is set, an error occurs at runtime.
ownerid - Shows the property value of ownerid.
  • Shows the primary key of ownerid.

Structural Property Collection

<Property name>
  <element null="true" empty="true">...</element>
</Property name>
Element nameAttribute nameDescriptionRemarks
Property name - Shows property value of collection.
  • In Write Entity operation, you cannot modify elements partially. Overwritten by the whole new collection values.
element - Shows value.
  • It has value directly under element element in the case of Primitive type or Enum type.
  • It has Sub property name element directly under element element in the case of Complex type.
- null Shows whether property value is null or not.
  • true:
    Property value is null.
  • Value of Structural property collection is deleted when true is specified in Write Entity operation.
  • null attribute is prior to property value.
  • null attribute is prior to empty attribute.
- empty Shows whether property value is empty character or not.
  • true:
    Property value is empty character.
  • Uses in the case of string type only.
  • Property value is updated as empty string when true is specified in Write Entity operation.
  • empty attribute is prior to property value.
  • In Write Entity operation, when property value is empty, the value is dealt as null.

Navigation Property Collection

<Property name>
  <element null="true" empty="true">
    <Sub property name>Sub property value</Sub property name>
  </element>
</Property name>
Element nameAttribute nameDescriptionRemarks
Property name - Shows property value of collection.
  • In Write Entity operation, relations cannot be removed at once.
element - Shows entity.
  • It has Sub property name element directly under element element.
  • In order to specify entity uniquely, it has sub property which is a key as child element.
  • When sub property which is a key is not included in Write Entity operation, entity is created newly and related.
  • When sub property which is a key is included in Write Entity operation, related entity is updated.
- null Shows whether property value is null or not.
  • true:
    Property value is null.
  • When sub property which is a key is included and true is specified in Write Entity operation, relationship is removed.
  • null attribute is prior to property value.
Sub property name - Shows property value which Entity type property has.
  • When this property is Complex type, child elements are structured recursively.