# SyncCollectionEntity object

This object contains the information about a collection of items that are synchronized.

While this object is named using "collection", it does not prescribe a certain structure to its contents. Most commonly, the structure is either a list or a tree, but other structures are possible.

CAUTION Any modification to this object can result in data loss, since the contents are used and maintained by the synchronization process.

# Properties

Name Type Description
id integer readonly. The unique identity of this collection.
systemId integer readonly. The identity of the owning system.
system SyncSystemEntity readonly. A navigation property for the owning system.
nativeId string editable. The native identity of this collection.
deltaInfo string editable. The information required for reading delta changes from this collection.
itemCount integer editable. The total number of items within this collection.
activeCount integer editable. The number of items that were active, meaning, processed during the previous synchronization.
isRoot boolean readonly. Determines if this collection is a root collection. If true, then this collection does not have a parent collection.
providerId string readonly. The identity of the item that has provided this collection. Always empty, if this collection is a root collection.
provider SyncItemEntity readonly. A navigation property for the item that provided this collection.
items array SyncItemEntity readonly. A navigation property for the items that are contained in this collection.

# Operations

Non-exhaustive list of operations that are related to this type:

Zuletzt aktualisiert: 7. Februar 2025 um 08:35