Schemas

Entity schema

Entity schema shows contents of entity used in the Read Entity operation and the 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 connector, 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 name	Attribute name	Description	Remarks
Property name	-	Represents a property value of Primitive type.
-	null	Represents whether the property value is null or not. true The property value is null.	The property value is deleted when true is specified in the Write Entity operation. The null attribute is given priority over the property value. The null attribute is given priority over the empty attribute.
-	empty	Represents whether the property value is an empty character or not. true The property value is an empty character.	This is used only for string type. The property value is updated as an empty string when true is specified in the Write Entity operation. The empty attribute is given priority over the property value. The property value isn't updated when the property value is empty in the Write Entity operation.

Element name

Attribute name

Description

Remarks

Property name

Represents a property value of Primitive type.

null

Represents whether the property value is null or not.

true: The property value is null.

The property value is deleted when true is specified in the Write Entity operation.
The null attribute is given priority over the property value.
The null attribute is given priority over the empty attribute.

empty

Represents whether the property value is an empty character or not.

true: The property value is an empty character.

This is used only for string type.
The property value is updated as an empty string when true is specified in the Write Entity operation.
The empty attribute is given priority over the property value.
The property value isn't updated when the property value is empty in the Write Entity operation.

Note

The image type values of Dynamics 365 for Customer Engagement are input and output in Base64 format.

Enum type (Structural property)

<Property name null="true">Property value</Property name>

Element name	Attribute name	Description	Remarks
Property name	-	Represents a property value of Enum type.
-	null	Represents whether the property value is null or not. true The property value is null.	The property value is deleted when true is specified in the Write Entity operation. The null attribute is given priority over the property value.

Element name

Attribute name

Description

Remarks

Property name

Represents a property value of Enum type.

null

Represents whether the property value is null or not.

true: The property value is null.

The property value is deleted when true is specified in the Write Entity operation.
The null attribute is given priority over the 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 name	Attribute name	Description	Remarks
Property name	-	Represents a property value of Complex type.
-	null	Represents whether the property value is null or not. true The property value is null.	The property value is deleted when true is specified in the Write Entity operation. The null attribute is given priority over the property value.
Sub property name	-	Represents a property value which Complex type property has.	When this property is Complex type, child elements are structured recursively.

Element name

Attribute name

Description

Remarks

Property name

Represents a property value of Complex type.

null

Represents whether the property value is null or not.

true: The property value is null.

The property value is deleted when true is specified in the Write Entity operation.
The null attribute is given priority over the property value.

Sub property name

Represents a 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 name	Attribute name	Description	Remarks
Property name	-	Represents a property value of Entity type.	Note Displays only one hierarchy of Navigation property owned by the entity in Resource path. Doesn't display Navigation property owned by the related entity.
-	null	Represents whether the property value is null or not. true The property value is null.	Relation is deleted when true is specified in the Write Entity operation. The null attribute is given priority over the property value.
Sub property name	-	Represents a property value which Entity type property has.	When this property is Complex type, child elements are structured recursively.

Element name

Attribute name

Description

Remarks

Property name

Represents a property value of Entity type.

Note

Displays only one hierarchy of Navigation property owned by the entity in Resource path. Doesn't display Navigation property owned by the related entity.

null

Represents whether the property value is null or not.

true: The property value is null.

Relation is deleted when true is specified in the Write Entity operation.
The null attribute is given priority over the property value.

Sub property name

Represents a 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 name	Attribute name	Description	Remarks
ownerid	-	A dedicated property of ownerid.	Note This property is displayed when ownerid is selected in the field of write target in the Write Entity operation.
-	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.	Note When a value other than systemuser or team is set, an error occurs at runtime.
ownerid	-	Represents the property value of ownerid.	Represents the primary key of ownerid.

Element name

Attribute name

Description

Remarks

ownerid

A dedicated property of ownerid.

Note

This property is displayed when ownerid is selected in the field of write target in the Write Entity operation.

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.

Note

When a value other than systemuser or team is set, an error occurs at runtime.

ownerid

Represents the property value of ownerid.

Represents the primary key of ownerid.

Structural property collection

<Property name>
  <element null="true" empty="true">...</element>
</Property name>

Element name	Attribute name	Description	Remarks
Property name	-	Represents a property value of collection.	Note In the Write Entity operation, you can't modify elements partially. All elements are overwritten with the new collection values.
element	-	Represents a value.	It has a value directly under the element element in the case of Primitive type or Enum type. It has the Sub property name element directly under the element element in the case of Complex type.
-	null	Represents whether the property value is null or not. true The property value is null.	The value of Structural property collection is deleted when true is specified in the Write Entity operation. The null attribute is given priority over the property value. The null attribute is given priority over the empty attribute.
-	empty	Represents whether the property value is an empty character or not. true The property value is an empty character.	This is used only for string type. The property value is updated as an empty string when true is specified in the Write Entity operation. The empty attribute is given priority over the property value. Note In the Write Entity operation, when the property value is empty, the value is handled 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 name	Attribute name	Description	Remarks
Property name	-	Represents a property value of collection.	Note In the Write Entity operation, relations can't be removed at once.
element	-	Represents an entity.	It has the Sub property name element directly under the element element. In order to identify entities uniquely, it has a sub property which is a key as a child element. When a sub property which is a key isn't included in the Write Entity operation, an entity is created newly and related. When a sub property which is a key is included in the Write Entity operation, the related entity is updated.
-	null	Represents whether the property value is null or not. true The property value is null.	When a sub property which is a key is included and true is specified in the Write Entity operation, relationship is removed. The null attribute is given priority over the property value.
Sub property name	-	Represents a property value which Entity type property has.	When this property is Complex type, child elements are structured recursively.