organizationdatasyncsubscription table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Added by: OrganizationDataSyncSolution Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/organizationdatasyncsubscriptions
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/organizationdatasyncsubscriptions(organizationdatasyncsubscriptionid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
Retrieve GET [org URI]/api/data/v9.0/organizationdatasyncsubscriptions(organizationdatasyncsubscriptionid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/organizationdatasyncsubscriptions
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/organizationdatasyncsubscriptions(organizationdatasyncsubscriptionid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/organizationdatasyncsubscriptions(organizationdatasyncsubscriptionid)
See Update
UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName organizationdatasyncsubscriptions
DisplayCollectionName OrganizationDataSyncSubscriptions
DisplayName OrganizationDataSyncSubscription
EntitySetName organizationdatasyncsubscriptions
IsBPFEntity False
LogicalCollectionName organizationdatasyncsubscriptions
LogicalName organizationdatasyncsubscription
OwnershipType OrganizationOwned
PrimaryIdAttribute organizationdatasyncsubscriptionid
PrimaryNameAttribute name
SchemaName organizationdatasyncsubscription

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AadApplicationId

Property Value
Description
DisplayName AadApplicationId
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName aadapplicationid
MaxLength 150
RequiredLevel ApplicationRequired
Type String

BlobPartitionBy

Property Value
Description
DisplayName BlobPartitionBy
IsValidForForm True
IsValidForRead True
LogicalName blobpartitionby
RequiredLevel ApplicationRequired
Type Picklist

BlobPartitionBy Choices/Options

Value Label Description
0 None
1 Day
2 Month
3 Year

CanSyncAllMetadata

Property Value
Description
DisplayName CanSyncAllMetadata
IsValidForForm True
IsValidForRead True
LogicalName cansyncallmetadata
RequiredLevel ApplicationRequired
Type Boolean

CanSyncAllMetadata Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: False

DataEndpointPostingType

Property Value
Description
DisplayName DataEndpointPostingType
IsValidForForm True
IsValidForRead True
LogicalName dataendpointpostingtype
RequiredLevel None
Type Picklist

DataEndpointPostingType Choices/Options

Value Label Description
0 DefaultEndpoint
1 ServiceBusTopic
2 HTTPS
3 ServiceBusEventHub

DataProcessingType

Property Value
Description
DisplayName DataProcessingType
IsValidForForm True
IsValidForRead True
LogicalName dataprocessingtype
RequiredLevel None
Type Picklist

DataProcessingType Choices/Options

Value Label Description
0 Unknown
1 Streaming
2 Batch
3 Mixed
4 NotificationOnly

EndpointSettings

Property Value
Description
DisplayName EndpointSettings
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName endpointsettings
MaxLength 5000
RequiredLevel None
Type Memo

EntityFilters

Property Value
Description
DisplayName EntityFilters
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName entityfilters
MaxLength 10000
RequiredLevel None
Type Memo

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsOutOfBoxSubscription

Property Value
Description
DisplayName IsOutOfBoxSubscription
IsValidForForm True
IsValidForRead True
LogicalName isoutofboxsubscription
RequiredLevel ApplicationRequired
Type Boolean

IsOutOfBoxSubscription Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: False

name

Property Value
Description The name of the custom entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

NeedCopyAttachmentsToBlob

Property Value
Description
DisplayName NeedCopyAttachmentsToBlob
IsValidForForm True
IsValidForRead True
LogicalName needcopyattachmentstoblob
RequiredLevel ApplicationRequired
Type Boolean

NeedCopyAttachmentsToBlob Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: False

organizationdatasyncsubscriptionId

Property Value
Description Unique identifier for entity instances
DisplayName OrganizationDataSyncSubscription
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName organizationdatasyncsubscriptionid
RequiredLevel SystemRequired
Type Uniqueidentifier

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

PartnerPrefix

Property Value
Description
DisplayName PartnerPrefix
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName partnerprefix
MaxLength 50
RequiredLevel ApplicationRequired
Type String

statecode

Property Value
Description Status of the OrganizationDataSyncSubscription
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 3 Active
1 Inactive 0 Inactive

statuscode

Property Value
Description Reason for the status of the OrganizationDataSyncSubscription
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
3 Uninitialized 0
4 Activated 0
5 Deactivated 1

SubscriptionEndpointStatus

Property Value
Description
DisplayName SubscriptionEndpointStatus
Format None
IsValidForForm True
IsValidForRead True
LogicalName subscriptionendpointstatus
MaxValue 6
MinValue 0
RequiredLevel None
Type Integer

SubscriptionEntities

Property Value
Description
DisplayName subscriptionentities
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName subscriptionentities
MaxLength 5000
RequiredLevel None
Type Memo

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OrganizationId

Added by: Active Solution Solution

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Targets organization
Type Lookup

OrganizationIdName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version number of OrganizationDataSyncSubscription.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

organizationdatasyncsubscription_SyncErrors

Added by: System Solution Solution

Same as syncerror table organizationdatasyncsubscription_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

organizationdatasyncsubscription_DuplicateMatchingRecord

Added by: System Solution Solution

Same as duplicaterecord table organizationdatasyncsubscription_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

organizationdatasyncsubscription_DuplicateBaseRecord

Added by: System Solution Solution

Same as duplicaterecord table organizationdatasyncsubscription_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

organizationdatasyncsubscription_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation table organizationdatasyncsubscription_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

organizationdatasyncsubscription_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder table organizationdatasyncsubscription_MailboxTrackingFolders Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

organizationdatasyncsubscription_ProcessSession

Added by: System Solution Solution

Same as processsession table organizationdatasyncsubscription_ProcessSession Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

organizationdatasyncsubscription_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure table organizationdatasyncsubscription_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

organizationdatasyncsubscription_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as principalobjectattributeaccess table organizationdatasyncsubscription_PrincipalObjectAttributeAccesses Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName organizationdatasyncsubscription_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

subscription_subscriptionentity

Same as organizationdatasyncsubscriptionentity table subscription_subscriptionentity Many-To-One relationship.

Property Value
ReferencingEntity organizationdatasyncsubscriptionentity
ReferencingAttribute organizationdatasyncsubscriptioid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName subscription_subscriptionentity
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

lk_organizationdatasyncsubscription_createdby

Added by: System Solution Solution

See systemuser Table lk_organizationdatasyncsubscription_createdby One-To-Many relationship.

lk_organizationdatasyncsubscription_createdonbehalfby

Added by: System Solution Solution

See systemuser Table lk_organizationdatasyncsubscription_createdonbehalfby One-To-Many relationship.

lk_organizationdatasyncsubscription_modifiedby

Added by: System Solution Solution

See systemuser Table lk_organizationdatasyncsubscription_modifiedby One-To-Many relationship.

lk_organizationdatasyncsubscription_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Table lk_organizationdatasyncsubscription_modifiedonbehalfby One-To-Many relationship.

organization_organizationdatasyncsubscription

Added by: System Solution Solution

See organization Table organization_organizationdatasyncsubscription One-To-Many relationship.

See also

About the table reference
Web API Reference
organizationdatasyncsubscription EntityType